Skip to main content

​
GET /v1/overview

Returns a comprehensive overview for one or more symbols — price, funding rates, open interest, and long/short ratios from all exchanges in one call. This is the primary endpoint for building symbol dashboards. Supports two modes:
  • Single symbol — Pass ?symbol=ETH for a full breakdown of one asset
  • Top N — Omit symbol and use ?top=20 to get the top symbols ranked by total open interest
All responses are served from a 15-second pre-aggregated cache for fast, consistent reads.

​
Query Parameters

​
symbol
string
Symbol to query (e.g., BTC, ETH). Omit to use top-N mode.
​
top
integer
default:"20"
Number of top symbols to return when symbol is omitted. Ranked by total open interest (descending). Range: 1–100.
​
detail
string
default:"summary"
Detail level for the response. Options:
  • summary — Aggregated averages and totals only (default)
  • full — Includes per-exchange breakdowns for all data types

​
Single Symbol Response

curl "https://api.crypton.dev/v1/overview?symbol=ETH&detail=full"

{
  "status": "ok",
  "timestamp": 1709640000000,
  "data": {
    "symbol": "ETH",
    "price_avg": 3512.45,
    "price_exchanges": {
      "binance": { "price": 3512.50, "volume_24h": 850000000.0, "updated_at": 1709639900000 },
      "okx": { "price": 3512.30, "volume_24h": 420000000.0, "updated_at": 1709639850000 }
    },
    "funding_avg": 0.0072,
    "funding_exchanges": {
      "binance": { "rate": 0.0080, "next_funding": "2026-03-13T16:00:00Z", "updated_at": 1709639900000 },
      "bybit": { "rate": 0.0065, "updated_at": 1709639850000 }
    },
    "total_oi_usd": 8123456789.25,
    "oi_exchanges": {
      "binance": { "oi_usd": 3200000000.0, "oi_contracts": 910540.0, "updated_at": 1709639900000 }
    },
    "ls_ratio_avg": 1.15,
    "ls_exchanges": {
      "binance": { "long_pct": 53.5, "short_pct": 46.5, "ratio": 1.15, "updated_at": 1709639900000 }
    }
  }
}
With detail=summary (default), the response omits per-exchange breakdowns: 
{
  "status": "ok",
  "timestamp": 1709640000000,
  "data": {
    "symbol": "ETH",
    "price_avg": 3512.45,
    "funding_avg": 0.0072,
    "total_oi_usd": 8123456789.25,
    "ls_ratio_avg": 1.15
  }
}

​
Top N Response

curl "https://api.crypton.dev/v1/overview?top=3"

{
  "status": "ok",
  "timestamp": 1709640000000,
  "data": {
    "symbols": [
      {
        "symbol": "BTC",
        "price_avg": 71250.00,
        "funding_avg": 0.0085,
        "total_oi_usd": 18500000000.00,
        "ls_ratio_avg": 1.08
      },
      {
        "symbol": "ETH",
        "price_avg": 3512.45,
        "funding_avg": 0.0072,
        "total_oi_usd": 8123456789.25,
        "ls_ratio_avg": 1.15
      },
      {
        "symbol": "SOL",
        "price_avg": 148.30,
        "funding_avg": 0.0120,
        "total_oi_usd": 3200000000.00,
        "ls_ratio_avg": 1.22
      }
    ],
    "total": 2023
  }
}
With detail=full, each symbol in the array includes per-exchange breakdowns (price_exchanges, funding_exchanges, oi_exchanges, ls_exchanges).

​
Response Fields

​
data.symbol
string
The queried symbol (single-symbol mode only).
​
data.symbols
array
Array of symbol overviews ranked by OI (top-N mode only).
​
data.total
integer
Total number of tracked symbols (top-N mode only).
​
data.price_avg
number
Average price across all exchanges. Returns 0 if no exchange has price data.
​
data.price_exchanges
object
Per-exchange price data. Only present with detail=full.
​
data.funding_avg
number
Average funding rate across exchanges (8h normalized).
​
data.funding_exchanges
object
Per-exchange funding rates. Only present with detail=full. See Funding Rates for field details.
​
data.total_oi_usd
number
Aggregate open interest in USD.
​
data.oi_exchanges
object
Per-exchange OI. Only present with detail=full. See Open Interest for field details.
​
data.ls_ratio_avg
number
Average long/short ratio. >1.0 = more longs, <1.0 = more shorts.
​
data.ls_exchanges
object
Per-exchange L/S data. Only present with detail=full. See Long/Short Ratio for field details.

​
Caching

All overview responses are served from a 15-second pre-aggregated cache. The cache is rebuilt automatically on each poll cycle, so reads are fast and consistent regardless of the number of exchanges or symbols requested.

​
Field Reference

FieldTypeDescriptionGranularityExample
symbolstringQueried base asset symbol—"ETH"
price_avgnumberSimple average price across all reporting exchanges (USD)~30s aggregated3512.45
funding_avgnumberMean 8h-normalized funding rate across exchanges (decimal)~30s aggregated0.0072
total_oi_usdnumberAggregate open interest across all exchanges (USD)~30s aggregated8123456789.25
ls_ratio_avgnumberMean long/short ratio. >1.0 = net long~30s aggregated1.15
price_exchanges.*.pricenumberLast traded price on this exchange (USD)~30s per exchange3512.50
price_exchanges.*.volume_24hnumber24h trading volume on this exchange (USD)~30s per exchange850000000.0
funding_exchanges.*.ratenumber8h-normalized funding rate on this exchange~30s per exchange0.0080
oi_exchanges.*.oi_usdnumberOpen interest on this exchange (USD)~30s per exchange3200000000.0

​
Data Sources

Aggregates data from all 23 registered exchanges. Price and volume from spot + futures exchanges, funding from 12 derivatives exchanges, OI from 11+ exchanges, L/S from Binance/OKX/Bitget. All data fetched concurrently with ~30s refresh cycle.

​
Live Testing

# BTC overview with full detail
curl -s "https://api.crypton.dev/v1/overview?symbol=BTC&detail=full" | jq .

# Top 10 by open interest (summary)
curl -s "https://api.crypton.dev/v1/overview?top=10" | jq .

# Top 5 with full per-exchange breakdowns
curl -s "https://api.crypton.dev/v1/overview?top=5&detail=full" | jq .

# ETH overview (summary, default)
curl -s "https://api.crypton.dev/v1/overview?symbol=ETH" | jq .