From b503ffe39294cdbec04381606d8ddf26dd5fcff1 Mon Sep 17 00:00:00 2001 From: Brenden Harrell Date: Mon, 7 Jun 2021 07:26:21 -0500 Subject: [PATCH] Rough Docs for Messari API Map and Mine --- ...pi-map-and-mine-002-coingecko-api-map.json | 12 +- ...and-mine-001-messari-api-map-and-mine.json | 21 + ...-api-map-and-mine-002-messari-api-map.json | 410 ++++++++++++++++++ ...api-map-and-mine-003-messari-api-mine.json | 131 ++++++ ...4-all-time-high-messari-api-indicator.json | 40 ++ 5 files changed, 610 insertions(+), 4 deletions(-) create mode 100644 Projects/Superalgos/Schemas/Docs-Topics/messari-api-map-and-mine-001-messari-api-map-and-mine.json create mode 100644 Projects/Superalgos/Schemas/Docs-Topics/messari-api-map-and-mine-002-messari-api-map.json create mode 100644 Projects/Superalgos/Schemas/Docs-Topics/messari-api-map-and-mine-003-messari-api-mine.json create mode 100644 Projects/Superalgos/Schemas/Docs-Topics/messari-api-map-and-mine-004-all-time-high-messari-api-indicator.json diff --git a/Projects/Superalgos/Schemas/Docs-Topics/coingecko-api-map-and-mine-002-coingecko-api-map.json b/Projects/Superalgos/Schemas/Docs-Topics/coingecko-api-map-and-mine-002-coingecko-api-map.json index efc6f440d..606cf49be 100644 --- a/Projects/Superalgos/Schemas/Docs-Topics/coingecko-api-map-and-mine-002-coingecko-api-map.json +++ b/Projects/Superalgos/Schemas/Docs-Topics/coingecko-api-map-and-mine-002-coingecko-api-map.json @@ -35,10 +35,14 @@ "text": "/coins/{id}", "updated": 1622688221280 }, + { + "style": "Text", + "text": "Get high level information about current coin.", + "updated": 1623017321384 + }, { "style": "Subtitle", - "text": "Raw Returned Values", - "updated": 1622688289637 + "text": "Raw Returned Values" }, { "style": "List", @@ -70,8 +74,8 @@ }, { "style": "Note", - "text": "CoinGecko score is an aggregated score combining liquidity, community, and developer scores.", - "updated": 1622846885139 + "text": "CoinGecko score is an aggregated score combining liquidity, community, developer, and public interest scores.", + "updated": 1622688833507 }, { "style": "List", diff --git a/Projects/Superalgos/Schemas/Docs-Topics/messari-api-map-and-mine-001-messari-api-map-and-mine.json b/Projects/Superalgos/Schemas/Docs-Topics/messari-api-map-and-mine-001-messari-api-map-and-mine.json new file mode 100644 index 000000000..e752e5f91 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Topics/messari-api-map-and-mine-001-messari-api-map-and-mine.json @@ -0,0 +1,21 @@ +{ + "topic": "Messari API Map and Mine", + "pageNumber": 1, + "type": "Messari API Map and Mine", + "definition": { + "text": "This API Map and Data Mine tap into the Messari API to pull news and coin metrics about the current base asset.", + "updated": 1623016371114 + }, + "paragraphs": [ + { + "style": "List", + "text": "Maintainers: @luis_fernando_molina (Telegram), @harrellbm (Telegram, and Discord).", + "updated": 1623016338199 + }, + { + "style": "Success", + "text": "Additional collaborators are welcome!", + "updated": 1623015909039 + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/messari-api-map-and-mine-002-messari-api-map.json b/Projects/Superalgos/Schemas/Docs-Topics/messari-api-map-and-mine-002-messari-api-map.json new file mode 100644 index 000000000..49e10280a --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Topics/messari-api-map-and-mine-002-messari-api-map.json @@ -0,0 +1,410 @@ +{ + "topic": "Messari API Map and Mine", + "pageNumber": 2, + "type": "Messari API Map", + "definition": { + "text": "The current Messari API Map accesses the following endpoints of the Messari API.", + "updated": 1623016798805 + }, + "paragraphs": [ + { + "style": "Text", + "text": "Documentation for the Messari API can be found at the following link:", + "updated": 1623016832972 + }, + { + "style": "Link", + "text": "https://messari.io/api/docs->https://messari.io/api/docs", + "updated": 1623016891013 + }, + { + "style": "Text", + "text": "The base request URL is:", + "updated": 1623016916374 + }, + { + "style": "Javascript", + "text": "https://data.messari.io/api/v1/" + }, + { + "style": "Title", + "text": "Mapped Endpoints", + "updated": 1623017084118 + }, + { + "style": "Subtitle", + "text": "Get Asset Metrics", + "updated": 1623018060417 + }, + { + "style": "Javascript", + "text": "assets/{assetKey}/metrics" + }, + { + "style": "Text", + "text": "Get all available quantitative metrics for current asset.", + "updated": 1623017262818 + }, + { + "style": "Subtitle", + "text": "Raw Returned Values" + }, + { + "style": "List", + "text": "elapsed: Number of milliseconds taken to generate this response.", + "updated": 1623019719259 + }, + { + "style": "Text", + "text": "\t" + }, + { + "style": "List", + "text": "timestamp: Current timestamp (ISO 8601) on the server.", + "updated": 1623017513914 + }, + { + "style": "List", + "text": "id: identifier of current asset.", + "updated": 1623017679361 + }, + { + "style": "List", + "text": "symbol: The commonly accepted \"symbol\" for an asset.", + "updated": 1623017708291 + }, + { + "style": "List", + "text": "name: Name of asset.", + "updated": 1623017721425 + }, + { + "style": "List", + "text": "slug: Web URL friendly shorthand slug, alternative to ID.", + "updated": 1623017759520 + }, + { + "style": "List", + "text": "price_usd: Market price in USD.", + "updated": 1623019895224 + }, + { + "style": "List", + "text": "price_btc: Market price in BTC.", + "updated": 1623019925906 + }, + { + "style": "List", + "text": "volume_last_24_hours: 24h trading volume in USD.", + "updated": 1623019946052 + }, + { + "style": "List", + "text": "real_volume_last_24_hours: 24h \"real\" trading volume in USD, read more here: https://messari.io/article/messari-methodology.", + "updated": 1623019966494 + }, + { + "style": "List", + "text": "volume_last_24_hours_overstatement_multiple: 24h trading volume in USD.", + "updated": 1623019998323 + }, + { + "style": "List", + "text": "percent_change_usd_last_24_hours: 24h percent change of USD-denominated price. If the return value is 1.23, it means 1.23%.", + "updated": 1623020015637 + }, + { + "style": "List", + "text": "percent_change_btc_last_24_hours: 24h percent change of BTC-denominated price. If the return value is 1.23, it means 1.23%.", + "updated": 1623020029901 + }, + { + "style": "List", + "text": "ohlcv_last_1_hour: Last one hour candle for current asset.", + "updated": 1623020085197 + }, + { + "style": "List", + "text": "ohlcv_last_24_hour: Last 24h candle for current asset.", + "updated": 1623020119322 + }, + { + "style": "List", + "text": "supply-> y_2050: The expected supply on Jan 1 2050.", + "updated": 1623020285674 + }, + { + "style": "List", + "text": "supply-> y_2050_percent_issued: The percentage of the Y2050 supply which has already been issued.", + "updated": 1623020280999 + }, + { + "style": "List", + "text": "supply_yplus_10: The expected supply 10 years from now.", + "updated": 1623020326848 + }, + { + "style": "List", + "text": "supply-> y_plus10_issued_percent: Tthe percent of the Y+10 supply that's currently liquid on the market today.", + "updated": 1623020414095 + }, + { + "style": "List", + "text": "supply-> liquid: Liquid Supply refers to tokens that exist on-chain, and which are not known to be encumbered by any contracts (programmatic or legal). Data is sourced by the Messari research team where available.", + "updated": 1623020418907 + }, + { + "style": "List", + "text": "supply-> circulating: Circulating Supply refers to tokens that exist on-chain, and which are not known to be encumbered by any contracts (programmatic or legal).", + "updated": 1623020423068 + }, + { + "style": "List", + "text": "supply-> stock_to_flow: Stock to Flow is calculated by taking the Liquid Supply today and dividing by the projected 12month increase in Liquid Supply. This is essentially the inverse of Current Inflation. The value is null for assets with fixed or decreasing Liquid Supply.", + "updated": 1623020439797 + }, + { + "style": "List", + "text": "blockchain_stats_24_hours-> transaction_volume:", + "updated": 1623020585683 + }, + { + "style": "List", + "text": "blockchain_stats_24_hours-> nvt:", + "updated": 1623020593900 + }, + { + "style": "List", + "text": "blockchain_stats_24_hours-> sum_of_fees", + "updated": 1623020501350 + }, + { + "style": "List", + "text": "blockchain_stats_24_hours-> median_tx_value", + "updated": 1623020508371 + }, + { + "style": "List", + "text": "blockchain_stats_24_hours-> median_tx_fee", + "updated": 1623020514190 + }, + { + "style": "List", + "text": "blockchain_stats_24_hours-> count_of_active_addresses", + "updated": 1623020521523 + }, + { + "style": "List", + "text": "blockchain_stats_24_hours-> count_of_tx", + "updated": 1623020549536 + }, + { + "style": "List", + "text": "blockchain_stats_24_hours-> count_of_payments", + "updated": 1623020554548 + }, + { + "style": "List", + "text": "blockchain_stats_24_hours-> new_issuance", + "updated": 1623020559207 + }, + { + "style": "List", + "text": "blockchain_stats_24_hours-> average_difficulty", + "updated": 1623020564987 + }, + { + "style": "List", + "text": "blockchain_stats_24_hours-> kilobytes_added", + "updated": 1623020571504 + }, + { + "style": "List", + "text": "blockchain_stats_24_hours-> count_of_blocks_added", + "updated": 1623020541777 + }, + { + "style": "List", + "text": "blockchain_stats_24_hours-> supply_moved_off_chain", + "updated": 1623020536534 + }, + { + "style": "List", + "text": "all_time_high-> price: The highest hourly open of the asset in USD.", + "updated": 1623020724372 + }, + { + "style": "List", + "text": "all_time_high-> at: ISO8601 timestamp of the date which the asset reached its all time high.", + "updated": 1623020739786 + }, + { + "style": "List", + "text": "all_time_high-> days_since: Days since the asset's recorded all time high.", + "updated": 1623020755609 + }, + { + "style": "List", + "text": "all_time_high-> percent_down: Percent that the current asset is down from all time high.", + "updated": 1623020782349 + }, + { + "style": "List", + "text": "developer_activity-> stars", + "updated": 1623020816536 + }, + { + "style": "List", + "text": "developer_activity-> watchers", + "updated": 1623020824097 + }, + { + "style": "List", + "text": "developer_activity-> commits_last_3_months", + "updated": 1623020829515 + }, + { + "style": "List", + "text": "developer_activity-> commits_last_1_year", + "updated": 1623020835154 + }, + { + "style": "List", + "text": "developer_activity-> lines_added_last_3_months", + "updated": 1623020840405 + }, + { + "style": "List", + "text": "developer_activity-> lines_added_last_1_year", + "updated": 1623020846615 + }, + { + "style": "List", + "text": "developer_activity-> lines_deleted_last_3_months", + "updated": 1623020852373 + }, + { + "style": "List", + "text": "developer_activity-> lines_deleted_last_1_year", + "updated": 1623020858907 + }, + { + "style": "List", + "text": "roi_data-> percent_change_last_1_week", + "updated": 1623020948941 + }, + { + "style": "List", + "text": "roi_data-> percent_change_last_1_month", + "updated": 1623020954684 + }, + { + "style": "List", + "text": "roi_data-> percent_change_last_3_months", + "updated": 1623020959549 + }, + { + "style": "List", + "text": "roi_data-> percent_change_last_1_year", + "updated": 1623020966835 + }, + { + "style": "List", + "text": "asset_age_days\t" + }, + { + "style": "List", + "text": "vladimir_club_cost\t" + }, + { + "style": "List", + "text": "categories\t" + }, + { + "style": "List", + "text": "sector" + }, + { + "style": "Subtitle", + "text": "Get all News" + }, + { + "style": "Javascript", + "text": "news", + "updated": 1623017985081 + }, + { + "style": "Text", + "text": "Get the latest (paginated) news and analysis for all assets.", + "updated": 1623018013665 + }, + { + "style": "Subtitle", + "text": "Raw Returned Values" + }, + { + "style": "List", + "text": "timestamp: Current timestamp (ISO 8601) on the server.", + "updated": 1623019062328 + }, + { + "style": "List", + "text": "elapsed: Number of milliseconds taken to generate this response", + "updated": 1623019084220 + }, + { + "style": "List", + "text": "id: identifier for current article.", + "updated": 1623019168164 + }, + { + "style": "List", + "text": "title: Title of current article.", + "updated": 1623019183222 + }, + { + "style": "List", + "text": "content: Content of current article.", + "updated": 1623019201030 + }, + { + "style": "List", + "text": "references-> name: Name of cited material.", + "updated": 1623020299082 + }, + { + "style": "List", + "text": "references-> url: URL of cited material.", + "updated": 1623020303521 + }, + { + "style": "List", + "text": "reference_title: Shortened title of currrent article.", + "updated": 1623019361980 + }, + { + "style": "List", + "text": "published_at: Time current article was published.", + "updated": 1623019395108 + }, + { + "style": "List", + "text": "author-> name: Name of article's author.", + "updated": 1623020308899 + }, + { + "style": "List", + "text": "tags: Tags associated with current article. Such as \"BTC.\"", + "updated": 1623019588064 + }, + { + "style": "List", + "text": "url: URL to current article.", + "updated": 1623019678774 + }, + { + "style": "Text", + "text": "" + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/messari-api-map-and-mine-003-messari-api-mine.json b/Projects/Superalgos/Schemas/Docs-Topics/messari-api-map-and-mine-003-messari-api-mine.json new file mode 100644 index 000000000..1b63997fb --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Topics/messari-api-map-and-mine-003-messari-api-mine.json @@ -0,0 +1,131 @@ +{ + "topic": "Messari API Map and Mine", + "pageNumber": 3, + "type": "Messari API Mine", + "definition": { + "text": "This data mine processes data fetched from the Messsari API Map.", + "updated": 1623067039445 + }, + "paragraphs": [ + { + "style": "Title", + "text": "Bot Products" + }, + { + "style": "Subtitle", + "text": "Asset Metrics", + "updated": 1623067631138 + }, + { + "style": "Text", + "text": "Saves raw API data into Superalgos compatible Multi-Time-Frame-Daily and Multi-Time-Frame-Market files." + }, + { + "style": "Text", + "text": "Processed Values:", + "updated": 1623067652897 + }, + { + "style": "List", + "text": "needs listed" + }, + { + "style": "Subtitle", + "text": "News", + "updated": 1623067696301 + }, + { + "style": "Text", + "text": "Collects fetched news stories into a Single-File data type format." + }, + { + "style": "Text", + "text": "Processed Values:" + }, + { + "style": "List", + "text": "needs listed" + }, + { + "style": "Subtitle", + "text": "All-Time-High", + "updated": 1623067732191 + }, + { + "style": "Text", + "text": "Saves all time high data for the all time high indicator." + }, + { + "style": "Text", + "text": "Processed Values:" + }, + { + "style": "List", + "text": "needs listed" + }, + { + "style": "Subtitle", + "text": "Market Data" + }, + { + "style": "Text", + "text": "Saves a variety of market data for the current asset." + }, + { + "style": "Text", + "text": "Processed Values:" + }, + { + "style": "List", + "text": "needs listed" + }, + { + "style": "Subtitle", + "text": "Supply", + "updated": 1623068607880 + }, + { + "style": "Text", + "text": "Saves a variety of supply data for the current asset.", + "updated": 1623068637139 + }, + { + "style": "Text", + "text": "Processed Values:" + }, + { + "style": "List", + "text": "needs listed" + }, + { + "style": "Subtitle", + "text": "Blockchain Stats" + }, + { + "style": "Text", + "text": "Saves a variety of blockchain statistics data for the current asset.", + "updated": 1623068649438 + }, + { + "style": "Text", + "text": "Processed Values:" + }, + { + "style": "List", + "text": "needs listed" + }, + { + "style": "Title", + "text": "Indicators" + }, + { + "style": "List", + "text": "All Time High - Messari API Indicator", + "updated": 1623068679468 + }, + { + "style": "Title", + "text": "" + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/messari-api-map-and-mine-004-all-time-high-messari-api-indicator.json b/Projects/Superalgos/Schemas/Docs-Topics/messari-api-map-and-mine-004-all-time-high-messari-api-indicator.json new file mode 100644 index 000000000..141ad60b3 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Topics/messari-api-map-and-mine-004-all-time-high-messari-api-indicator.json @@ -0,0 +1,40 @@ +{ + "topic": "Messari API Map and Mine", + "pageNumber": 4, + "type": "All Time High - Messari API Indicator", + "definition": { + "text": "Displays and plots the all time high of the current asset.", + "updated": 1623067987267 + }, + "paragraphs": [ + { + "style": "Text", + "text": "Plotter panel holds the following values:", + "updated": 1623068006305 + }, + { + "style": "List", + "text": "Rate: The highest recorded price of the current asset.", + "updated": 1623068342701 + }, + { + "style": "List", + "text": "Date at: date the last all time high occured.", + "updated": 1623068385383 + }, + { + "style": "List", + "text": "Days Since: days since all time high.", + "updated": 1623068160790 + }, + { + "style": "List", + "text": "Percent Down: Pecentage down since all time high.", + "updated": 1623068139620 + }, + { + "style": "Text", + "text": "" + } + ] +} \ No newline at end of file