get_hip3_freshness
Read-onlyIdempotent
Check data freshness for a HIP-3 coin across orderbook, trades, funding, and open interest. Shows when each data type was last updated and current lag.
Instructions
Get data freshness for a HIP-3 coin across all data types (orderbook, trades, funding, OI). Symbols are CASE-SENSITIVE (e.g. 'km:US500'). Shows when each data type was last updated and current lag.
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:924-931 (registration)Registration of the get_hip3_freshness tool using the registerCurrentTool helper pattern. Accepts a HIP-3 coin symbol as input and delegates to the SDK's api().hyperliquid.hip3.freshness(coin) method.
// HIP-3 Freshness registerCurrentTool( "get_hip3_freshness", "Get data freshness for a HIP-3 coin across all data types (orderbook, trades, funding, OI). Symbols are CASE-SENSITIVE (e.g. 'km:US500'). Shows when each data type was last updated and current lag.", (coin) => api().hyperliquid.hip3.freshness(coin), Hip3CoinParam, normalizeHip3Coin ); - src/index.ts:372-384 (handler)Handler logic: registerCurrentTool helper wraps the SDK call (api().hyperliquid.hip3.freshness) with coin normalization and standard response formatting.
// Pattern 2: Current snapshot (coin only) function registerCurrentTool( name: string, description: string, sdkCall: (coin: string) => Promise<unknown>, coinSchema: z.ZodString, normFn: (coin: string) => string ): void { registerTool(name, description, { coin: coinSchema }, ObjectOutputSchema, async (params) => { const data = await sdkCall(normFn(params.coin)); return formatResponse(data); }); } - src/index.ts:57-61 (schema)Input schema: Hip3CoinParam defines the CASE-SENSITIVE HIP-3 coin symbol parameter accepted by the tool.
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:300-302 (helper)Helper: normalizeHip3Coin — passes the coin through as-is (case-sensitive, no transformation).
function normalizeHip3Coin(coin: string): string { return coin; // Case-sensitive }