ApiResponseCoinFreshness Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ApiResponseCoinFreshness",
  "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": "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. Currently used when the requested window ends before coverage begins for the symbol; 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
    }
  }
}