get_hip3_l2_orderbook_history
Read-onlyIdempotent
Retrieve HIP-3 L2 full-depth orderbook checkpoints for case-sensitive coin symbols across multiple builders. Access periodic aggregated snapshots with optional time range and depth limits.
Instructions
Get HIP-3 L2 full-depth orderbook checkpoints (Build+ tier). Symbols are CASE-SENSITIVE. Returns periodic aggregated snapshots.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| coin | Yes | HIP-3 coin symbol (CASE-SENSITIVE). 125+ markets across 6 builders: xyz, flx, hyna, km, vntl, cash. Examples: 'km:US500', 'xyz:GOLD', 'hyna:BTC', 'vntl:SPACEX', 'flx:TSLA', 'cash:NVDA'. Use get_hip3_instruments to list all. | |
| start | No | Start timestamp (Unix ms or ISO). Defaults to 24h ago. | |
| end | No | End timestamp (Unix ms or ISO). Defaults to now. | |
| limit | No | Max records to return (default 100, max 1000) | |
| cursor | No | Pagination cursor from previous response's nextCursor | |
| depth | No | Orderbook depth — number of price levels per side |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| records | Yes | Array of result records | |
| count | Yes | Total number of records in the full result set | |
| nextCursor | No | Cursor for next page, if more results available |
Implementation Reference
- src/index.ts:662-670 (registration)Registration of the 'get_hip3_l2_orderbook_history' tool using registerHistoryTool. It calls api().hyperliquid.hip3.l2Orderbook.history(coin, params) via a lambda, uses Hip3CoinParam schema for the coin parameter, normalizeHip3Coin normalization, and adds an optional depth parameter.
registerHistoryTool( "get_hip3_orderbook_history", "Get historical HIP-3 orderbook snapshots. Symbols are CASE-SENSITIVE (e.g. 'km:US500'). Returns L2 snapshots with bids/asks over a time range. Free tier: km:US500 only. Build+: all HIP-3 symbols.", (coin, params) => api().hyperliquid.hip3.orderbook.history(coin, params as any), Hip3CoinParam, normalizeHip3Coin, { depth: DepthParam } ); - src/index.ts:57-61 (schema)Hip3CoinParam schema – Zod string describing the HIP-3 coin parameter used by get_hip3_l2_orderbook_history.
const Hip3CoinParam = z .string() .describe( "HIP-3 coin symbol (CASE-SENSITIVE). 125+ markets across 6 builders: xyz, flx, hyna, km, vntl, cash. Examples: 'km:US500', 'xyz:GOLD', 'hyna:BTC', 'vntl:SPACEX', 'flx:TSLA', 'cash:NVDA'. Use get_hip3_instruments to list all." ); - src/index.ts:98-101 (schema)DepthParam schema – optional Zod number for orderbook depth (price levels per side), used by get_hip3_l2_orderbook_history.
const DepthParam = z .number() .optional() .describe("Orderbook depth — number of price levels per side"); - src/index.ts:300-302 (helper)normalizeHip3Coin – normalization function for HIP-3 coin symbols (case-sensitive, returns as-is).
function normalizeHip3Coin(coin: string): string { return coin; // Case-sensitive } - src/index.ts:408-438 (helper)registerHistoryTool – the generic tool registration helper used to register get_hip3_l2_orderbook_history. It handles time range resolution, pagination, and extra schema params like depth.
function registerHistoryTool( name: string, description: string, sdkCall: (coin: string, params: Record<string, unknown>) => Promise<{ data: unknown; nextCursor?: string }>, coinSchema: z.ZodString, normFn: (coin: string) => string, extraSchema?: ZodRawShape ): void { const schema: ZodRawShape = { coin: coinSchema, ...HistoryParams }; if (extraSchema) Object.assign(schema, extraSchema); registerTool(name, description, schema, ListOutputSchema, async (params) => { const { coin, start, end, limit, cursor, ...extra } = params; const timeRange = resolveTimeRange(start, end); const sdkParams: Record<string, unknown> = { ...timeRange, limit: resolveLimit(limit), }; if (cursor) sdkParams.cursor = cursor; // Pass through extra params (interval, side, etc.) for (const [k, v] of Object.entries(extra)) { if (v !== undefined) sdkParams[k] = v; } const result = await sdkCall(normFn(coin), sdkParams); return formatCursorResponse(result); }); }