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

# Component Schemas

> Generated JSON Schema index for every OpenAPI component schema, including field types, references, and response envelope contracts.

Source OpenAPI: 0xArchive API 1.5.0; 140 paths; 119 component schemas.

Use this index when you need the fields, required keys, and shared response envelopes behind a route. Open a linked schema for the JSON shape, or use Endpoint Reference for the full request and response page.

| Schema                                                                                                  | Family           | Referenced by | Description                                                                                                                                         |
| ------------------------------------------------------------------------------------------------------- | ---------------- | ------------: | --------------------------------------------------------------------------------------------------------------------------------------------------- |
| [ApiLatency](/schemas/components/api-latency)                                                           | Shared           |             0 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [ApiMeta](/schemas/components/api-meta)                                                                 | Shared           |             0 | Response metadata                                                                                                                                   |
| [ApiResponseCandleArray](/schemas/components/api-response-candle-array)                                 | HIP-3            |             5 | API response containing an array of candle data                                                                                                     |
| [ApiResponseCoinFreshness](/schemas/components/api-response-coin-freshness)                             | HIP-4            |             3 | API response wrapping coin freshness data                                                                                                           |
| [ApiResponseCoinSummary](/schemas/components/api-response-coin-summary)                                 | HIP-3            |             4 | API response wrapping a market summary                                                                                                              |
| [ApiResponseCvdBucketArray](/schemas/components/api-response-cvd-bucket-array)                          | HIP-3            |             2 | API response containing CVD buckets.                                                                                                                |
| [ApiResponseFullDepthL2OrderBook](/schemas/components/api-response-full-depth-l2-order-book)            | HIP-3            |             2 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [ApiResponseFullDepthL2OrderBookArray](/schemas/components/api-response-full-depth-l2-order-book-array) | HIP-3            |             2 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [ApiResponseFundingRate](/schemas/components/api-response-funding-rate)                                 | HIP-3            |             4 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [ApiResponseFundingRateArray](/schemas/components/api-response-funding-rate-array)                      | HIP-3            |             4 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [ApiResponseGenericArray](/schemas/components/api-response-generic-array)                               | Shared           |             0 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [ApiResponseHip3CoinFreshness](/schemas/components/api-response-hip3-coin-freshness)                    | HIP-3            |             1 | API response wrapping HIP-3 coin freshness data.                                                                                                    |
| [ApiResponseHip3Instrument](/schemas/components/api-response-hip3-instrument)                           | HIP-3            |             1 | API response wrapping a single HIP-3 instrument                                                                                                     |
| [ApiResponseHip3InstrumentArray](/schemas/components/api-response-hip3-instrument-array)                | HIP-3            |             1 | API response wrapping an array of HIP-3 instruments                                                                                                 |
| [ApiResponseHip3OracleDiscoveryBounds](/schemas/components/api-response-hip3-oracle-discovery-bounds)   | HIP-3            |             1 | API response containing HIP-3 oracle discovery bounds.                                                                                              |
| [ApiResponseHip3OracleExternalPrice](/schemas/components/api-response-hip3-oracle-external-price)       | HIP-3            |             1 | API response containing HIP-3 oracle external price data.                                                                                           |
| [ApiResponseHip4OpenInterest](/schemas/components/api-response-hip4-open-interest)                      | HIP-4            |             1 | API response wrapping a single HIP-4 per-side open-interest record                                                                                  |
| [ApiResponseHip4OpenInterestArray](/schemas/components/api-response-hip4-open-interest-array)           | HIP-4            |             1 | API response wrapping an array of HIP-4 per-side open-interest records                                                                              |
| [ApiResponseHip4Outcome](/schemas/components/api-response-hip4-outcome)                                 | HIP-4            |             1 | API response wrapping a single HIP-4 per-side instrument                                                                                            |
| [ApiResponseHip4OutcomeAggregate](/schemas/components/api-response-hip4-outcome-aggregate)              | HIP-4            |             2 | API response wrapping a single HIP-4 outcome aggregate (with `aggregated_oi` populated on the detail endpoint)                                      |
| [ApiResponseHip4OutcomeAggregateArray](/schemas/components/api-response-hip4-outcome-aggregate-array)   | HIP-4            |             1 | API response wrapping an array of HIP-4 outcome aggregates (without `aggregated_oi`; use `/outcomes/&#123;outcome_id&#125;` for the detail variant) |
| [ApiResponseHip4OutcomeArray](/schemas/components/api-response-hip4-outcome-array)                      | HIP-4            |             1 | API response wrapping an array of HIP-4 per-side instruments                                                                                        |
| [ApiResponseHip4Question](/schemas/components/api-response-hip4-question)                               | HIP-4            |             1 | API response containing one HIP-4 question.                                                                                                         |
| [ApiResponseHip4QuestionArray](/schemas/components/api-response-hip4-question-array)                    | HIP-4            |             1 | API response containing HIP-4 questions.                                                                                                            |
| [ApiResponseInstrument](/schemas/components/api-response-instrument)                                    | Hyperliquid Core |             2 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [ApiResponseInstrumentArray](/schemas/components/api-response-instrument-array)                         | Hyperliquid Core |             2 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [ApiResponseL2OrderBookDiffArray](/schemas/components/api-response-l2-order-book-diff-array)            | HIP-3            |             2 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [ApiResponseLighterInstrument](/schemas/components/api-response-lighter-instrument)                     | Lighter          |             1 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [ApiResponseLighterInstrumentArray](/schemas/components/api-response-lighter-instrument-array)          | Lighter          |             1 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [ApiResponseLiquidationArray](/schemas/components/api-response-liquidation-array)                       | Hyperliquid Core |             4 | API response containing an array of liquidation events                                                                                              |
| [ApiResponseLiquidationLevels](/schemas/components/api-response-liquidation-levels)                     | HIP-3            |             2 | API response containing liquidation level buckets.                                                                                                  |
| [ApiResponseLiquidationVolumeArray](/schemas/components/api-response-liquidation-volume-array)          | HIP-3            |             3 | API response containing an array of aggregated liquidation volumes                                                                                  |
| [ApiResponseOpenInterest](/schemas/components/api-response-open-interest)                               | HIP-3            |             4 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [ApiResponseOpenInterestArray](/schemas/components/api-response-open-interest-array)                    | HIP-3            |             4 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [ApiResponseOrderBook](/schemas/components/api-response-order-book)                                     | HIP-3            |             6 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [ApiResponseOrderBookArray](/schemas/components/api-response-order-book-array)                          | HIP-3            |             6 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [ApiResponsePriceSnapshotArray](/schemas/components/api-response-price-snapshot-array)                  | HIP-3            |             4 | API response containing an array of price snapshots                                                                                                 |
| [ApiResponseSpotFreshness](/schemas/components/api-response-spot-freshness)                             | Hyperliquid Spot |             1 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [ApiResponseSpotPair](/schemas/components/api-response-spot-pair)                                       | Hyperliquid Spot |             1 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [ApiResponseSpotPairArray](/schemas/components/api-response-spot-pair-array)                            | Hyperliquid Spot |             1 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [ApiResponseSpotTwapArray](/schemas/components/api-response-spot-twap-array)                            | Hyperliquid Spot |             2 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [ApiResponseTradeArray](/schemas/components/api-response-trade-array)                                   | HIP-3            |            10 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [ApiResponseWalletClassifyData](/schemas/components/api-response-wallet-classify-data)                  | HIP-3            |             2 | API response containing bulk wallet classification results.                                                                                         |
| [Candle](/schemas/components/candle)                                                                    | Shared           |             0 | OHLCV candle data                                                                                                                                   |
| [ClassifiedWallet](/schemas/components/classified-wallet)                                               | Shared           |             0 | Wallet plus its precomputed behavior metrics.                                                                                                       |
| [CoinFreshness](/schemas/components/coin-freshness)                                                     | Shared           |             0 | Data freshness for all data types for a specific coin                                                                                               |
| [CoinSummary](/schemas/components/coin-summary)                                                         | Shared           |             0 | Combined market summary including price, funding, OI, volume, and liquidation data                                                                  |
| [CompletenessMetrics](/schemas/components/completeness-metrics)                                         | Shared           |             0 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [CoverageGap](/schemas/components/coverage-gap)                                                         | Shared           |             0 | A gap in data coverage                                                                                                                              |
| [CoverageResponse](/schemas/components/coverage-response)                                               | Data Quality     |             2 | Overall coverage response                                                                                                                           |
| [CvdBucket](/schemas/components/cvd-bucket)                                                             | Shared           |             0 | Cumulative volume delta bucket.                                                                                                                     |
| [DataCadence](/schemas/components/data-cadence)                                                         | Shared           |             0 | Empirical data cadence measurement based on last 7 days of data                                                                                     |
| [DataFreshness](/schemas/components/data-freshness)                                                     | Shared           |             0 | Data freshness metrics                                                                                                                              |
| [DataTypeCoverage](/schemas/components/data-type-coverage)                                              | Shared           |             0 | Coverage for a data type                                                                                                                            |
| [DataTypeFreshness](/schemas/components/data-type-freshness)                                            | Shared           |             0 | Freshness information for a single data type                                                                                                        |
| [DataTypeStatus](/schemas/components/data-type-status)                                                  | Shared           |             0 | Status of a data type                                                                                                                               |
| [Error](/schemas/components/error)                                                                      | Shared           |             0 | Error response                                                                                                                                      |
| [ExchangeCoverageResponse](/schemas/components/exchange-coverage-response)                              | Data Quality     |             1 | Coverage for one supported venue-family key.                                                                                                        |
| [ExchangeLatency](/schemas/components/exchange-latency)                                                 | Shared           |             0 | Latency metrics for one supported venue-family key.                                                                                                 |
| [ExchangeStatus](/schemas/components/exchange-status)                                                   | Shared           |             0 | Status for one supported venue-family key.                                                                                                          |
| [FullDepthL2OrderBook](/schemas/components/full-depth-l2-order-book)                                    | Shared           |             0 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [FundingRate](/schemas/components/funding-rate)                                                         | Shared           |             0 | Funding rate record                                                                                                                                 |
| [Hip3CoinFreshness](/schemas/components/hip3-coin-freshness)                                            | Shared           |             0 | Data freshness for all data types for a specific HIP-3 builder-perp symbol.                                                                         |
| [Hip3Instrument](/schemas/components/hip3-instrument)                                                   | Shared           |             0 | HIP-3 Builder Perps instrument with latest market data.                                                                                             |
| [Hip3OracleDiscoveryBounds](/schemas/components/hip3-oracle-discovery-bounds)                           | Shared           |             0 | Instantaneous HIP-3 discovery bounds derived from the current reference price and max leverage.                                                     |
| [Hip3OracleExternalPrice](/schemas/components/hip3-oracle-external-price)                               | Shared           |             0 | Latest deployer-pushed external and mark price for a HIP-3 market.                                                                                  |
| [Hip4AggregatedOi](/schemas/components/hip4-aggregated-oi)                                              | Shared           |             0 | Derived OI display fields combining both sides of a HIP-4 outcome.                                                                                  |
| [Hip4OpenInterestRecord](/schemas/components/hip4-open-interest-record)                                 | Shared           |             0 | HIP-4 per-side open-interest record.                                                                                                                |
| [Hip4Outcome](/schemas/components/hip4-outcome)                                                         | Shared           |             0 | HIP-4 per-side instrument metadata.                                                                                                                 |
| [Hip4OutcomeAggregate](/schemas/components/hip4-outcome-aggregate)                                      | Shared           |             0 | Per-outcome aggregate (both sides combined).                                                                                                        |
| [Hip4Question](/schemas/components/hip4-question)                                                       | Shared           |             0 | HIP-4 question grouping for one or more outcome markets.                                                                                            |
| [Hip4SideSpec](/schemas/components/hip4-side-spec)                                                      | Shared           |             0 | Per-side spec nested in `Hip4OutcomeAggregate.side_specs`.                                                                                          |
| [Incident](/schemas/components/incident)                                                                | Data Quality     |             1 | Data quality incident                                                                                                                               |
| [IncidentsResponse](/schemas/components/incidents-response)                                             | Data Quality     |             1 | Incidents list response                                                                                                                             |
| [Instrument](/schemas/components/instrument)                                                            | Shared           |             0 | Trading instrument specification (Hyperliquid)                                                                                                      |
| [L2OrderBookDiff](/schemas/components/l2-order-book-diff)                                               | Shared           |             0 | Full-depth L2 aggregate diff event derived from L4 deltas                                                                                           |
| [LatencyResponse](/schemas/components/latency-response)                                                 | Data Quality     |             1 | Latency metrics response                                                                                                                            |
| [LighterInstrument](/schemas/components/lighter-instrument)                                             | Shared           |             0 | Trading instrument specification (Lighter.xyz).                                                                                                     |
| [Liquidation](/schemas/components/liquidation)                                                          | Shared           |             0 | Liquidation event                                                                                                                                   |
| [LiquidationLevel](/schemas/components/liquidation-level)                                               | Shared           |             0 | Aggregated trigger-order level near the current mark/mid price.                                                                                     |
| [LiquidationLevelsData](/schemas/components/liquidation-levels-data)                                    | Shared           |             0 | Liquidation/trigger-order levels response body.                                                                                                     |
| [LiquidationVolume](/schemas/components/liquidation-volume)                                             | Shared           |             0 | Aggregated liquidation volume for a time bucket                                                                                                     |
| [OpenInterest](/schemas/components/open-interest)                                                       | Shared           |             0 | Open interest snapshot with market context                                                                                                          |
| [OrderBook](/schemas/components/order-book)                                                             | Shared           |             0 | L2 order book snapshot                                                                                                                              |
| [OrderbookDelta](/schemas/components/orderbook-delta)                                                   | Shared           |             0 | Incremental orderbook change (used with tick-level data)                                                                                            |
| [Pagination](/schemas/components/pagination)                                                            | Shared           |             0 | Pagination info                                                                                                                                     |
| [PriceLevel](/schemas/components/price-level)                                                           | Shared           |             0 | Single price level in the order book                                                                                                                |
| [PriceSnapshot](/schemas/components/price-snapshot)                                                     | Shared           |             0 | Price snapshot with mark, oracle, and mid prices                                                                                                    |
| [SlaActual](/schemas/components/sla-actual)                                                             | Shared           |             0 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [SlaResponse](/schemas/components/sla-response)                                                         | Data Quality     |             1 | SLA compliance response                                                                                                                             |
| [SlaTargets](/schemas/components/sla-targets)                                                           | Shared           |             0 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [SpotFreshness](/schemas/components/spot-freshness)                                                     | Shared           |             0 | Freshness state for a Hyperliquid Spot pair.                                                                                                        |
| [SpotFreshnessBucket](/schemas/components/spot-freshness-bucket)                                        | Shared           |             0 | Freshness state for one Hyperliquid Spot data type.                                                                                                 |
| [SpotPair](/schemas/components/spot-pair)                                                               | Shared           |             0 | Hyperliquid Spot pair metadata.                                                                                                                     |
| [SpotTwapRecord](/schemas/components/spot-twap-record)                                                  | Shared           |             0 | Hyperliquid Spot TWAP record.                                                                                                                       |
| [StatsResponse](/schemas/components/stats-response)                                                     | System           |             1 | Public lightweight API/site statistics.                                                                                                             |
| [StatusResponse](/schemas/components/status-response)                                                   | Data Quality     |             1 | Overall system status                                                                                                                               |
| [SymbolCoverageResponse](/schemas/components/symbol-coverage-response)                                  | Data Quality     |             1 | Per-symbol coverage response with gap detection                                                                                                     |
| [SymbolDataTypeCoverage](/schemas/components/symbol-data-type-coverage)                                 | Shared           |             0 | Coverage for a symbol and data type                                                                                                                 |
| [SymbolEntry](/schemas/components/symbol-entry)                                                         | Shared           |             0 | Public market symbol entry.                                                                                                                         |
| [SymbolsResponse](/schemas/components/symbols-response)                                                 | System           |             1 | Public symbol universe response.                                                                                                                    |
| [Trade](/schemas/components/trade)                                                                      | Shared           |             0 | Trade/fill record with full execution details                                                                                                       |
| [WalletClassifyData](/schemas/components/wallet-classify-data)                                          | Shared           |             0 | Bulk wallet classification response body.                                                                                                           |
| [WalletClassifyMetrics](/schemas/components/wallet-classify-metrics)                                    | Shared           |             0 | Precomputed wallet behavior metrics.                                                                                                                |
| [Web3ApiKey](/schemas/components/web3-api-key)                                                          | Shared           |             0 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [Web3AuthResponse](/schemas/components/web3-auth-response)                                              | Web3 Auth        |             1 | Successful SIWE verification response.                                                                                                              |
| [Web3ChallengeRequest](/schemas/components/web3-challenge-request)                                      | Web3 Auth        |             1 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [Web3ChallengeResponse](/schemas/components/web3-challenge-response)                                    | Web3 Auth        |             1 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [Web3KeysRequest](/schemas/components/web3-keys-request)                                                | Web3 Auth        |             1 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [Web3KeysResponse](/schemas/components/web3-keys-response)                                              | Web3 Auth        |             1 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [Web3RevokeRequest](/schemas/components/web3-revoke-request)                                            | Web3 Auth        |             1 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [Web3RevokeResponse](/schemas/components/web3-revoke-response)                                          | Web3 Auth        |             1 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [Web3SignupRequest](/schemas/components/web3-signup-request)                                            | Web3 Auth        |             1 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [Web3SignupResponse](/schemas/components/web3-signup-response)                                          | Web3 Auth        |             1 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [Web3SubscribeRequest](/schemas/components/web3-subscribe-request)                                      | Web3 Auth        |             1 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [Web3SubscribeResponse](/schemas/components/web3-subscribe-response)                                    | Web3 Auth        |             1 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [Web3UserInfo](/schemas/components/web3-user-info)                                                      | Shared           |             0 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [Web3VerifyRequest](/schemas/components/web3-verify-request)                                            | Web3 Auth        |             1 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
| [WebSocketLatency](/schemas/components/web-socket-latency)                                              | Shared           |             0 | Generated JSON Schema contract from OpenAPI.                                                                                                        |
