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

# ApiMeta Schema

> Response metadata. Includes required fields, field types, schema references, and generated JSON details from the 0xArchive OpenAPI contract.

Source OpenAPI: 0xArchive API 1.8.0; 227 paths; 217 component schemas.

Response metadata

## Required Fields

No required fields are declared on this component schema.

## JSON Schema

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

## Components using this schema

* [ApiResponseOrderBook](/schemas/components/api-response-order-book)
* [ApiResponseOrderBookArray](/schemas/components/api-response-order-book-array)
* [ApiResponseTradeArray](/schemas/components/api-response-trade-array)
* [ApiResponseInstrument](/schemas/components/api-response-instrument)
* [ApiResponseInstrumentArray](/schemas/components/api-response-instrument-array)
* [ApiResponseLighterInstrument](/schemas/components/api-response-lighter-instrument)
* [ApiResponseLighterInstrumentArray](/schemas/components/api-response-lighter-instrument-array)
* [ApiResponseOpenInterest](/schemas/components/api-response-open-interest)
* [ApiResponseOpenInterestArray](/schemas/components/api-response-open-interest-array)
* [ApiResponseFundingRate](/schemas/components/api-response-funding-rate)
* [ApiResponseFundingRateArray](/schemas/components/api-response-funding-rate-array)
* [ApiResponseBreadthSnapshot](/schemas/components/api-response-breadth-snapshot)
* [ApiResponseBreadthSnapshotArray](/schemas/components/api-response-breadth-snapshot-array)
* [ApiResponseHip3Instrument](/schemas/components/api-response-hip3-instrument)
* [ApiResponseHip3InstrumentArray](/schemas/components/api-response-hip3-instrument-array)
* [ApiResponseHip4Outcome](/schemas/components/api-response-hip4-outcome)
* [ApiResponseHip4OutcomeArray](/schemas/components/api-response-hip4-outcome-array)
* [ApiResponseHip4OutcomeAggregate](/schemas/components/api-response-hip4-outcome-aggregate)
* [ApiResponseHip4OutcomeAggregateArray](/schemas/components/api-response-hip4-outcome-aggregate-array)
* [ApiResponseHip4OpenInterest](/schemas/components/api-response-hip4-open-interest)
* [ApiResponseHip4OpenInterestArray](/schemas/components/api-response-hip4-open-interest-array)
* [ApiResponseCoinFreshness](/schemas/components/api-response-coin-freshness)
* [ApiResponseCoinSummary](/schemas/components/api-response-coin-summary)
* [ApiResponseSpotPair](/schemas/components/api-response-spot-pair)
* [ApiResponseSpotPairArray](/schemas/components/api-response-spot-pair-array)
* [ApiResponseSpotFreshness](/schemas/components/api-response-spot-freshness)
* [ApiResponseSpotTwapArray](/schemas/components/api-response-spot-twap-array)
* [ApiResponseGenericArray](/schemas/components/api-response-generic-array)
* [ApiResponseL2OrderBookDiffArray](/schemas/components/api-response-l2-order-book-diff-array)
* [ApiResponseFullDepthL2OrderBook](/schemas/components/api-response-full-depth-l2-order-book)
* [ApiResponseFullDepthL2OrderBookArray](/schemas/components/api-response-full-depth-l2-order-book-array)
* [ApiResponseCvdBucketArray](/schemas/components/api-response-cvd-bucket-array)
* [ApiResponseLiquidationLevels](/schemas/components/api-response-liquidation-levels)
* [ApiResponseHip3OracleExternalPrice](/schemas/components/api-response-hip3-oracle-external-price)
* [ApiResponseHip3OracleDiscoveryBounds](/schemas/components/api-response-hip3-oracle-discovery-bounds)
* [ApiResponseHip4Question](/schemas/components/api-response-hip4-question)
* [ApiResponseHip4QuestionArray](/schemas/components/api-response-hip4-question-array)
* [ApiResponseWalletClassifyData](/schemas/components/api-response-wallet-classify-data)
* [ApiResponseLiquidationLevelsHistory](/schemas/components/api-response-liquidation-levels-history)
* [ApiResponseTriggerLevels](/schemas/components/api-response-trigger-levels)
* [ApiResponseTriggerLevelsHistory](/schemas/components/api-response-trigger-levels-history)
* [ApiResponseL4OrderBook](/schemas/components/api-response-l4-order-book)
* [ApiResponseL4OrderBookArray](/schemas/components/api-response-l4-order-book-array)
* [ApiResponseL3OrderBook](/schemas/components/api-response-l3-order-book)
* [ApiResponseL3OrderBookArray](/schemas/components/api-response-l3-order-book-array)
* [ApiResponsePositionsFreshnessArray](/schemas/components/api-response-positions-freshness-array)
* [ApiResponseTwapArray](/schemas/components/api-response-twap-array)
* [ApiResponseWalletProfile](/schemas/components/api-response-wallet-profile)
* [ApiResponseCapabilityArray](/schemas/components/api-response-capability-array)

