get_hip4_instrument

Instructions

Implementation Reference

• src/index.ts:1574-1583 (registration)

  Registration of the 'get_hip4_instrument' tool via registerTool(). It accepts a 'coin' parameter (validated by Hip4CoinParam), calls the HIP-4 REST API endpoint /instruments/:coin, and returns the result.

  registerTool(
    "get_hip4_instrument",
    "Get details for a single HIP-4 instrument by coin symbol (e.g. '0'). Bare numeric coins are canonical; legacy '#0' / '%230' forms are also accepted.Returns per-side metadata including outcome_id, side, asset_id, name, recurring class/underlying/expiry, builder address, and is_settled status.",
    { coin: Hip4CoinParam },
    ObjectOutputSchema,
    async (params) => {
      const result = await hip4Request(`/instruments/${normalizeHip4Coin(params.coin)}`);
      return formatResponse(result.data);
    }
  );

• src/index.ts:1579-1583 (handler)

  Handler function for get_hip4_instrument. Normalizes the coin symbol using normalizeHip4Coin, makes a GET request to /v1/hyperliquid/hip4/instruments/{coin} via hip4Request, and formats the response.

    async (params) => {
      const result = await hip4Request(`/instruments/${normalizeHip4Coin(params.coin)}`);
      return formatResponse(result.data);
    }
  );

• src/index.ts:63-67 (schema)

  Input schema (Zod) for the HIP-4 coin parameter used by get_hip4_instrument and other HIP-4 tools. Validates it's a string.

  const Hip4CoinParam = z
    .string()
    .describe(
      "HIP-4 outcome-market coin symbol. Canonical form is the bare numeric '<10*outcome_id + side>' (e.g. '0' for outcome 0 Yes, '1' for outcome 0 No, '10' for outcome 1 Yes). The legacy '#0' and '%230' forms are also accepted. Use get_hip4_instruments to list all."
    );

• src/index.ts:307-314 (helper)

  Normalization helper for HIP-4 coin symbols. Strips legacy # or %23 prefixes, leaving bare numeric form. Used by get_hip4_instrument's handler before making the API call.

  function normalizeHip4Coin(coin: string): string {
    const trimmed = String(coin).trim();
    if (/^\d+$/.test(trimmed)) return trimmed;
    const stripped = trimmed.replace(/^(#|%23)/i, "");
    if (/^\d+$/.test(stripped)) return stripped;
    // Unknown shape — fall back to URL-encoding the original.
    return encodeURIComponent(trimmed);
  }

• src/index.ts:1487-1537 (helper)

  Helper function that makes all HIP-4 REST API calls (including the one for get_hip4_instrument). Constructs the URL with query params, adds auth headers, handles errors, and returns parsed data with optional cursor.

  async function hip4Request(
    path: string,
    query?: Record<string, unknown>
  ): Promise<{ data: unknown; nextCursor?: string }> {
    const url = new URL(`${HIP4_BASE_PATH}${path}`, HIP4_BASE_URL);
    if (query) {
      for (const [k, v] of Object.entries(query)) {
        if (v === undefined || v === null) continue;
        url.searchParams.set(k, String(v));
      }
    }
    const headers: Record<string, string> = {
      "Content-Type": "application/json",
      "User-Agent": "0xarchive-mcp/1.9.0",
    };
    if (apiKey) headers["X-API-Key"] = apiKey;
  
    const controller = new AbortController();
    const timeout = setTimeout(() => controller.abort(), 60000);
    try {
      const response = await fetch(url.toString(), {
        method: "GET",
        headers,
        signal: controller.signal,
      });
      const text = await response.text();
      let body: any;
      try {
        body = text ? JSON.parse(text) : null;
      } catch {
        body = text;
      }
      if (!response.ok) {
        const requestId =
          response.headers.get("x-request-id") || body?.meta?.requestId;
        const message =
          (body && (body.error?.message || body.error || body.message)) ||
          `HTTP ${response.status}`;
        throw new OxArchiveError(message, response.status, requestId ?? undefined);
      }
      if (body && typeof body === "object" && "data" in body) {
        return {
          data: body.data,
          nextCursor: body.meta?.nextCursor,
        };
      }
      return { data: body };
    } finally {
      clearTimeout(timeout);
    }
  }