Demo to preview the plugin:

Introduction

Power your applications with CoinGecko’s independently sourced crypto data such as live prices, trading volume, exchange volumes, trading pairs, historical data, contract address data, crypto categories, crypto derivatives, images and more.

How to setup

CoinGecko provides a fundamental analysis of the crypto market. In addition to tracking price, volume and market capitalisation, CoinGecko tracks community growth, open-source code development, major events and on-chain metrics. This plugin does not require any API keys, you just need to install the plugin.

CoinGecko API Call

1. Get the current price of any cryptocurrencies in any other supported currencies that you need.

Image without caption
Parameters:
  • ids - id of coins, comma-separated if querying more than 1 coin refers to `coins/list`
  • vs_currencies - vs_currency of coins, comma-separated if querying more than 1 vs_currency refers to `simple/supported_vs_currencies`
  • include_market_cap - true/false to include market_cap, default: false
  • include_24hr_vol - true/false to include 24hr_vol, default: false
  • include_24hr_change - true/false to include 24hr_change, default: false
  • include_last_updated_at - true/false to include last_updated_at of price, default: false
Response:
Code (200): price(s) of cryptocurrency
Image without caption

2. Get current price of tokens (using contract addresses) for a given platform in any other currency that you need.

Image without caption
Parameters:
  • id - The id of the platform issuing tokens (See asset_platforms endpoint for list of options)
  • contract_addresses - The contract address of tokens, comma separated
  • vs_currencies - vs_currency of coins, comma-separated if querying more than 1 vs_currency refers to `simple/supported_vs_currencies`
  • include_market_cap - true/false to include market_cap, default: false
  • include_24hr_vol - true/false to include 24hr_vol, default: false
  • include_24hr_change - true/false to include 24hr_change, default: false
  • include_last_updated_at - true/false to include last_updated_at of price, default: false
Response:
Code (200): price(s) of cryptocurrency
Image without caption

3. Get list of supported_vs_currencies.

Image without caption
Parameters:
  • none
Response:
Code (200): list of supported_vs_currencies
Image without caption

4. List all supported coins id, name and symbol (no pagination required)

Use this to obtain all the coins' id in order to make API calls
Image without caption
Parameters:
  • include_platform - flag to include platform contract addresses (eg. 0x.... for Ethereum based tokens). valid values: true, false
Response:
Code (200): List all coins with id, name, and symbol
Image without caption

5. List all supported coins price, market cap, volume, and market related data

Use this to obtain all the coins market data (price, market cap, volume)
Image without caption
Parameters:
  • vs_currency - The target currency of market data (usd, eur, jpy, etc.)
  • ids - The ids of the coin, comma separated crytocurrency symbols (base). refers to `/coins/list`. When left empty, returns numbers the coins observing the params `limit` and `start`
  • category - filter by coin category. Refer to /coin/categories/list
  • order - valid values: market_cap_desc, gecko_desc, gecko_asc, market_cap_asc, market_cap_desc, volume_asc, volume_desc, id_asc, id_desc sort results by field.
  • per_page - valid values: 1..250 Total results per page
  • page - Page through results
  • sparkline - Include sparkline 7 days data (eg. true, false)
  • price_change_percentage - Include price change percentage in 1h, 24h, 7d, 14d, 30d, 200d, 1y (eg. '`1h,24h,7d`' comma-separated, invalid values will be discarded)
Response:
Code (200): List all coins with market data
Image without caption

6. List all supported coins price, market cap, volume, and market related data

Get current data (name, price, market, ... including exchange tickers) for a coin.
⚠️
IMPORTANT: Ticker object is limited to 100 items, to get more tickers, use `/coins/{id}/tickers` Ticker `is_stale` is true when ticker that has not been updated/unchanged from the exchange for a while. Ticker `is_anomaly` is true if ticker's price is outlined by our system.
You are responsible for managing how you want to display this information (e.g. footnote, different background, change opacity, hide)\n
Image without caption
Parameters:
  • id - pass the coin id (can be obtained from /coins) eg. bitcoin
  • localization - Include all localized languages in response (true/false) [default: true]
  • tickers - Include tickers data (true/false) [default: true]
  • market_data - Include market_data (true/false) [default: true]
  • community_data - Include community_data data (true/false) [default: true]
  • developer_data - Include developer_data data (true/false) [default: true]
  • sparkline - Include sparkline 7 days data (eg. true, false) [default: false]
