API reference
Categorized endpoint catalog with developer-friendly descriptions and copy-ready integration examples.
Market Overview
Global market stats, movers, and trending coins.
| Endpoint | Description | Params |
|---|---|---|
GET /api/market-overview/total-market-cap | Total crypto market capitalization in USD. | None |
GET /api/market-overview/volume-24h | Global 24-hour market volume in USD. | None |
GET /api/market-overview/btc-dominance | Bitcoin market cap dominance percentage. | None |
GET /api/market-overview/fear-greed | Crypto Fear & Greed index + recent history. | None |
GET /api/market-overview/top-gainers | Top gainers by 24h performance. | limit (1-50, default 10) |
GET /api/market-overview/top-losers | Top losers by 24h performance. | limit (1-50, default 10) |
GET /api/market-overview/trending-coins | Currently trending coins. | limit (1-50, default 10) |
GET /api/market-overview/coins | Coin-level market cap and 24h volume snapshot. | limit (1-250, default 100) |
GET /api/market-overview/dashboard | All-in-one dashboard payload (market + derivatives signals). | symbol, majorSymbols, liquidationSymbols, moversLimit, coinsLimit, trendingLimit |
Copy-ready example:
// requires Node 18+ (native fetch) const res = await fetch("/api/market-overview/total-market-cap"); const data = await res.json(); console.log(data);
Price & Trading
Real-time and historical exchange market data.
| Endpoint | Description | Params |
|---|---|---|
GET /api/market/[symbol] | Aggregated market snapshot for a symbol. | symbol (e.g. BTCUSDT) |
GET /api/ticker/[symbol] | Latest ticker values for a symbol. | symbol |
GET /api/ohlc/[symbol] | Candles for a symbol across venues. | interval, limit |
GET /api/orderbook/[symbol] | Order book depth snapshot. | depth |
GET /api/trades/[symbol] | Recent trades feed. | limit |
Copy-ready example:
// requires Node 18+ (native fetch) const res = await fetch("/api/market/BTCUSDT"); const data = await res.json(); console.log(data);
Derivatives Signals
Funding rates, long/short ratios, liquidations, and major OI.
| Endpoint | Description | Params |
|---|---|---|
GET /api/derivatives/funding-rates/[symbol] | Funding rates aggregated by trading platform. | symbol |
GET /api/derivatives/funding-by-exchange/[symbol] | Funding data per exchange (alias endpoint). | symbol |
GET /api/derivatives/long-short/[symbol] | Long-vs-short account ratio history. | symbol |
GET /api/derivatives/liquidations | Dedicated liquidation rollup across major symbols. | symbols=BTCUSDT,ETHUSDT,... (optional) |
GET /api/derivatives/liquidations-history/[symbol] | Historical liquidation events (rolling 7-day file store) plus per-exchange coverage status. | state, from, to, before, after, limit |
GET /api/derivatives/liquidations-24h/[symbol] | 24h liquidation notional by exchange. | symbol |
GET /api/derivatives/open-interest/major | Open interest rollup for major coins. | symbols=BTCUSDT,ETHUSDT,... (optional) |
Copy-ready example:
// requires Node 18+ (native fetch) const res = await fetch("/api/derivatives/funding-rates/BTCUSDT"); const data = await res.json(); console.log(data);
Economic Calendar
Macro event calendar from a free public source.
| Endpoint | Description | Params |
|---|---|---|
GET /api/economic-calendar | Weekly economic events with filtering options. | country, impact, from, to, upcoming, limit |
Copy-ready example:
// requires Node 18+ (native fetch) const res = await fetch("/api/economic-calendar?country=USD&impact=high&upcoming=true"); const data = await res.json(); console.log(data);
Crypto ETFs
Free/public quote coverage for major US-listed spot BTC and spot ETH ETFs.
| Endpoint | Description | Params |
|---|---|---|
GET /api/etf/crypto | List crypto ETF quotes (BTC + ETH, or by category). | category=all|btc|eth (optional) |
GET /api/etf/crypto/[symbol] | Single ETF quote by ticker (e.g. IBIT, FBTC, ETHA). | symbol |
GET /api/etf/sources | Source metadata and tracked ETF ticker lists. | None |
Copy-ready example:
// requires Node 18+ (native fetch) const res = await fetch("/api/etf/crypto?category=all"); const data = await res.json(); console.log(data);
Instruments & Assets
Derivatives, pairs, and asset metadata.
| Endpoint | Description | Params |
|---|---|---|
GET /api/derivatives/[symbol] | Derivatives market metrics for a symbol. | symbol |
GET /api/openinterest/[symbol] | Open interest by venue. | symbol |
GET /api/pairs | Trading pair directory across exchanges. | base, quote, active |
GET /api/assets/[asset] | Asset profile and exchange support. | asset (e.g. BTC) |
GET /api/funding/[asset] | Deposit and withdrawal status. | asset |
Copy-ready example:
// requires Node 18+ (native fetch) const res = await fetch("/api/derivatives/BTCUSDT"); const data = await res.json(); console.log(data);