get_hip3_instrument
Read-onlyIdempotent
Retrieve mark price, open interest, mid price, and latest timestamp for a specific HIP-3 instrument by providing its case-sensitive symbol.
Instructions
Get details for a single HIP-3 instrument. Symbols are CASE-SENSITIVE (e.g. 'km:US500'). Returns mark price, open interest, mid price, and latest timestamp.
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. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| data | Yes | Result data object |
Implementation Reference
- src/index.ts:636-641 (registration)Registration of 'get_hip3_instruments' tool using registerInstrumentsTool helper. Lists all HIP-3 builder perp instruments.
// 16. HIP-3 Instruments registerInstrumentsTool( "get_hip3_instruments", "List all available HIP-3 builder perp instruments on Hyperliquid. HIP-3 symbols are CASE-SENSITIVE (e.g. 'km:US500', 'km:TSLA'). Use this to discover valid symbols before querying HIP-3 data.", () => api().hyperliquid.hip3.instruments.list() ); - src/index.ts:637-641 (handler)Handler lambda that calls api().hyperliquid.hip3.instruments.list() to fetch all HIP-3 instruments.
registerInstrumentsTool( "get_hip3_instruments", "List all available HIP-3 builder perp instruments on Hyperliquid. HIP-3 symbols are CASE-SENSITIVE (e.g. 'km:US500', 'km:TSLA'). Use this to discover valid symbols before querying HIP-3 data.", () => api().hyperliquid.hip3.instruments.list() ); - src/index.ts:361-370 (helper)Helper function registerInstrumentsTool which wraps registerTool for instrument-list tools (no input params). It calls the SDK method and formats the response.
function registerInstrumentsTool( name: string, description: string, sdkCall: () => Promise<unknown[]> ): void { registerTool(name, description, {}, ListOutputSchema, async () => { const data = await sdkCall(); return formatResponse(data); }); } - src/index.ts:643-650 (registration)Registration of 'get_hip3_instrument' (singular) tool using registerCurrentTool helper. Gets details for a single HIP-3 instrument.
// 15b. HIP-3 Single Instrument registerCurrentTool( "get_hip3_instrument", "Get details for a single HIP-3 instrument. Symbols are CASE-SENSITIVE (e.g. 'km:US500'). Returns mark price, open interest, mid price, and latest timestamp.", (coin) => api().hyperliquid.hip3.instruments.get(coin), Hip3CoinParam, normalizeHip3Coin ); - src/index.ts:57-62 (schema)Hip3CoinParam Zod schema describing the case-sensitive HIP-3 coin symbol format, used as input param schema.
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." );