Response:
Code (200): Get current data for a coin
Image without caption

7. Get coin tickers (paginated to 100 items)

Get coin tickers (paginated to 100 items)
⚠️
IMPORTANT: Ticker `is_stale` is true when the ticker has not been updated/unchanged from the exchange for a while. Ticker `is_anomaly` is true if ticker's price is outliered by our system. You are responsible for managing how you want to display these information (e.g. footnote, different background, change opacity, hide)
Image without caption
Parameters:
  • id - pass the coin id (can be obtained from /coins/list) eg. bitcoin
  • exchange_ids - filter results by exchange_ids (ref: v3/exchanges/list)
  • include_exchange_logo - flag to show exchange_logo
  • page - Page through results
  • order - valid values: trust_score_desc (default), trust_score_asc and volume_desc
  • depth - flag to show 2% orderbook depth. valid values: true, false
Response:
Code (200): Get coin tickers
Image without caption

8. Get historical data (name, price, market, stats) at a given date for a coin

Get historical data (name, price, market, stats) at a given date for a coin\n
Image without caption
Parameters:
  • id - pass the coin id (can be obtained from /coins) eg. bitcoin
  • date - The date of data snapshot in dd-mm-yyyy eg. 30-12-2017
  • localization - Set to false to exclude localized languages in response
Response:
Code (200): Get historical data at a given date for a coin
Image without caption

9. Get historical market data include price, market cap, and 24h volume (granularity auto)

Get historical market data include price, market cap, and 24h volume (granularity auto)
Minutely data will be used for the duration within 1 day, Hourly data will be used for duration between 1 day and 90 days, Daily data will be used for duration above 90 days.
Image without caption
Parameters:
  • id - pass the coin id (can be obtained from /coins) eg. bitcoin
  • vs_currency - The target currency of market data (usd, eur, jpy, etc.)
  • days - Data up to number of days ago (eg. 1,14,30,max)
  • interval - Data interval. Possible value: daily
Response:
Code (200): Get historical market data include price, market cap, and 24h volume
Image without caption

10. Get historical market data include price, market cap, and 24h volume within a range of timestamp (granularity auto)

Get historical market data include price, market cap, and 24h volume within a range of timestamp (granularity auto)
Data granularity is automatic (cannot be adjusted) 1 day from query time = 5 minute interval data 1 - 90 days from query time = hourly data above 90 days from query time = daily data (00:00 UTC)
Image without caption
Parameters:
  • id - pass the coin id (can be obtained from /coins) eg. bitcoin
  • vs_currency - The target currency of market data (usd, eur, jpy, etc.)
  • from - From date in UNIX Timestamp (eg. 1392577232)
  • to - To date in UNIX Timestamp (eg. 1422577232)
Response:
Code (200): Get historical market data include price, market cap, and 24h volume
Image without caption

11. Get coin info from contract address

Get coin info from contract address
Image without caption
Parameters:
  • id - Asset platform (See asset_platforms endpoint for list of options)
  • contract_address - Token's contract address
Response:
Code (200): Get current data for a coin
Image without caption

12. Get historical market data include price, market cap, and 24h volume (granularity auto) from a contract address

Get historical market data including price, market cap, and 24h volume (granularity auto)
Image without caption
Parameters:
  • id - The id of the platform issuing tokens (See asset_platforms endpoint for list of options)
  • contract_address - Token's contract address
  • vs_currency - The target currency of market data (usd, eur, jpy, etc.)
  • days - Data up to number of days ago (eg. 1,14,30,max)
Response:
Code (200): Get historical market data include price, market cap, and 24h volume

13. Get historical market data include price, market cap, and 24h volume within a range of timestamp (granularity auto) from a contract address

