Source OpenAPI: 0xArchive API 1.5.0; 116 paths; 90 component schemas. This index is generated fromDocumentation Index
Fetch the complete documentation index at: https://docs.0xarchive.io/llms.txt
Use this file to discover all available pages before exploring further.
openapi.json. Component pages are schema browsing surfaces; the route-specific contract remains the generated endpoint reference and operation schema page.
| Schema | Family | Referenced by | Description |
|---|---|---|---|
| ApiLatency | Shared | 0 | Generated JSON Schema contract from OpenAPI. |
| ApiMeta | Shared | 0 | Response metadata |
| ApiResponseCandleArray | HIP-3 | 5 | API response containing an array of candle data |
| ApiResponseCoinFreshness | HIP-3 | 4 | API response wrapping coin freshness data |
| ApiResponseCoinSummary | HIP-3 | 4 | API response wrapping a market summary |
| ApiResponseFundingRate | HIP-3 | 4 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseFundingRateArray | HIP-3 | 4 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseGenericArray | Shared | 0 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseHip3Instrument | HIP-3 | 1 | API response wrapping a single HIP-3 instrument |
| ApiResponseHip3InstrumentArray | HIP-3 | 1 | API response wrapping an array of HIP-3 instruments |
| ApiResponseHip4OpenInterest | HIP-4 | 1 | API response wrapping a single HIP-4 per-side open-interest record |
| ApiResponseHip4OpenInterestArray | HIP-4 | 1 | API response wrapping an array of HIP-4 per-side open-interest records |
| ApiResponseHip4Outcome | HIP-4 | 1 | API response wrapping a single HIP-4 per-side instrument |
| ApiResponseHip4OutcomeAggregate | HIP-4 | 1 | API response wrapping a single HIP-4 outcome aggregate (with aggregated_oi populated on the detail endpoint) |
| ApiResponseHip4OutcomeAggregateArray | HIP-4 | 1 | API response wrapping an array of HIP-4 outcome aggregates (without aggregated_oi; use /outcomes/{outcome_id} for the detail variant) |
| ApiResponseHip4OutcomeArray | HIP-4 | 1 | API response wrapping an array of HIP-4 per-side instruments |
| ApiResponseInstrument | Hyperliquid Core | 2 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseInstrumentArray | Hyperliquid Core | 2 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseLighterInstrument | Lighter | 1 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseLighterInstrumentArray | Lighter | 1 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseLiquidationArray | Hyperliquid Core | 3 | API response containing an array of liquidation events |
| ApiResponseLiquidationVolumeArray | HIP-3 | 2 | API response containing an array of aggregated liquidation volumes |
| ApiResponseOpenInterest | HIP-3 | 4 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseOpenInterestArray | HIP-3 | 4 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseOrderBook | HIP-3 | 6 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseOrderBookArray | HIP-3 | 5 | Generated JSON Schema contract from OpenAPI. |
| ApiResponsePriceSnapshotArray | HIP-3 | 4 | API response containing an array of price snapshots |
| ApiResponseSpotFreshness | Hyperliquid Spot | 1 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseSpotPair | Hyperliquid Spot | 1 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseSpotPairArray | Hyperliquid Spot | 1 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseSpotTwapArray | Hyperliquid Spot | 2 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseTradeArray | HIP-3 | 10 | Generated JSON Schema contract from OpenAPI. |
| Candle | Shared | 0 | OHLCV candle data |
| CoinFreshness | Shared | 0 | Data freshness for all data types for a specific coin |
| CoinSummary | Shared | 0 | Combined market summary including price, funding, OI, volume, and liquidation data |
| CompletenessMetrics | Shared | 0 | Generated JSON Schema contract from OpenAPI. |
| CoverageGap | Shared | 0 | A gap in data coverage |
| CoverageResponse | Data Quality | 1 | Overall coverage response |
| DataCadence | Shared | 0 | Empirical data cadence measurement based on last 7 days of data |
| DataFreshness | Shared | 0 | Data freshness metrics |
| DataTypeCoverage | Shared | 0 | Coverage for a data type |
| DataTypeFreshness | Shared | 0 | Freshness information for a single data type |
| DataTypeStatus | Shared | 0 | Status of a data type |
| Error | Shared | 0 | Error response |
| ExchangeCoverageResponse | Data Quality | 1 | Coverage for a single exchange |
| ExchangeLatency | Shared | 0 | Latency metrics for an exchange |
| ExchangeStatus | Shared | 0 | Status of a single exchange |
| FundingRate | Shared | 0 | Funding rate record |
| Hip3Instrument | Shared | 0 | HIP-3 Builder Perps instrument with latest market data. |
| Hip4AggregatedOi | Shared | 0 | Derived OI display fields combining both sides of a HIP-4 outcome. |
| Hip4OpenInterestRecord | Shared | 0 | HIP-4 per-side open-interest record. |
| Hip4Outcome | Shared | 0 | HIP-4 per-side instrument metadata. |
| Hip4OutcomeAggregate | Shared | 0 | Per-outcome aggregate (both sides combined). |
| Hip4SideSpec | Shared | 0 | Per-side spec nested in Hip4OutcomeAggregate.side_specs. |
| Incident | Data Quality | 1 | Data quality incident |
| IncidentsResponse | Data Quality | 1 | Incidents list response |
| Instrument | Shared | 0 | Trading instrument specification (Hyperliquid) |
| LatencyResponse | Data Quality | 1 | Latency metrics response |
| LighterInstrument | Shared | 0 | Trading instrument specification (Lighter.xyz). |
| Liquidation | Shared | 0 | Liquidation event |
| LiquidationVolume | Shared | 0 | Aggregated liquidation volume for a time bucket |
| OpenInterest | Shared | 0 | Open interest snapshot with market context |
| OrderBook | Shared | 0 | L2 order book snapshot |
| OrderbookDelta | Shared | 0 | Incremental orderbook change (used with tick-level data) |
| Pagination | Shared | 0 | Pagination info |
| PriceLevel | Shared | 0 | Single price level in the order book |
| PriceSnapshot | Shared | 0 | Price snapshot with mark, oracle, and mid prices |
| SlaActual | Shared | 0 | Generated JSON Schema contract from OpenAPI. |
| SlaResponse | Data Quality | 1 | SLA compliance response |
| SlaTargets | Shared | 0 | Generated JSON Schema contract from OpenAPI. |
| SpotFreshness | Shared | 0 | Freshness state for a Hyperliquid Spot pair. |
| SpotFreshnessBucket | Shared | 0 | Freshness state for one Hyperliquid Spot data type. |
| SpotPair | Shared | 0 | Hyperliquid Spot pair metadata. |
| SpotTwapRecord | Shared | 0 | Hyperliquid Spot TWAP record. |
| StatusResponse | Data Quality | 1 | Overall system status |
| SymbolCoverageResponse | Data Quality | 1 | Per-symbol coverage response with gap detection |
| SymbolDataTypeCoverage | Shared | 0 | Coverage for a symbol and data type |
| Trade | Shared | 0 | Trade/fill record with full execution details |
| Web3ApiKey | Shared | 0 | Generated JSON Schema contract from OpenAPI. |
| Web3ChallengeRequest | Web3 Auth | 1 | Generated JSON Schema contract from OpenAPI. |
| Web3ChallengeResponse | Web3 Auth | 1 | Generated JSON Schema contract from OpenAPI. |
| Web3KeysRequest | Web3 Auth | 1 | Generated JSON Schema contract from OpenAPI. |
| Web3KeysResponse | Web3 Auth | 1 | Generated JSON Schema contract from OpenAPI. |
| Web3RevokeRequest | Web3 Auth | 1 | Generated JSON Schema contract from OpenAPI. |
| Web3RevokeResponse | Web3 Auth | 1 | Generated JSON Schema contract from OpenAPI. |
| Web3SignupRequest | Web3 Auth | 1 | Generated JSON Schema contract from OpenAPI. |
| Web3SignupResponse | Web3 Auth | 1 | Generated JSON Schema contract from OpenAPI. |
| Web3SubscribeRequest | Web3 Auth | 1 | Generated JSON Schema contract from OpenAPI. |
| Web3SubscribeResponse | Web3 Auth | 1 | Generated JSON Schema contract from OpenAPI. |
| WebSocketLatency | Shared | 0 | Generated JSON Schema contract from OpenAPI. |