coingecko.coin

stable Standard

Coin profile with live market data (price, market cap, supply, ATH).

GET /v1/coingecko/coin

What you get#

One Coingecko record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

What it costs#

Standard · 1 credit for a fresh fetch, charged only when it succeeds.
Free when served from cache (0.2 credit for a cached response over 100 KB).
Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

Name	Type	Required	Default	What it is	Constraints
`id`	string	yes	(required)	CoinGecko coin id, e.g. bitcoin	max 64 chars; must match `[a-z0-9][a-z0-9-]{0,63}`; trimmed, lowercased

Request#

curl "https://api.onekey.dev/v1/coingecko/coin?id=bitcoin" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Coingecko response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": {
    "entity": {
      "id": "bitcoin",
      "name": "Bitcoin",
      "description": "Bitcoin is the world's first decentralized cryptocurrency, created in 2009 by the pseudonymous Satoshi Nakamoto. It enables peer-to-peer electronic cash transactions without intermediaries like banks or governments, operating on a blockchain secured by Proof of Work mining and the SHA-256 cryptographic algorithm. With a fixed supply cap of 21 million coins and programmatic halvings every four ye",
      "url": "http://www.bitcoin.org",
      "createdAt": "2009-01-03T00:00:00Z",
      "category": "SHA-256",
      "date": "2026-09-28T19:55:40Z"
    },
    "market": {
      "symbol": "btc",
      "marketCapRank": 1,
      "price": 83355,
      "marketCap": 1674857697932,
      "volume24h": 42066518410,
      "change24hPct": -1.6252
    },
    "media": {
      "thumbnailUrl": "https://coin-images.coingecko.com/coins/images/1/large/bitcoin.png?1696501400"
    },
    "ext": {
      "circulatingSupply": 20090481,
      "totalSupply": 20090481,
      "ath": 126080
    }
  },
  "metadata": {
    "platform": "coingecko",
    "endpoint": "coin",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`id`	`entity.id`	-
`name`	`entity.name`	-
`symbol`	`market.symbol`	-
`description.en`	`entity.description`	`stripHtml`
`links.homepage.0`	`entity.url`	`safeUrl`
`image.large`	`media.thumbnailUrl`	`safeUrl`
`genesis_date`	`entity.createdAt`	`toIsoDate`
`hashing_algorithm`	`entity.category`	-
`market_cap_rank`	`market.marketCapRank`	`toNumber`
`market_data.current_price.usd`	`market.price`	`toNumber`
`market_data.market_cap.usd`	`market.marketCap`	`toNumber`
`market_data.total_volume.usd`	`market.volume24h`	`toNumber`
`market_data.price_change_percentage_24h`	`market.change24hPct`	`toNumber`
`market_data.circulating_supply`	`ext.circulatingSupply`	`toNumber`
`market_data.total_supply`	`ext.totalSupply`	`toNumber`
`market_data.ath.usd`	`ext.ath`	`toNumber`
`last_updated`	`entity.date`	`toIsoDate`

Caching and freshness#

Fresh for about 30 seconds. Repeat calls in that window are served from cache and are free.
Between 30 seconds and 5 minutes the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
If the source is down when a refresh is needed, the last copy can be served for up to 1 hour more (marked stale).
A "not found" is remembered for 1 minute and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	That record does not exist. Free; do not retry.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).