Get historical market data include price, market cap, and 24h volume within a range of timestamp (granularity auto)
Image without caption
Parameters:
  • id - The id of the platform issuing tokens (See asset_platforms endpoint for list of options)
  • contract_address - Token's contract address
  • vs_currency - The target currency of market data (usd, eur, jpy, etc.)
  • from - From date in UNIX Timestamp (eg. 1392577232)
  • to - To date in UNIX Timestamp (eg. 1422577232)
Response:
Code (200): Get historical market data include price, market cap, and 24h volume
Image without caption

14. Get coin's OHLC

Candle's body: 1 - 2 days: 30 minutes 3 - 30 days: 4 hours 31 and before: 4 days
Image without caption
Parameters:
  • id - pass the coin id (can be obtained from /coins/list) eg. bitcoin
  • vs_currency - The target currency of market data (usd, eur, jpy, etc.)
  • days - Data up to number of days ago (1/7/14/30/90/180/365/max)
Response:
Code (200) - successful operation\n\n[\n1594382400000 (time),\n1.1 (open),\n 2.2 (high),\n 3.3 (low),\n 4.4 (close)\n]
json
"schema": { "type": "array", "items": { "type": "number", "example": [ 1594382400000, 1.1, 2.2, 3.3, 4.4 ] } }
Image without caption

15. List all asset platforms (Blockchain networks)

List all asset platforms
Image without caption
Parameters:
  • none
Response:
Code (200): List all asset_platforms
Image without caption

16. List all categories

Image without caption
Parameters:
  • none
Response:
Code (200): List all categories
Image without caption

17. List all categories with market data

Image without caption
Parameters:
  • order - valid values:
  • market_cap_desc (default),
  • market_cap_asc,
  • name_desc, name_asc,
  • market_cap_change_24h_desc
  • and market_cap_change_24h_asc
Response:
Code (200): List all categories with market data
Image without caption

18. List all exchanges

Image without caption
Parameters:
  • per_page - Valid values: 1...250 Total results per page Default value:: 100
  • page - page through results
Response:
Code (200): List all exchanges
Image without caption

19. List all supported markets id and name (no pagination required)

Use this to obtain all the markets' id in order to make API calls
Image without caption
Parameters:
  • none
Response:
Code (200): List all coins with id and name
Image without caption

20. Get exchange volume in BTC and top 100 tickers only

Get exchange volume in BTC and tickers
⚠️
IMPORTANT: Ticker object is limited to 100 items, to get more tickers, use `/exchanges/{id}/tickers` Ticker `is_stale` is true when ticker that has not been updated/unchanged from the exchange for a while. Ticker `is_anomaly` is true if ticker's price is outliered by our system. You are responsible for managing how you want to display these information (e.g. footnote, different background, change opacity, hide).
Image without caption
Parameters:
  • id - pass the exchange id (can be obtained from /exchanges/list) eg. binance
Response:
Code (200): Get exchange volume in BTC and top 100 tickers
Image without caption

21. Get exchange tickers (paginated, 100 tickers per page)

Get exchange tickers (paginated)
⚠️
IMPORTANT: Ticker `is_stale` is true when ticker that has not been updated/unchanged from the exchange for a while. Ticker `is_anomaly` is true if ticker's price is outliered by our system. You are responsible for managing how you want to display this information (e.g. footnote, different background, change opacity, hide)
Image without caption
Parameters:
  • id - pass the exchange id (can be obtained from /exchanges/list) eg. binance
  • coin_ids - filter tickers by coin_ids (ref: v3/coins/list)
  • include_exchange_logo - flag to show exchange_logo
  • page - Page through results
  • depth - flag to show 2% orderbook depth i.e., cost_to_move_up_usd and cost_to_move_down_usd
  • order - valid values: trust_score_desc (default), trust_score_asc and volume_desc
Response:
Code (200): Get exchange tickers
Image without caption

22. List all market indexes

Image without caption
Parameters:
  • per_page - Total results per page
  • page - Page through results
Response:
Code (200): List all market indexes
Image without caption

23. get market index by market id and index id

