> ## 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.

# Get HIP-3 data freshness JSON Schema

> Get HIP-3 data freshness JSON Schema contract. Includes route metadata, request parameters, response statuses, examples, and JSON fields for implementation.

Source OpenAPI: 0xArchive API 1.5.0; 140 paths; 119 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

| Field                | Value                                     |
| -------------------- | ----------------------------------------- |
| Method               | `GET`                                     |
| Path                 | `/v1/hyperliquid/hip3/freshness/{symbol}` |
| operationId          | `getHip3Freshness`                        |
| Tag                  | HIP-3 Builder Perps - Convenience         |
| Family               | HIP-3                                     |
| Deprecated or legacy | no                                        |

## Request Parameters

### Path Parameters

```json theme={"theme":"github-dark"}
{
  "$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

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "getHip3Freshness response 200",
  "description": "API response wrapping HIP-3 coin freshness data.",
  "type": "object",
  "properties": {
    "data": {
      "description": "Data freshness for all data types for a specific HIP-3 builder-perp symbol.",
      "type": "object",
      "required": [
        "coin",
        "exchange",
        "measured_at",
        "symbol"
      ],
      "properties": {
        "coin": {
          "description": "HIP-3 builder-perp symbol (deprecated, use symbol instead).",
          "type": "string",
          "deprecated": true,
          "example": "km:US500"
        },
        "exchange": {
          "description": "Venue-family key for HIP-3 builder perps.",
          "type": "string",
          "example": "hip3"
        },
        "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-05-27T01:41:51.111819220Z"
        },
        "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": "HIP-3 builder-perp symbol. Case-sensitive; keep the builder prefix intact.",
          "type": "string",
          "example": "km:US500"
        },
        "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
    }
  }
}
```

##### OpenAPI example: hip3Freshness

```json theme={"theme":"github-dark"}
{
  "success": true,
  "data": {
    "symbol": "km:US500",
    "coin": "km:US500",
    "exchange": "hip3",
    "measured_at": "2026-05-27T01:41:51.111819220Z",
    "orderbook": {
      "lag_ms": 881,
      "last_updated": "2026-05-27T01:41:50.230Z"
    },
    "trades": {
      "lag_ms": 43098,
      "last_updated": "2026-05-27T01:41:08.013Z"
    },
    "funding": {
      "lag_ms": 627,
      "last_updated": "2026-05-27T01:41:50.485Z"
    },
    "open_interest": {
      "lag_ms": 627,
      "last_updated": "2026-05-27T01:41:50.485Z"
    },
    "liquidations": {
      "lag_ms": null,
      "last_updated": null
    }
  },
  "meta": {
    "count": 1,
    "request_id": "00000000-0000-4000-8000-000000000000"
  }
}
```

### Status 400

Invalid request

#### application/json

```json theme={"theme":"github-dark"}
{
  "$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

```json theme={"theme":"github-dark"}
{
  "code": 400,
  "error": "Invalid request parameters"
}
```

### Status 401

Authentication required

#### application/json

```json theme={"theme":"github-dark"}
{
  "$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

```json theme={"theme":"github-dark"}
{
  "code": 401,
  "error": "Missing or invalid API key. Provide X-API-Key header."
}
```

### Status 429

Rate limit exceeded

#### application/json

```json theme={"theme":"github-dark"}
{
  "$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

```json theme={"theme":"github-dark"}
{
  "code": 429,
  "error": "Rate limit exceeded"
}
```