Skip to main content
GET
Market heatmap

Authorizations

Authorization
string
header
required

Pass your API key as a Bearer token in the Authorization header: Authorization: Bearer sk_live_...

Query Parameters

mode
enum<string>
default:coins

Heatmap grouping mode.

Available options:
coins,
narratives,
ecosystems
category
string
default:top50

Coins-mode universe. top10, top20, top30 and top50 (the default) are the N largest eligible coins by market cap; the legacy top-100 is an alias of top50. Otherwise one of the 15 narrative ids or 20 ecosystem ids (e.g. layer-1, solana-ecosystem), an alias such as defi or sol, or a /heatmap/ page slug: the category's eligible members, of which the 50 largest are served; an ecosystem's members are the coins whose home chain it is. Ignored in the aggregate modes. Eligible coins: a 24h price change, market cap at least $1M, plausible 24h spot volume (at most 50x market cap) at least $100K, CoinGecko data under 48 hours old, and not a stablecoin, wrapped, bridged or staked copy, LP token, tokenized metal, fund, stock, ETF or pre-IPO token.

ex
string

Comma-separated CoinGecko coin ids to leave out, lower case (e.g. bitcoin,ethereum). Coins mode: removed after the Top N cut and never refilled, so top10 with two member ids answers 8 coins. Aggregate modes: every tile is rebuilt from its members without them; a tile left with no member is dropped and counted in omitted. excluded lists the ids that were applied; the others are ignored and named in meta.warnings.

Maximum string length: 2000
Pattern: ^[a-z0-9_.-]+(,[a-z0-9_.-]+)*$
format
enum<string>
default:json

Response format. When set to "csv", the response Content-Type is text/csv instead of JSON.

Available options:
json,
csv

Response

Heatmap data returned successfully.

data
object
required

Endpoint-specific response payload. See the operation response schema.

meta
object
required