Image without caption
Parameters:
  • market_id - pass the market id (can be obtained from /exchanges/list)
  • id - pass the index id (can be obtained from /indexes/list)
Response:
Code (200): get market index by market id and index id
Image without caption

24. list market indexes id and name

Image without caption
Parameters:
  • none
Response:
Code (200): list market indexes id and name
Image without caption

25. List all derivative tickers

Image without caption
Parameters:
  • include_tickers - ['all', 'unexpired'] - expired to show unexpired tickers, all to list all tickers, defaults to unexpired
Response:
Code (200): List all derivative tickers
Image without caption

26. List all derivative exchanges

Image without caption
Parameters:
  • order - order results using following params name_asc,name_desc,open_interest_btc_asc,open_interest_btc_desc,trade_volume_24h_btc_asc,trade_volume_24h_btc_desc
  • per_page - Total results per page
  • page - Page through results
Response:
Code (200): List all derivative exchanges
Image without caption

27. show derivative exchange data

Image without caption
Parameters:
  • id - pass the exchange id (can be obtained from derivatives/exchanges/list) eg. bitmex
  • include_tickers - ['all', 'unexpired'] - expired to show unexpired tickers, all to list all tickers, leave blank to omit tickers data in response
Response:
Code (200): show derivative exchange data
Image without caption

28. List all derivative exchanges name and identifier

Image without caption
Parameters:
  • none
Response:
Code (200): List all derivative exchanges name and identifier
Image without caption

29. Get volume_chart data for a given exchange

Image without caption
Parameters:
  • id - pass the exchange id (can be obtained from /exchanges/list) eg. binance
  • days - Data up to number of days ago (eg. 1,14,30)
Response:
Code (200): Get exchange volume_chart data
Image without caption

30. Get BTC-to-Currency exchange rates

Image without caption
Parameters:
  • none
Response:
Code (200): List rates
Image without caption

31. Search for coins, categories and markets on CoinGecko

Search for coins, categories and markets listed on CoinGecko ordered by largest Market Cap first
Image without caption
Parameters:
  • query - Search string
Response:
Code (200): List of coins, categories and markets matching search term ordered by market cap
json
"schema": { "type": "object", "properties":{ "coins": { "type": "array", "properties": { "item": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "symbol": { "type": "string" }, "market_cap_rank": { "type": "integer" } } } } }, "exchanges": { "type": "array", "properties": { "item": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "market_type": { "type": "string" } } } } }, "categories": { "type": "array", "properties": { "item": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }
Image without caption

32. Get trending search coins (Top-7) on CoinGecko in the last 24 hours

Top-7 trending coins on CoinGecko as searched by users in the last 24 hours (Ordered by most popular first)
Image without caption
Parameters:
  • none
Response:
Code (200): List trending coins by most popular first
Image without caption

33. Get cryptocurrency global data

Image without caption
Parameters:
  • none
Response:
Code (200): Get global data - total_volume, total_market_cap, ongoing icos etc
Image without caption

34. Get cryptocurrency global decentralized finance (defi) data

Get Top 100 Cryptocurrency Global Decentralized Finance(defi) data
Image without caption
Parameters:
  • none
Response:
  • defi_market_cap - Defi Market Capitalization in USD
  • eth_market_cap - Ethereum Market Capitalization in USD
  • defi_to_eth_ratio - defi_market_cap to eth_market_cap ratio
  • trading_volume_24h - defi trading volume in 24h in USD
  • defi_dominance - defi_market_cap to total_market_cap ratio
  • top_coin_name - defi coin with largest market_cap
  • top_coin_dominance - top defi coin market dominance
Image without caption

35. Get public companies data

Get public companies bitcoin or ethereum holdings (Ordered by total holdings descending)
Image without caption
Parameters:
  • coin_id - bitcoin or ethereum
Response:
Code (200): Get public companies bitcoin or ethereum holdings
Image without caption

Errors

The CoinGecko API uses the following error codes:

Changelogs

In changelogs will be logged all the updates for the given plugin. With the date of publishing the update by admin and plugin Version, things that were changed/fixed/improved

Helpful?
SHARE
content