## Referenced By

Use this shared schema with the generated component index and route-specific endpoint pages during implementation.

## Operations using this component transitively

* [`GET /v1/capabilities`](/schemas/operations/list-capabilities)
* [`GET /v1/data-quality/positions`](/schemas/operations/get-positions-freshness)
* [`GET /v1/hyperliquid/breadth/above-vwap`](/schemas/operations/get-breadth-above-vwap)
* [`GET /v1/hyperliquid/breadth/above-vwap/current`](/schemas/operations/get-breadth-above-vwap-current)
* [`GET /v1/hyperliquid/cvd/{symbol}`](/schemas/operations/get-hyperliquid-cvd)
* [`GET /v1/hyperliquid/freshness/{symbol}`](/schemas/operations/get-hyperliquid-freshness)
* [`GET /v1/hyperliquid/funding/{symbol}`](/schemas/operations/get-hyperliquid-funding-history)
* [`GET /v1/hyperliquid/funding/{symbol}/current`](/schemas/operations/get-current-hyperliquid-funding)
* [`GET /v1/hyperliquid/hip3/breadth/above-vwap`](/schemas/operations/get-hip3-breadth-above-vwap)
* [`GET /v1/hyperliquid/hip3/breadth/above-vwap/current`](/schemas/operations/get-hip3-breadth-above-vwap-current)
* [`GET /v1/hyperliquid/hip3/cvd/{symbol}`](/schemas/operations/get-hip3-cvd)
* [`GET /v1/hyperliquid/hip3/freshness/{symbol}`](/schemas/operations/get-hip3-freshness)
* [`GET /v1/hyperliquid/hip3/funding/{symbol}`](/schemas/operations/get-hip3-funding-history)
* [`GET /v1/hyperliquid/hip3/funding/{symbol}/current`](/schemas/operations/get-current-hip3-funding)
* [`GET /v1/hyperliquid/hip3/instruments`](/schemas/operations/list-hip3-instruments)
* [`GET /v1/hyperliquid/hip3/instruments/{symbol}`](/schemas/operations/get-hip3-instrument)
* [`GET /v1/hyperliquid/hip3/liquidations/{symbol}/levels`](/schemas/operations/get-hip3-liquidation-levels)
* [`GET /v1/hyperliquid/hip3/liquidations/{symbol}/levels/history`](/schemas/operations/get-hip3-liquidation-levels-history)
* [`GET /v1/hyperliquid/hip3/openinterest/{symbol}`](/schemas/operations/get-hip3-open-interest)
* [`GET /v1/hyperliquid/hip3/openinterest/{symbol}/current`](/schemas/operations/get-current-hip3-open-interest)
* [`GET /v1/hyperliquid/hip3/oracle/discovery-bounds/{symbol}`](/schemas/operations/get-hip3-oracle-discovery-bounds)
* [`GET /v1/hyperliquid/hip3/oracle/external-price/{symbol}`](/schemas/operations/get-hip3-oracle-external-price)
* [`GET /v1/hyperliquid/hip3/orderbook/{symbol}`](/schemas/operations/get-hip3-orderbook)
* [`GET /v1/hyperliquid/hip3/orderbook/{symbol}/history`](/schemas/operations/get-hip3-orderbook-history)
* [`GET /v1/hyperliquid/hip3/orderbook/{symbol}/l2`](/schemas/operations/get-hip3-full-depth-l2-orderbook)
* [`GET /v1/hyperliquid/hip3/orderbook/{symbol}/l2/diffs`](/schemas/operations/get-hip3-full-depth-l2-diffs)
* [`GET /v1/hyperliquid/hip3/orderbook/{symbol}/l2/history`](/schemas/operations/get-hip3-full-depth-l2-history)
* [`GET /v1/hyperliquid/hip3/orderbook/{symbol}/l4`](/schemas/operations/get-hip3-l4-orderbook)
* [`GET /v1/hyperliquid/hip3/orderbook/{symbol}/l4/history`](/schemas/operations/get-hip3-l4-history)
* [`GET /v1/hyperliquid/hip3/orders/{symbol}/trigger-levels`](/schemas/operations/get-hip3-trigger-levels)
* [`GET /v1/hyperliquid/hip3/orders/{symbol}/trigger-levels/history`](/schemas/operations/get-hip3-trigger-levels-history)
* [`GET /v1/hyperliquid/hip3/summary/{symbol}`](/schemas/operations/get-hip3-summary)
* [`GET /v1/hyperliquid/hip3/trades/{symbol}`](/schemas/operations/get-hip3-trades)
* [`GET /v1/hyperliquid/hip3/trades/{symbol}/recent`](/schemas/operations/get-hip3-recent-trades)
* [`GET /v1/hyperliquid/hip3/twap/{symbol}`](/schemas/operations/get-hip3-twap)
* [`GET /v1/hyperliquid/hip3/twap/user/{user}`](/schemas/operations/get-hip3-user-twap)
* [`GET /v1/hyperliquid/hip3/wallets/{address}/profile`](/schemas/operations/get-hip3-wallet-profile)
* [`GET /v1/hyperliquid/hip3/wallets/classify`](/schemas/operations/classify-hip3-wallets)
* [`GET /v1/hyperliquid/hip4/freshness/{symbol}`](/schemas/operations/get-hip4-freshness)
* [`GET /v1/hyperliquid/hip4/instruments`](/schemas/operations/list-hip4-instruments)
* [`GET /v1/hyperliquid/hip4/instruments/{symbol}`](/schemas/operations/get-hip4-instrument)
* [`GET /v1/hyperliquid/hip4/openinterest/{symbol}`](/schemas/operations/get-hip4-open-interest)
* [`GET /v1/hyperliquid/hip4/openinterest/{symbol}/current`](/schemas/operations/get-current-hip4-open-interest)
* [`GET /v1/hyperliquid/hip4/orderbook/{symbol}`](/schemas/operations/get-hip4-orderbook)
* [`GET /v1/hyperliquid/hip4/orderbook/{symbol}/history`](/schemas/operations/get-hip4-orderbook-history)
* [`GET /v1/hyperliquid/hip4/orderbook/{symbol}/l4`](/schemas/operations/get-hip4-l4-orderbook)
* [`GET /v1/hyperliquid/hip4/orderbook/{symbol}/l4/history`](/schemas/operations/get-hip4-l4-history)
* [`GET /v1/hyperliquid/hip4/outcomes`](/schemas/operations/list-hip4-outcomes)
* [`GET /v1/hyperliquid/hip4/outcomes/{outcome_id}`](/schemas/operations/get-hip4-outcome)
* [`GET /v1/hyperliquid/hip4/outcomes/by-slug/{slug}`](/schemas/operations/get-hip4-outcome-by-slug)
* [`GET /v1/hyperliquid/hip4/questions`](/schemas/operations/list-hip4-questions)
* [`GET /v1/hyperliquid/hip4/questions/{question_id}`](/schemas/operations/get-hip4-question)
* [`GET /v1/hyperliquid/hip4/summary/{symbol}`](/schemas/operations/get-hip4-summary)
* [`GET /v1/hyperliquid/hip4/trades/{symbol}`](/schemas/operations/get-hip4-trades)
* [`GET /v1/hyperliquid/hip4/trades/{symbol}/recent`](/schemas/operations/get-hip4-recent-trades)
* [`GET /v1/hyperliquid/hip4/twap/{symbol}`](/schemas/operations/get-hip4-twap)
* [`GET /v1/hyperliquid/hip4/twap/user/{user}`](/schemas/operations/get-hip4-user-twap)
* [`GET /v1/hyperliquid/instruments`](/schemas/operations/list-hyperliquid-instruments)
* [`GET /v1/hyperliquid/instruments/{symbol}`](/schemas/operations/get-hyperliquid-instrument)
* [`GET /v1/hyperliquid/liquidations/{symbol}/levels`](/schemas/operations/get-hyperliquid-liquidation-levels)
* [`GET /v1/hyperliquid/liquidations/{symbol}/levels/history`](/schemas/operations/get-hyperliquid-liquidation-levels-history)
* [`GET /v1/hyperliquid/openinterest/{symbol}`](/schemas/operations/get-hyperliquid-open-interest)
* [`GET /v1/hyperliquid/openinterest/{symbol}/current`](/schemas/operations/get-current-hyperliquid-open-interest)
* [`GET /v1/hyperliquid/orderbook/{symbol}`](/schemas/operations/get-hyperliquid-orderbook)
* [`GET /v1/hyperliquid/orderbook/{symbol}/history`](/schemas/operations/get-hyperliquid-orderbook-history)
* [`GET /v1/hyperliquid/orderbook/{symbol}/l2`](/schemas/operations/get-hyperliquid-full-depth-l2-orderbook)
* [`GET /v1/hyperliquid/orderbook/{symbol}/l2/diffs`](/schemas/operations/get-hyperliquid-full-depth-l2-diffs)
* [`GET /v1/hyperliquid/orderbook/{symbol}/l2/history`](/schemas/operations/get-hyperliquid-full-depth-l2-history)
* [`GET /v1/hyperliquid/orderbook/{symbol}/l4`](/schemas/operations/get-hyperliquid-l4-orderbook)
* [`GET /v1/hyperliquid/orderbook/{symbol}/l4/history`](/schemas/operations/get-hyperliquid-l4-history)
* [`GET /v1/hyperliquid/orders/{symbol}/trigger-levels`](/schemas/operations/get-hyperliquid-trigger-levels)
* [`GET /v1/hyperliquid/orders/{symbol}/trigger-levels/history`](/schemas/operations/get-hyperliquid-trigger-levels-history)
* [`GET /v1/hyperliquid/spot/freshness/{symbol}`](/schemas/operations/get-hyperliquid-spot-freshness)
* [`GET /v1/hyperliquid/spot/orderbook/{symbol}`](/schemas/operations/get-hyperliquid-spot-orderbook)
* [`GET /v1/hyperliquid/spot/orderbook/{symbol}/history`](/schemas/operations/get-hyperliquid-spot-orderbook-history)
* [`GET /v1/hyperliquid/spot/orderbook/{symbol}/l4`](/schemas/operations/get-hyperliquid-spot-l4-orderbook)
* [`GET /v1/hyperliquid/spot/orderbook/{symbol}/l4/history`](/schemas/operations/get-hyperliquid-spot-l4-history)
* [`GET /v1/hyperliquid/spot/pairs`](/schemas/operations/get-hyperliquid-spot-pairs)
* [`GET /v1/hyperliquid/spot/pairs/{symbol}`](/schemas/operations/get-hyperliquid-spot-pair)
* [`GET /v1/hyperliquid/spot/trades/{symbol}`](/schemas/operations/get-hyperliquid-spot-trades)
* [`GET /v1/hyperliquid/spot/trades/{symbol}/recent`](/schemas/operations/get-spot-trades-recent)
* [`GET /v1/hyperliquid/spot/twap/{symbol}`](/schemas/operations/get-hyperliquid-spot-twap)
* [`GET /v1/hyperliquid/spot/twap/user/{user}`](/schemas/operations/get-hyperliquid-spot-user-twap)
* [`GET /v1/hyperliquid/summary/{symbol}`](/schemas/operations/get-hyperliquid-summary)
* [`GET /v1/hyperliquid/trades/{symbol}`](/schemas/operations/get-hyperliquid-trades)
* [`GET /v1/hyperliquid/twap/{symbol}`](/schemas/operations/get-hyperliquid-twap)
* [`GET /v1/hyperliquid/twap/user/{user}`](/schemas/operations/get-hyperliquid-user-twap)
* [`GET /v1/hyperliquid/wallets/{address}/profile`](/schemas/operations/get-hyperliquid-wallet-profile)
* [`GET /v1/hyperliquid/wallets/classify`](/schemas/operations/classify-hyperliquid-wallets)
* [`GET /v1/lighter/freshness/{symbol}`](/schemas/operations/get-lighter-freshness)
* [`GET /v1/lighter/funding/{symbol}`](/schemas/operations/get-lighter-funding-history)
* [`GET /v1/lighter/funding/{symbol}/current`](/schemas/operations/get-current-lighter-funding)
* [`GET /v1/lighter/instruments`](/schemas/operations/list-lighter-instruments)
* [`GET /v1/lighter/instruments/{symbol}`](/schemas/operations/get-lighter-instrument)
* [`GET /v1/lighter/l3orderbook/{symbol}`](/schemas/operations/get-lighter-l3-orderbook)
* [`GET /v1/lighter/l3orderbook/{symbol}/history`](/schemas/operations/get-lighter-l3-orderbook-history)
* [`GET /v1/lighter/openinterest/{symbol}`](/schemas/operations/get-lighter-open-interest)
* [`GET /v1/lighter/openinterest/{symbol}/current`](/schemas/operations/get-current-lighter-open-interest)
* [`GET /v1/lighter/orderbook/{symbol}`](/schemas/operations/get-lighter-orderbook)
* [`GET /v1/lighter/orderbook/{symbol}/history`](/schemas/operations/get-lighter-orderbook-history)
* [`GET /v1/lighter/summary/{symbol}`](/schemas/operations/get-lighter-summary)
* [`GET /v1/rh-lighter/freshness/{symbol}`](/schemas/operations/get-rh-lighter-freshness)
* [`GET /v1/rh-lighter/funding/{symbol}`](/schemas/operations/get-rh-lighter-funding-history)
* [`GET /v1/rh-lighter/funding/{symbol}/current`](/schemas/operations/get-current-rh-lighter-funding)
* [`GET /v1/rh-lighter/instruments`](/schemas/operations/list-rh-lighter-instruments)
* [`GET /v1/rh-lighter/instruments/{symbol}`](/schemas/operations/get-rh-lighter-instrument)
* [`GET /v1/rh-lighter/openinterest/{symbol}`](/schemas/operations/get-rh-lighter-open-interest)
* [`GET /v1/rh-lighter/openinterest/{symbol}/current`](/schemas/operations/get-current-rh-lighter-open-interest)
* [`GET /v1/rh-lighter/orderbook/{symbol}`](/schemas/operations/get-rh-lighter-orderbook)
* [`GET /v1/rh-lighter/orderbook/{symbol}/history`](/schemas/operations/get-rh-lighter-orderbook-history)
* [`GET /v1/rh-lighter/summary/{symbol}`](/schemas/operations/get-rh-lighter-summary)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.