Get HIP-4 data freshness JSON Schema

Source OpenAPI: 0xArchive API 1.7.0; 218 paths; 210 component schemas. Check when HIP-4 order book, trade, and outcome-side open-interest data was last updated. The shared freshness envelope can describe funding and liquidations for other families; those buckets are omitted for HIP-4 because HIP-4 has no funding dataset or liquidation endpoint.

Route Metadata

Field	Value
Method	`GET`
Path	`/v1/hyperliquid/hip4/freshness/{symbol}`
operationId	`getHip4Freshness`
Tag	HIP-4 Outcomes - Convenience
Family	HIP-4
Deprecated or legacy	no

Request Parameters

Path Parameters

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip4Freshness path parameters",
  "type": "object",
  "required": [
    "symbol"
  ],
  "properties": {
    "symbol": {
      "description": "HIP-4 coin id (e.g., `0` for outcome 0 Yes side, `1` for No side). The `#`-prefixed form (`#0`, `#1`) is also accepted.",
      "type": "string",
      "example": "0",
      "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": "getHip4Freshness response 200",
  "description": "API response wrapping coin freshness data",
  "type": "object",
  "properties": {
    "data": {
      "description": "Shared route-family freshness shape. Unsupported data-type buckets may be omitted; consult the operation description for each family.",
      "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": "Venue-family key recognized by this route, such as `hyperliquid`.",
          "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"
        },
        "coverage_from": {
          "description": "Earliest coverage for the requested symbol and data type. Present only when the requested window ends before coverage begins.",
          "type": "string",
          "format": "date-time"
        },
        "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
        },
        "notice": {
          "description": "Human-readable advisory about the response. Used when the requested window ends before coverage begins for the symbol, and on CVD responses that are one page of several; may carry other advisories in future.",
          "type": "string"
        },
        "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": "getHip4Freshness response 400",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    }
  }
}

OpenAPI example

{
  "code": 400,
  "error": "Failed to deserialize query string: limit: invalid digit found in string",
  "error_code": "invalid_query_params",
  "request_id": "3f2a9c71-5b0e-4d68-9a4c-7e1d2b6f8a05"
}

Status 401

Authentication required

application/json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip4Freshness response 401",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    }
  }
}

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": "getHip4Freshness response 429",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    }
  }
}

OpenAPI example

{
  "code": 429,
  "error": "Rate limit exceeded"
}

API reference

SDKs & tooling

AI & agents

Get HIP-4 data freshness JSON Schema

Route Metadata

Request Parameters

Path Parameters

Response Contracts

Status 200

application/json

Status 400

application/json

OpenAPI example

Status 401

application/json

OpenAPI example

Status 429

application/json

OpenAPI example

​Route Metadata

​Request Parameters

​Path Parameters

​Response Contracts

​Status 200

​application/json

​Status 400

​application/json

OpenAPI example

​Status 401

​application/json

OpenAPI example

​Status 429

​application/json

OpenAPI example

Route Metadata

Request Parameters

Path Parameters

Response Contracts

Status 200

application/json

Status 400

application/json

Status 401

application/json

Status 429

application/json