From c35727f919a7a6d827bff00cdb2eebfd125a0834 Mon Sep 17 00:00:00 2001 From: Brenden Harrell Date: Wed, 2 Jun 2021 22:22:26 -0500 Subject: [PATCH] Docs for CoinGecko Api Map and Mine --- .../Docs-Books/community-data-mines.json | 5 + ...d-mine-001-coingecko-api-map-and-mine.json | 21 ++++ ...ko-api-map-and-mine-002-coingecko-map.json | 102 ++++++++++++++++++ ...i-map-and-mine-003-coingecko-api-mine.json | 70 ++++++++++++ 4 files changed, 198 insertions(+) create mode 100644 Projects/Superalgos/Schemas/Docs-Topics/coingecko-api-map-and-mine-001-coingecko-api-map-and-mine.json create mode 100644 Projects/Superalgos/Schemas/Docs-Topics/coingecko-api-map-and-mine-002-coingecko-map.json create mode 100644 Projects/Superalgos/Schemas/Docs-Topics/coingecko-api-map-and-mine-003-coingecko-api-mine.json diff --git a/Projects/Superalgos/Schemas/Docs-Books/community-data-mines.json b/Projects/Superalgos/Schemas/Docs-Books/community-data-mines.json index e814e5630..637ccd09d 100644 --- a/Projects/Superalgos/Schemas/Docs-Books/community-data-mines.json +++ b/Projects/Superalgos/Schemas/Docs-Books/community-data-mines.json @@ -30,6 +30,11 @@ "text": "V->Superalgos->Topic->Zeus Data Mine->", "updated": 1611686424488 }, + { + "style": "Chapter", + "text": "VI->Superalgos->Topic->CoinGecko API Map and Mine->", + "updated": 1622690513016 + }, { "style": "Text", "text": "" diff --git a/Projects/Superalgos/Schemas/Docs-Topics/coingecko-api-map-and-mine-001-coingecko-api-map-and-mine.json b/Projects/Superalgos/Schemas/Docs-Topics/coingecko-api-map-and-mine-001-coingecko-api-map-and-mine.json new file mode 100644 index 000000000..9ef42e7e1 --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Topics/coingecko-api-map-and-mine-001-coingecko-api-map-and-mine.json @@ -0,0 +1,21 @@ +{ + "topic": "CoinGecko API Map and Mine", + "pageNumber": 1, + "type": "CoinGecko API Map and Mine", + "definition": { + "text": "This API Map and Data Mine taps into the CoinGecko API to pull statistics about the current assets being used from the CoinGecko API.", + "updated": 1622686884874 + }, + "paragraphs": [ + { + "style": "List", + "text": "Maintainer: @harrellbm (Telegram, and Discord).", + "updated": 1622686900513 + }, + { + "style": "Success", + "text": "Additional collaborators are welcome!", + "updated": 1622686914590 + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/coingecko-api-map-and-mine-002-coingecko-map.json b/Projects/Superalgos/Schemas/Docs-Topics/coingecko-api-map-and-mine-002-coingecko-map.json new file mode 100644 index 000000000..5e52b446c --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Topics/coingecko-api-map-and-mine-002-coingecko-map.json @@ -0,0 +1,102 @@ +{ + "topic": "CoinGecko API Map and Mine", + "pageNumber": 2, + "type": "CoinGecko API Map", + "definition": { + "text": "The current CoinGecko API Map accesses the following endpoints of the CoinGecko API.", + "updated": 1622686989766 + }, + "paragraphs": [ + { + "style": "Text", + "text": "Documentation for the CoinGecko API can be found at the following link:", + "updated": 1622687107891 + }, + { + "style": "Link", + "text": "www.coingecko.com/en/api->www.coingecko.com/en/api", + "updated": 1622687459394 + }, + { + "style": "Text", + "text": "The base request URL is:" + }, + { + "style": "Javascript", + "text": "https://api.coingecko.com/api/v3/" + }, + { + "style": "Title", + "text": "Mapped Endpoints", + "updated": 1622687143514 + }, + { + "style": "Json", + "text": "/coins/{id}", + "updated": 1622688221280 + }, + { + "style": "Subtitle", + "text": "Raw Returned Values", + "updated": 1622688289637 + }, + { + "style": "List", + "text": "id: name of returned coin (string).", + "updated": 1622688305150 + }, + { + "style": "List", + "text": "market_cap_rank: Current ranking of coin based on its overall share of the crypto market cap (number)." + }, + { + "style": "List", + "text": "sentiment_votes_up_percentage: Percentage of up votes for coin through CoinGecko platforms (number).", + "updated": 1622688575235 + }, + { + "style": "List", + "text": "sentiment_votes_down_percentage: Percentage of down votes for coin through CoinGecko platforms (number).", + "updated": 1622688586166 + }, + { + "style": "List", + "text": "block_time_in_minutes: Current time in minutes taken to mine the last block of coin (number).", + "updated": 1622688666930 + }, + { + "style": "List", + "text": "coingecko_score: Overall trust score given to coin by the CoinGecko platform (number)." + }, + { + "style": "Note", + "text": "CoinGecko score is an aggregated score combining liquidity, community, developer, and public interest scores.", + "updated": 1622688833507 + }, + { + "style": "List", + "text": "liquidity_score: Liquidity health score given by the CoinGecko platform (number).", + "updated": 1622688975074 + }, + { + "style": "List", + "text": "community_score: Community strength score given by the CoinGecko platform (number).", + "updated": 1622689004490 + }, + { + "style": "List", + "text": "developer_score: Developer strength score given by the CoinGecko platform (number).", + "updated": 1622689029728 + }, + { + "style": "List", + "text": "public_interest_score: Level of public interest score given by the CoinGecko platform (number).", + "updated": 1622689104410 + }, + { + "style": "List", + "text": "last_updated: Date content of current responce was last updated (string).", + "updated": 1622689075868 + } + ] +} \ No newline at end of file diff --git a/Projects/Superalgos/Schemas/Docs-Topics/coingecko-api-map-and-mine-003-coingecko-api-mine.json b/Projects/Superalgos/Schemas/Docs-Topics/coingecko-api-map-and-mine-003-coingecko-api-mine.json new file mode 100644 index 000000000..25ab1482e --- /dev/null +++ b/Projects/Superalgos/Schemas/Docs-Topics/coingecko-api-map-and-mine-003-coingecko-api-mine.json @@ -0,0 +1,70 @@ +{ + "topic": "CoinGecko API Map and Mine", + "pageNumber": 3, + "type": "CoinGecko API Mine", + "definition": { + "text": "This data mine processes data fetched from the CoinGecko API Map.", + "updated": 1622689326578 + }, + "paragraphs": [ + { + "style": "Note", + "text": "There are currently not plotters for this mine. This means that there are currently no visual representations of this data for the charts. However, all data is processed into Multi-Time-Frame-Daily and Multi-Time-Frame-Market data types making it ready to be used by other SA bots.", + "updated": 1622689830172 + }, + { + "style": "Title", + "text": "Processed Values", + "updated": 1622689893560 + }, + { + "style": "List", + "text": "id: name of returned coin (string)." + }, + { + "style": "List", + "text": "market_cap_rank: Current ranking of coin based on its overall share of the crypto market cap (number)." + }, + { + "style": "List", + "text": "sentiment_votes_up_percentage: Percentage of up votes for coin through CoinGecko platforms (number)." + }, + { + "style": "List", + "text": "sentiment_votes_down_percentage: Percentage of down votes for coin through CoinGecko platforms (number)." + }, + { + "style": "List", + "text": "block_time_in_minutes: Current time in minutes taken to mine the last block of coin (number)." + }, + { + "style": "List", + "text": "coingecko_score: Overall trust score given to coin by the CoinGecko platform (number)." + }, + { + "style": "Note", + "text": "CoinGecko score is an aggregated score combining liquidity, community, developer, and public interest scores.", + "updated": 1622689922164 + }, + { + "style": "List", + "text": "liquidity_score: Liquidity health score given by the CoinGecko platform (number)." + }, + { + "style": "List", + "text": "community_score: Community strength score given by the CoinGecko platform (number)." + }, + { + "style": "List", + "text": "developer_score: Developer strength score given by the CoinGecko platform (number)." + }, + { + "style": "List", + "text": "public_interest_score: Level of public interest score given by the CoinGecko platform (number)." + }, + { + "style": "Text", + "text": "" + } + ] +} \ No newline at end of file