CoinGecko

Obtain price feed, market data, and historical data of crypto assets

Try it in the Widget Center

Click this url to try this widget and copy the Pro Config template.

Usage

Get the Coin ID

action coin_id

Input Parameters

Name	Type	Description	Default	Required
action	string	The action you want to perform	coin_id
name	string	The name of the coin. Required if you search coin by name.

Output Parameters

Name	Type	Description	File Type
data	object	The output of coingecko API.

Output Example

{
  "status": "SUCCESS",
  "created_at": "2024-04-25T02:58:32.161881",
  "started_at": "2024-04-25T02:58:36.511598",
  "result": {
    "data": {
      "id": "bitcoin",
      "symbol": "btc",
      "name": "Bitcoin"
    }
  },
  "finished_at": "2024-04-25T02:58:38.489827"
}

Get the Coin Data by ID

action coin_data_by_id

Input Parameters

Name	Type	Description	Default	Required
action	string	The action you want to perform	coin_data_by_id
id	string	The id of the coin.

Output Parameters

Name	Type	Description	File Type
data	object	The output of coingecko API.

Output Example

{
    "status": "SUCCESS",
    "created_at": "2024-04-25T03:12:37.276366",
    "started_at": "2024-04-25T03:12:39.650554",
    "result": {
      "data": {
        "id": "bitcoin",
        "symbol": "btc",
        "name": "Bitcoin",
        "web_slug": "bitcoin",
        "asset_platform_id": null,
        "*****"
      }
    },
    "finished_at": "2024-04-25T03:12:41.767455"
}

Get the Coin Ticker by ID

action coin_ticker_by_id

Input Parameters

Name	Type	Description	Default	Required
action	string	The action you want to perform	coin_ticker_by_id
id	string	The id of the coin.

Output Parameters

Name	Type	Description	File Type
data	object	The output of coingecko API.

Output Example

{
    "status": "SUCCESS",
    "created_at": "2024-04-25T03:21:00.040066",
    "started_at": "2024-04-25T03:21:03.711204",
    "result": {
      "data": {
        "name": "Bitcoin",
        "tickers": ["***"]
      }
    },
    "finished_at": "2024-04-25T03:21:06.378630"
}

Advanced

Input Parameters

Name	Type	Description	Default	Required
endpoint	string	The endpoint url of Coingecko, please add the path params in the endpoint	https://pro-api.coingecko.com/api/v3/coins/id
query_param	string	Dict type of query params

Detailed Guidelines

Note: You can test this feature in the widget center, but please be cautious not to output excessive information on the website. Some cryptocurrency data can be extensive and may cause your website to become unresponsive or crash.

• Main parameter of Coins:

  • task_type , you can use the coin_id to obtain the identifier of your chosen cryptocurrency. Then, utilize other functions named xx_by_id to fetch specific details about that cryptocurrency.

    • When using coin_id, you should provide the name of the coin as a parameter. For xx_by_id functions, you should supply the coin's ID as the parameter.

• Main parameter of Advanced

  • endpoint, refer to the CoinGecko API documentation and use the API interface as the endpoint. Be sure to include the path parameters in the endpoint.

  • For the query parameters, add them as a dictionary, following the format described in the CoinGecko API documentation

• Some examples