get_hip3_liquidations

Instructions

Implementation Reference

• src/index.ts:750-758 (registration)

  Registration of the 'get_hip3_liquidations' tool using registerHistoryTool. It sets the description, maps to the SDK call api().hyperliquid.hip3.liquidations.history, uses Hip3CoinParam input schema and normalizeHip3Coin normalization.

  // 21b. HIP-3 Liquidations
  registerHistoryTool(
    "get_hip3_liquidations",
    "Get HIP-3 liquidation events for a coin over a time range. Returns liquidated/liquidator addresses, price, size, side, and PnL. Symbols are CASE-SENSITIVE (e.g. 'km:US500'). Data available from February 2026. Real-time HIP-3 liquidations are also available on the WebSocket `hip3_liquidations` channel — each event is a fill row with `is_liquidation: true`, same shape as the `hip3_trades` channel.",
    (coin, params) =>
      api().hyperliquid.hip3.liquidations.history(coin, params as any),
    Hip3CoinParam,
    normalizeHip3Coin
  );

• src/index.ts:57-61 (schema)

  The Hip3CoinParam Zod schema used as the input 'coin' parameter for get_hip3_liquidations. Validates case-sensitive HIP-3 coin symbols.

  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)

  The normalizeHip3Coin helper function that passes through the coin string as-is (case-sensitive) for HIP-3 tools including get_hip3_liquidations.

  function normalizeHip3Coin(coin: string): string {
    return coin; // Case-sensitive
  }

• src/index.ts:408-438 (helper)

  The registerHistoryTool helper function used to register get_hip3_liquidations. It handles time range resolution, pagination (cursor), limit, and extra params, then calls formatCursorResponse.

  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);
    });
  }

• src/index.ts:113-122 (helper)

  The HistoryParams shared schema object used by get_hip3_liquidations, defining start/end timestamps, limit, and cursor parameters.

  const HistoryParams = {
    start: TimestampParam.describe(
      "Start timestamp (Unix ms or ISO). Defaults to 24h ago."
    ),
    end: TimestampParam.describe(
      "End timestamp (Unix ms or ISO). Defaults to now."
    ),
    limit: LimitParam,
    cursor: CursorParam,
  };