ApiMeta Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ApiMeta",
  "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"
    },
    "has_more": {
      "description": "Present on cursor-paged routes: true when another page exists. `next_cursor` is present exactly when it is true.",
      "type": "boolean"
    },
    "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"
    },
    "symbol": {
      "description": "Present on per-symbol routes: the symbol the response covers.",
      "type": "string"
    },
    "venue": {
      "description": "Present on per-symbol routes: the venue the response covers, for example `hyperliquid` or `hip3`.",
      "type": "string"
    }
  }
}