get_hip4_open_interest_current

Instructions

Implementation Reference

• src/index.ts:1718-1729 (handler)

  Handler for the get_hip4_open_interest_current tool. Calls the REST API endpoint /openinterest/{coin}/current via the hip4Request helper, passing the normalized coin symbol, and returns the latest OI row.

  registerTool(
    "get_hip4_open_interest_current",
    "Get the current HIP-4 per-side open interest for a coin (e.g. '0'). Bare numeric coins are canonical; legacy '#0' / '%230' forms are also accepted.Returns the latest OI row; mark_price is an implied probability (0..1). For paired-set / display OI use get_hip4_outcome.",
    { coin: Hip4CoinParam },
    ObjectOutputSchema,
    async (params) => {
      const result = await hip4Request(
        `/openinterest/${normalizeHip4Coin(params.coin)}/current`
      );
      return formatResponse(result.data);
    }
  );

• src/index.ts:1721-1721 (schema)

  Input schema: requires a single 'coin' parameter validated by Hip4CoinParam (a Zod string accepting bare numeric, '#N', or '%23N' forms).

  { coin: Hip4CoinParam },

• src/index.ts:1718-1729 (registration)

  Registration via registerTool() with name 'get_hip4_open_interest_current', description, input schema, ObjectOutputSchema, and handler.

  registerTool(
    "get_hip4_open_interest_current",
    "Get the current HIP-4 per-side open interest for a coin (e.g. '0'). Bare numeric coins are canonical; legacy '#0' / '%230' forms are also accepted.Returns the latest OI row; mark_price is an implied probability (0..1). For paired-set / display OI use get_hip4_outcome.",
    { coin: Hip4CoinParam },
    ObjectOutputSchema,
    async (params) => {
      const result = await hip4Request(
        `/openinterest/${normalizeHip4Coin(params.coin)}/current`
      );
      return formatResponse(result.data);
    }
  );

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

  HIP-4 REST API helper used by the handler to make authenticated GET requests to the 0xArchive API.

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

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

  Coin normalization helper that converts HIP-4 coin symbols (bare numeric, '#N', '%23N') to canonical form used in API paths.

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