curl --request GET \
--url https://www.sharpe.ai/api/v1/heatmap/data \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://www.sharpe.ai/api/v1/heatmap/data', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://www.sharpe.ai/api/v1/heatmap/data"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": {
"dots": [
{
"id": "<string>",
"name": "<string>",
"symbol": "<string>",
"x": 123,
"returns": {
"24h": 123,
"7d": 123,
"30d": 123,
"1y": 123,
"3y": 123,
"1h": 123,
"4h": 123
},
"marketCap": 123,
"kind": "coin",
"logoUrl": "<string>",
"price": 123,
"volume24h": 123,
"openInterest": 123,
"oiChange24h": 123,
"avgFundingApr": 123,
"fundingMethod": "oi_weighted",
"fundingVenuesUsed": 1,
"rsi": {
"1h": 50,
"4h": 50,
"1d": 50
},
"median": {
"returns": {
"1h": 123,
"4h": 123,
"24h": 123,
"7d": 123,
"30d": 123,
"1y": 123
},
"avgFundingApr": 123,
"x": 123
},
"constituents": {
"m": 1,
"n": {
"return1h": 1,
"return4h": 1,
"return24h": 1,
"return7d": 1,
"return30d": 1,
"return1y": 1,
"avgFundingApr": 1,
"oiChange24h": 1,
"rsi1h": 1,
"rsi4h": 1,
"rsi1d": 1,
"rvol": 1
},
"weightCoverage": {
"return1h": 0.5,
"return4h": 0.5,
"return24h": 0.5,
"return7d": 0.5,
"return30d": 0.5,
"return1y": 0.5,
"avgFundingApr": 0.5,
"oiChange24h": 0.5,
"rvol": 0.5
},
"largest": {
"id": "<string>",
"symbol": "<string>",
"marketCapShare": 0.5
}
}
}
],
"updated_at": "<string>",
"coverage": {
"status": "complete",
"availableCategories": 1,
"totalCategories": 2,
"ratio": 0.5,
"emptyCategories": 1,
"failedCategories": [
"<string>"
]
},
"as_of": {
"funding": "2023-11-07T05:31:56Z",
"candle_1h": "2023-11-07T05:31:56Z",
"candle_4h": "2023-11-07T05:31:56Z",
"candle_1d": "2023-11-07T05:31:56Z"
},
"eligible": 1,
"excluded": [
"<string>"
],
"omitted": 1
},
"meta": {
"request_id": "req_a1b2c3d4e5f6g7h8i9j0",
"timestamp": "2023-11-07T05:31:56Z",
"elapsed_ms": 1,
"dataset_id": "funding_rates_current",
"as_of": "2023-11-07T05:31:56Z",
"stale_after": "2023-11-07T05:31:56Z",
"freshness_sla_seconds": 123,
"freshness_status": "fresh",
"runtime_status": "ok",
"served_from": "snapshot",
"generated_at": "2023-11-07T05:31:56Z",
"source": [
"<string>"
],
"coverage": {
"expected": 123,
"used": 123,
"dropped": {},
"missing": [
"<string>"
]
},
"warnings": [
"<string>"
],
"truncated": true
}
}Market heatmap
Returns the market heatmap: coins (a Top N universe, or one narrative’s or ecosystem’s members) or one tile per narrative or ecosystem. Eligible coins: a 24h price change, market cap at least 1M,plausible24hspotvolume(atmost50xmarketcap)atleast100K, 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. A category tile covers every eligible member: price changes are cap-weighted, funding is open-interest weighted, OI value change and RVOL are ratios of member sums, and RSI is the median member; each tile carries constituents (members with a value and the share of weight they carry) and its median member, and a value is null below its floor. ex leaves coins out in every mode; aggregate tiles are rebuilt without them. returns.1h, returns.4h, avgFundingApr, rsi, median and constituents are rounded (returns and funding, fractions, to 4 dp; RVOL to 2 dp, RSI to 1 dp, weightCoverage to 3 dp, largest.marketCapShare to 4 dp); every other field keeps full precision. Aggregate modes expose complete or partial category coverage. The cache is rebuilt every three hours; X-Data-Stale is true once updated_at is more than six hours old (X-Freshness-Sla-Seconds 21600) or missing, and X-Data-As-Of repeats updated_at. Candle and funding metrics carry their own times in as_of.
curl --request GET \
--url https://www.sharpe.ai/api/v1/heatmap/data \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://www.sharpe.ai/api/v1/heatmap/data', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://www.sharpe.ai/api/v1/heatmap/data"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": {
"dots": [
{
"id": "<string>",
"name": "<string>",
"symbol": "<string>",
"x": 123,
"returns": {
"24h": 123,
"7d": 123,
"30d": 123,
"1y": 123,
"3y": 123,
"1h": 123,
"4h": 123
},
"marketCap": 123,
"kind": "coin",
"logoUrl": "<string>",
"price": 123,
"volume24h": 123,
"openInterest": 123,
"oiChange24h": 123,
"avgFundingApr": 123,
"fundingMethod": "oi_weighted",
"fundingVenuesUsed": 1,
"rsi": {
"1h": 50,
"4h": 50,
"1d": 50
},
"median": {
"returns": {
"1h": 123,
"4h": 123,
"24h": 123,
"7d": 123,
"30d": 123,
"1y": 123
},
"avgFundingApr": 123,
"x": 123
},
"constituents": {
"m": 1,
"n": {
"return1h": 1,
"return4h": 1,
"return24h": 1,
"return7d": 1,
"return30d": 1,
"return1y": 1,
"avgFundingApr": 1,
"oiChange24h": 1,
"rsi1h": 1,
"rsi4h": 1,
"rsi1d": 1,
"rvol": 1
},
"weightCoverage": {
"return1h": 0.5,
"return4h": 0.5,
"return24h": 0.5,
"return7d": 0.5,
"return30d": 0.5,
"return1y": 0.5,
"avgFundingApr": 0.5,
"oiChange24h": 0.5,
"rvol": 0.5
},
"largest": {
"id": "<string>",
"symbol": "<string>",
"marketCapShare": 0.5
}
}
}
],
"updated_at": "<string>",
"coverage": {
"status": "complete",
"availableCategories": 1,
"totalCategories": 2,
"ratio": 0.5,
"emptyCategories": 1,
"failedCategories": [
"<string>"
]
},
"as_of": {
"funding": "2023-11-07T05:31:56Z",
"candle_1h": "2023-11-07T05:31:56Z",
"candle_4h": "2023-11-07T05:31:56Z",
"candle_1d": "2023-11-07T05:31:56Z"
},
"eligible": 1,
"excluded": [
"<string>"
],
"omitted": 1
},
"meta": {
"request_id": "req_a1b2c3d4e5f6g7h8i9j0",
"timestamp": "2023-11-07T05:31:56Z",
"elapsed_ms": 1,
"dataset_id": "funding_rates_current",
"as_of": "2023-11-07T05:31:56Z",
"stale_after": "2023-11-07T05:31:56Z",
"freshness_sla_seconds": 123,
"freshness_status": "fresh",
"runtime_status": "ok",
"served_from": "snapshot",
"generated_at": "2023-11-07T05:31:56Z",
"source": [
"<string>"
],
"coverage": {
"expected": 123,
"used": 123,
"dropped": {},
"missing": [
"<string>"
]
},
"warnings": [
"<string>"
],
"truncated": true
}
}Authorizations
Query Parameters
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.
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.
2000^[a-z0-9_.-]+(,[a-z0-9_.-]+)*$
