pulse_market_overview
Retrieve market overview with 24h volume, open interest, mark price, funding rate, and 24h change per pair. Optionally filter by DEX.
Instructions
DEPRECATED alias for list_markets — returns the same payload (24h volume, open interest, mark price, funding rate, 24h change for every pair). Prefer list_markets for new integrations; this tool is kept for backward compatibility only.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| useToonFormat | No | Return data in compact toon format (default: true). Set to false for standard JSON. | |
| dex | No | Filter by dex. 'hl' for native Hyperliquid only, or a builder dex name (xyz, cash, km, etc.). Omit for all markets. |
Implementation Reference
- src/index.ts:30-31 (registration)Free-tier tool registration — pulse_market_overview is listed as a free tool available without API key
const FREE_TIER_TOOLS = new Set([ 'pulse_global_stats', - src/index.ts:250-264 (registration)Tool registration for pulse_market_overview — DEPRECATED alias for list_markets. Calls /pulse/market-overview API endpoint with optional dex filter.
if (shouldRegister("pulse_market_overview")) server.registerTool( "pulse_market_overview", { description: "DEPRECATED alias for list_markets — returns the same payload (24h volume, open interest, mark price, funding rate, 24h change for every pair). Prefer list_markets for new integrations; this tool is kept for backward compatibility only.", inputSchema: { useToonFormat: useToonFormatSchema, dex: z.enum(["hl", "xyz", "flx", "vntl", "hyna", "km", "abcd", "cash"]).optional().describe("Filter by dex. 'hl' for native Hyperliquid only, or a builder dex name (xyz, cash, km, etc.). Omit for all markets."), }, }, async ({ useToonFormat, dex }) => { const params: Record<string, string> = {}; if (dex) params.dex = dex; return toolResult(await callAPI(useToonFormat, "/pulse/market-overview", params)); } ); - src/index.ts:254-257 (schema)Input schema for pulse_market_overview: useToonFormat (boolean, defaults true) and optional dex filter (enum of dex names)
inputSchema: { useToonFormat: useToonFormatSchema, dex: z.enum(["hl", "xyz", "flx", "vntl", "hyna", "km", "abcd", "cash"]).optional().describe("Filter by dex. 'hl' for native Hyperliquid only, or a builder dex name (xyz, cash, km, etc.). Omit for all markets."), }, - src/index.ts:259-263 (handler)Handler function — calls the /pulse/market-overview API endpoint, passing optional dex filter, and returns the result formatted via toolResult
async ({ useToonFormat, dex }) => { const params: Record<string, string> = {}; if (dex) params.dex = dex; return toolResult(await callAPI(useToonFormat, "/pulse/market-overview", params)); }