Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.0xarchive.io/llms.txt

Use this file to discover all available pages before exploring further.

Source OpenAPI: 0xArchive API 1.5.0; 116 paths; 90 component schemas. Get the latest open interest value for a HIP-3 Builder Perps coin. Data available from February 2026. No tier restriction.

​
Route Metadata

FieldValue
MethodGET
Path/v1/hyperliquid/hip3/openinterest/{symbol}/current
operationIdgetCurrentHip3OpenInterest
TagHIP-3 Builder Perps - Open Interest
FamilyHIP-3
Deprecated or legacyno

​
Request Parameters

​
Path Parameters

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getCurrentHip3OpenInterest path parameters",
  "type": "object",
  "required": [
    "symbol"
  ],
  "properties": {
    "symbol": {
      "description": "Trading pair symbol (e.g., km:US500, xyz:XYZ100). HIP-3 symbols are case-sensitive.",
      "type": "string",
      "example": "xyz:XYZ100",
      "x-parameter-location": "path"
    }
  }
}

​
Response Contracts

​
Status 200

Current open interest

​
application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getCurrentHip3OpenInterest response 200",
  "type": "object",
  "properties": {
    "data": {
      "description": "Open interest snapshot with market context",
      "type": "object",
      "required": [
        "coin",
        "open_interest",
        "symbol",
        "timestamp"
      ],
      "properties": {
        "coin": {
          "description": "Trading pair symbol (deprecated, use symbol instead)",
          "type": "string",
          "deprecated": true,
          "example": "BTC"
        },
        "day_ntl_volume": {
          "description": "24-hour notional volume",
          "type": "string",
          "nullable": true,
          "example": "10000000.00"
        },
        "impact_ask_price": {
          "description": "Impact ask price for liquidations",
          "type": "string",
          "nullable": true
        },
        "impact_bid_price": {
          "description": "Impact bid price for liquidations",
          "type": "string",
          "nullable": true
        },
        "mark_price": {
          "description": "Mark price used for liquidations",
          "type": "string",
          "nullable": true,
          "example": "42500.50"
        },
        "mid_price": {
          "description": "Current mid price",
          "type": "string",
          "nullable": true,
          "example": "42500.75"
        },
        "open_interest": {
          "description": "Total open interest in contracts",
          "type": "string",
          "example": "500000.00"
        },
        "oracle_price": {
          "description": "Oracle price from external feed",
          "type": "string",
          "nullable": true,
          "example": "42498.25"
        },
        "prev_day_price": {
          "description": "Price 24 hours ago",
          "type": "string",
          "nullable": true,
          "example": "42000.00"
        },
        "symbol": {
          "description": "Trading pair symbol",
          "type": "string",
          "example": "BTC"
        },
        "timestamp": {
          "description": "Snapshot timestamp (UTC)",
          "type": "string",
          "format": "date-time",
          "example": "2025-01-21T10:30:00.000Z"
        }
      }
    },
    "meta": {
      "description": "Response metadata",
      "type": "object",
      "properties": {
        "count": {
          "description": "Number of records returned",
          "type": "integer"
        },
        "next_cursor": {
          "description": "Cursor for pagination (timestamp). Use this value as the `cursor` parameter to fetch the next page of results.",
          "type": "string",
          "nullable": true
        },
        "request_id": {
          "description": "Unique request ID for support",
          "type": "string",
          "format": "uuid"
        }
      }
    },
    "success": {
      "type": "boolean",
      "example": true
    }
  }
}

​
Status 400

Invalid request

​
application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getCurrentHip3OpenInterest response 400",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}
OpenAPI example
{
  "code": 400,
  "error": "Invalid request parameters"
}

​
Status 401

Authentication required

​
application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getCurrentHip3OpenInterest response 401",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}
OpenAPI example
{
  "code": 401,
  "error": "Missing or invalid API key. Provide X-API-Key header."
}

​
Status 404

Resource not found

​
application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getCurrentHip3OpenInterest response 404",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}
OpenAPI example
{
  "code": 404,
  "error": "Resource not found"
}

​
Status 429

Rate limit exceeded

​
application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getCurrentHip3OpenInterest response 429",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    }
  }
}
OpenAPI example
{
  "code": 429,
  "error": "Rate limit exceeded"
}
Last modified on May 18, 2026