GET
/api/v1/spot/large-ordersStandard tier+ · 300 req/minWhale spot orderbook prints above a configurable notional threshold.
Scans the `large_order` table for spot-kind instruments, filtered to prints >= `minUsd`. Returns rows + summary totals + facet sets so a UI can render a complete filter bar in one shot. `tableMissing: true` signals the collector hasn't written yet on a fresh install.
Query parameters
All query parameters are optional unless marked required.
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| limit | number | optional | 50 | Rows. Max 500. |
| minUsd | number | optional | 500000 | Minimum notional, USD. |
| coin | string | optional | — | Base asset filter. |
| source | string | optional | — | Exchange filter. |
| side | enum | optional | — | Orderbook side. bidask |
Response shape
Always wrapped in the standard envelope. Nullable fields are explicitly marked — treat missing numeric data as a real data-source gap, not as an error.
data payloadtypescript
// Wrapped in the standard envelope:
// {
// data: /* shape below */,
// meta?: { total?: number; limit?: number; offset?: number; ... }
// }
{
rows: Array<{
id: number;
source: string;
base: string;
quote: string;
side: "bid" | "ask";
price: number;
qtyBase: number;
qtyUsd: number;
ts: number;
status: string | null;
}>;
tableMissing: boolean;
totalUsd: number;
bidUsd: number;
askUsd: number;
distinctCoins: number;
distinctSources: number;
lastTs: number | null;
facets: { coins: string[]; sources: string[] };
appliedMinUsd: number;
appliedLimit: number;
}Example
Copy the curl, replace YOUR_KEY with a real key from your dashboard, and run.
Requestbash
curl -sS "http://localhost:3000/api/v1/spot/large-orders?minUsd=1000000" \
-H "Authorization: Bearer cg_live_YOUR_KEY"Responsejson
{
"data": {
"rows": [
{ "id": 128, "source": "binance", "base": "BTC", "quote": "USDT", "side": "bid", "price": 63120.5, "qtyBase": 25.4, "qtyUsd": 1603260.0, "ts": 1744835000000, "status": "open" }
],
"tableMissing": false,
"totalUsd": 1603260.0,
"bidUsd": 1603260.0,
"askUsd": 0,
"distinctCoins": 1,
"distinctSources": 1,
"lastTs": 1744835000000,
"facets": { "coins": ["BTC"], "sources": ["binance"] },
"appliedMinUsd": 1000000,
"appliedLimit": 50
},
"meta": { "total": 1, "limit": 50, "minUsd": 1000000, "tableMissing": false }
}Notes
- When `tableMissing: true`, render an honest empty state rather than an error.
Next
Check the error code reference, or get an API key to try the request against your own account.