# coingecko.markets

**beta** **Advanced**

Top coins by market cap with prices, volume and 24h change.

`GET /v1/coingecko/markets`

> [!NOTE] **Beta.** This endpoint has not yet been verified against the live source, so fields may be missing or differ until it becomes stable. Failed calls are refunded.

## What you get

A list of Coingecko results in Onekey's unified shape, in `data` (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free `404 not_found` instead.

## What it costs

- **Advanced · 5 credits** 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 |
| --- | --- | --- | --- | --- | --- |
| `vs_currency` | string | no | `usd` | Quote currency, e.g. usd | max 10 chars; must match `[a-z]{2,10}`; trimmed, lowercased |
| `per_page` | string | no | `20` | Rows per page (1-100) | max 3 chars; must match `[1-9]\d?\|100`; trimmed |
| `page` | string | no | `1` | Page number | max 3 chars; must match `[1-9]\d{0,2}`; trimmed |

## Request

```bash
curl "https://api.onekey.dev/v1/coingecko/markets?vs_currency=usd&per_page=10" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/coingecko/markets",
    params={"vs_currency": "usd", "per_page": "10"},
    headers={"x-api-key": "YOUR_API_KEY"},
)
body = res.json()

if body["success"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
```

```javascript
const params = new URLSearchParams({ vs_currency: "usd", per_page: "10" });
const res = await fetch(`https://api.onekey.dev/v1/coingecko/markets?${params}`, {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const body = await res.json();

if (body.success) console.log(body.data);
else console.error(body.error.code, body.error.message);
```

## 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",
        "date": "2026-09-28T19:57:20Z"
      },
      "market": {
        "symbol": "btc",
        "marketCapRank": 1,
        "price": 83362,
        "marketCap": 1674965820510,
        "volume24h": 42147062791,
        "change24hPct": -1.60201
      },
      "media": {
        "thumbnailUrl": "https://coin-images.coingecko.com/coins/images/1/large/bitcoin.png?1696501400"
      },
      "ext": {
        "high24h": 84945,
        "low24h": 82581,
        "circulatingSupply": 20090481,
        "ath": 126080
      }
    },
    {
      "entity": {
        "id": "ethereum",
        "name": "Ethereum",
        "date": "2026-09-28T19:57:20Z"
      },
      "market": {
        "symbol": "eth",
        "marketCapRank": 2,
        "price": 2673.84,
        "marketCap": 326435571921,
        "volume24h": 17115109088,
        "change24hPct": -0.66846
      },
      "media": {
        "thumbnailUrl": "https://coin-images.coingecko.com/coins/images/279/large/ethereum.png?1696501628"
      },
      "ext": {
        "high24h": 2717.37,
        "low24h": 2636.99,
        "circulatingSupply": 122087473.82588674,
        "ath": 4946.05
      }
    }
  ],
  "metadata": {
    "platform": "coingecko",
    "endpoint": "markets",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}
```

## Field mapping

How this endpoint's source fields become Onekey's [unified schema](https://onekey.dev/docs/schema.md). Fields the source lacks come back as `null`.

| Source path | Onekey field | Transform |
| --- | --- | --- |
| `id` | `entity.id` | - |
| `name` | `entity.name` | - |
| `symbol` | `market.symbol` | - |
| `image` | `media.thumbnailUrl` | `safeUrl` |
| `market_cap_rank` | `market.marketCapRank` | `toNumber` |
| `current_price` | `market.price` | `toNumber` |
| `market_cap` | `market.marketCap` | `toNumber` |
| `total_volume` | `market.volume24h` | `toNumber` |
| `high_24h` | `ext.high24h` | `toNumber` |
| `low_24h` | `ext.low24h` | `toNumber` |
| `price_change_percentage_24h` | `market.change24hPct` | `toNumber` |
| `circulating_supply` | `ext.circulatingSupply` | `toNumber` |
| `ath` | `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](https://onekey.dev/pricing); your balance must cover the price. |
| 404 | `not_found` | Unknown endpoint path. |
| 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](https://onekey.dev/docs/errors.md) for the full list and retry guidance.

Status: beta (not yet verified against the live source).