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. Check when data was last updated for each data type for a specific HIP-3 coin. Coin names are case-sensitive.

​
Route Metadata

FieldValue
MethodGET
Path/v1/hyperliquid/hip3/freshness/{symbol}
operationIdgetHip3Freshness
TagHIP-3 Builder Perps - Convenience
FamilyHIP-3
Deprecated or legacyno

​
Request Parameters

​
Path Parameters

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

​
Response Contracts

​
Status 200

Data freshness for the coin

​
application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3Freshness response 200",
  "description": "API response wrapping coin freshness data",
  "type": "object",
  "properties": {
    "data": {
      "description": "Data freshness for all data types for a specific coin",
      "type": "object",
      "required": [
        "coin",
        "exchange",
        "measured_at",
        "symbol"
      ],
      "properties": {
        "coin": {
          "description": "Trading pair symbol (deprecated, use symbol instead)",
          "type": "string",
          "deprecated": true,
          "example": "BTC"
        },
        "exchange": {
          "description": "Exchange name",
          "type": "string",
          "example": "hyperliquid"
        },
        "funding": {
          "description": "Freshness information for a single data type",
          "type": "object",
          "properties": {
            "lag_ms": {
              "description": "Current lag in milliseconds between now and last update",
              "type": "integer",
              "nullable": true,
              "example": 1200
            },
            "last_updated": {
              "description": "When this data type was last updated for the coin",
              "type": "string",
              "format": "date-time",
              "nullable": true,
              "example": "2026-02-23T12:00:00.000Z"
            }
          }
        },
        "liquidations": {
          "description": "Freshness information for a single data type",
          "type": "object",
          "properties": {
            "lag_ms": {
              "description": "Current lag in milliseconds between now and last update",
              "type": "integer",
              "nullable": true,
              "example": 1200
            },
            "last_updated": {
              "description": "When this data type was last updated for the coin",
              "type": "string",
              "format": "date-time",
              "nullable": true,
              "example": "2026-02-23T12:00:00.000Z"
            }
          }
        },
        "measured_at": {
          "description": "When the freshness was measured",
          "type": "string",
          "format": "date-time",
          "example": "2026-02-23T12:00:00.000Z"
        },
        "open_interest": {
          "description": "Freshness information for a single data type",
          "type": "object",
          "properties": {
            "lag_ms": {
              "description": "Current lag in milliseconds between now and last update",
              "type": "integer",
              "nullable": true,
              "example": 1200
            },
            "last_updated": {
              "description": "When this data type was last updated for the coin",
              "type": "string",
              "format": "date-time",
              "nullable": true,
              "example": "2026-02-23T12:00:00.000Z"
            }
          }
        },
        "orderbook": {
          "description": "Freshness information for a single data type",
          "type": "object",
          "properties": {
            "lag_ms": {
              "description": "Current lag in milliseconds between now and last update",
              "type": "integer",
              "nullable": true,
              "example": 1200
            },
            "last_updated": {
              "description": "When this data type was last updated for the coin",
              "type": "string",
              "format": "date-time",
              "nullable": true,
              "example": "2026-02-23T12:00:00.000Z"
            }
          }
        },
        "symbol": {
          "description": "Trading pair symbol",
          "type": "string",
          "example": "BTC"
        },
        "trades": {
          "description": "Freshness information for a single data type",
          "type": "object",
          "properties": {
            "lag_ms": {
              "description": "Current lag in milliseconds between now and last update",
              "type": "integer",
              "nullable": true,
              "example": 1200
            },
            "last_updated": {
              "description": "When this data type was last updated for the coin",
              "type": "string",
              "format": "date-time",
              "nullable": true,
              "example": "2026-02-23T12:00: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": "getHip3Freshness 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": "getHip3Freshness 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 429

Rate limit exceeded

​
application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3Freshness 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