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. Each operation page includes route metadata, request parameters, request body schemas when present, and every documented response status.
| Method | Path | operationId | Tag | Success schema | Deprecated |
|---|---|---|---|---|---|
GET | /health | healthCheck | System | object | no |
POST | /v1/auth/web3/challenge | web3Challenge | Web3 Authentication | Web3ChallengeResponse | no |
GET | /v1/data-quality/coverage | getDataQualityCoverage | Data Quality | CoverageResponse | no |
GET | /v1/data-quality/coverage/{exchange} | getExchangeCoverage | Data Quality | ExchangeCoverageResponse | no |
GET | /v1/data-quality/coverage/{exchange}/{symbol} | getSymbolCoverage | Data Quality | SymbolCoverageResponse | no |
GET | /v1/data-quality/incidents | listIncidents | Data Quality | IncidentsResponse | no |
GET | /v1/data-quality/incidents/{id} | getIncident | Data Quality | Incident | no |
GET | /v1/data-quality/latency | getLatencyMetrics | Data Quality | LatencyResponse | no |
GET | /v1/data-quality/sla | getSlaMetrics | Data Quality | SlaResponse | no |
GET | /v1/data-quality/status | getDataQualityStatus | Data Quality | StatusResponse | no |
GET | /v1/funding/{symbol} | getFundingHistory | Legacy | ApiResponseFundingRateArray | yes |
GET | /v1/funding/{symbol}/current | getCurrentFunding | Legacy | ApiResponseFundingRate | yes |
GET | /v1/hyperliquid/candles/{symbol} | getHyperliquidCandles | Hyperliquid - Candles | ApiResponseCandleArray | no |
GET | /v1/hyperliquid/freshness/{symbol} | getHyperliquidFreshness | Hyperliquid - Convenience | ApiResponseCoinFreshness | no |
GET | /v1/hyperliquid/funding/{symbol} | getHyperliquidFundingHistory | Hyperliquid - Funding | ApiResponseFundingRateArray | no |
GET | /v1/hyperliquid/funding/{symbol}/current | getCurrentHyperliquidFunding | Hyperliquid - Funding | ApiResponseFundingRate | no |
GET | /v1/hyperliquid/hip3/candles/{symbol} | getHip3Candles | HIP-3 Builder Perps - Candles | ApiResponseCandleArray | no |
GET | /v1/hyperliquid/hip3/freshness/{symbol} | getHip3Freshness | HIP-3 Builder Perps - Convenience | ApiResponseCoinFreshness | no |
GET | /v1/hyperliquid/hip3/funding/{symbol} | getHip3FundingHistory | HIP-3 Builder Perps - Funding | ApiResponseFundingRateArray | no |
GET | /v1/hyperliquid/hip3/funding/{symbol}/current | getCurrentHip3Funding | HIP-3 Builder Perps - Funding | ApiResponseFundingRate | no |
GET | /v1/hyperliquid/hip3/instruments | listHip3Instruments | HIP-3 Builder Perps - Instruments | ApiResponseHip3InstrumentArray | no |
GET | /v1/hyperliquid/hip3/instruments/{symbol} | getHip3Instrument | HIP-3 Builder Perps - Instruments | ApiResponseHip3Instrument | no |
GET | /v1/hyperliquid/hip3/liquidations/{symbol} | getHip3Liquidations | HIP-3 Builder Perps - Liquidations | ApiResponseLiquidationArray | no |
GET | /v1/hyperliquid/hip3/liquidations/{symbol}/volume | getHip3LiquidationVolume | HIP-3 Builder Perps - Liquidations | ApiResponseLiquidationVolumeArray | no |
GET | /v1/hyperliquid/hip3/openinterest/{symbol} | getHip3OpenInterest | HIP-3 Builder Perps - Open Interest | ApiResponseOpenInterestArray | no |
GET | /v1/hyperliquid/hip3/openinterest/{symbol}/current | getCurrentHip3OpenInterest | HIP-3 Builder Perps - Open Interest | ApiResponseOpenInterest | no |
GET | /v1/hyperliquid/hip3/orderbook/{symbol} | getHip3Orderbook | HIP-3 Builder Perps - Order Book | ApiResponseOrderBook | no |
GET | /v1/hyperliquid/hip3/orderbook/{symbol}/history | getHip3OrderbookHistory | HIP-3 Builder Perps - Order Book | ApiResponseOrderBookArray | no |
GET | /v1/hyperliquid/hip3/orderbook/{symbol}/l4 | getHip3L4Orderbook | HIP-3 Builder Perps - L4 Order Book | object | no |
GET | /v1/hyperliquid/hip3/orderbook/{symbol}/l4/diffs | getHip3L4Diffs | HIP-3 Builder Perps - L4 Order Book | object | no |
GET | /v1/hyperliquid/hip3/orderbook/{symbol}/l4/history | getHip3L4History | HIP-3 Builder Perps - L4 Order Book | object | no |
GET | /v1/hyperliquid/hip3/orders/{symbol}/flow | getHip3OrderFlow | HIP-3 Builder Perps - Orders | object | no |
GET | /v1/hyperliquid/hip3/orders/{symbol}/history | getHip3OrderHistory | HIP-3 Builder Perps - Orders | object | no |
GET | /v1/hyperliquid/hip3/orders/{symbol}/tpsl | getHip3Tpsl | HIP-3 Builder Perps - Orders | object | no |
GET | /v1/hyperliquid/hip3/prices/{symbol} | getHip3PriceHistory | HIP-3 Builder Perps - Convenience | ApiResponsePriceSnapshotArray | no |
GET | /v1/hyperliquid/hip3/summary/{symbol} | getHip3Summary | HIP-3 Builder Perps - Convenience | ApiResponseCoinSummary | no |
GET | /v1/hyperliquid/hip3/trades/{symbol} | getHip3Trades | HIP-3 Builder Perps - Trades | ApiResponseTradeArray | no |
GET | /v1/hyperliquid/hip3/trades/{symbol}/recent | getHip3RecentTrades | HIP-3 Builder Perps - Trades | ApiResponseTradeArray | no |
GET | /v1/hyperliquid/hip4/candles/{symbol} | getHip4Candles | HIP-4 Outcomes - Candles | ApiResponseCandleArray | no |
GET | /v1/hyperliquid/hip4/freshness/{symbol} | getHip4Freshness | HIP-4 Outcomes - Convenience | ApiResponseCoinFreshness | no |
GET | /v1/hyperliquid/hip4/instruments | listHip4Instruments | HIP-4 Outcomes - Instruments | ApiResponseHip4OutcomeArray | no |
GET | /v1/hyperliquid/hip4/instruments/{symbol} | getHip4Instrument | HIP-4 Outcomes - Instruments | ApiResponseHip4Outcome | no |
GET | /v1/hyperliquid/hip4/openinterest/{symbol} | getHip4OpenInterest | HIP-4 Outcomes - Open Interest | ApiResponseHip4OpenInterestArray | no |
GET | /v1/hyperliquid/hip4/openinterest/{symbol}/current | getCurrentHip4OpenInterest | HIP-4 Outcomes - Open Interest | ApiResponseHip4OpenInterest | no |
GET | /v1/hyperliquid/hip4/orderbook/{symbol} | getHip4Orderbook | HIP-4 Outcomes - Order Book | ApiResponseOrderBook | no |
GET | /v1/hyperliquid/hip4/orderbook/{symbol}/history | getHip4OrderbookHistory | HIP-4 Outcomes - Order Book | ApiResponseOrderBookArray | no |
GET | /v1/hyperliquid/hip4/orderbook/{symbol}/l4 | getHip4L4Orderbook | HIP-4 Outcomes - Order Book | object | no |
GET | /v1/hyperliquid/hip4/orderbook/{symbol}/l4/diffs | getHip4L4Diffs | HIP-4 Outcomes - Order Book | object | no |
GET | /v1/hyperliquid/hip4/orderbook/{symbol}/l4/history | getHip4L4History | HIP-4 Outcomes - Order Book | object | no |
GET | /v1/hyperliquid/hip4/orders/{symbol}/flow | getHip4OrderFlow | HIP-4 Outcomes - Orders | object | no |
GET | /v1/hyperliquid/hip4/orders/{symbol}/history | getHip4OrderHistory | HIP-4 Outcomes - Orders | object | no |
GET | /v1/hyperliquid/hip4/orders/{symbol}/tpsl | getHip4Tpsl | HIP-4 Outcomes - Orders | object | no |
GET | /v1/hyperliquid/hip4/outcomes | listHip4Outcomes | HIP-4 Outcomes - Outcomes | ApiResponseHip4OutcomeAggregateArray | no |
GET | /v1/hyperliquid/hip4/outcomes/{outcome_id} | getHip4Outcome | HIP-4 Outcomes - Outcomes | ApiResponseHip4OutcomeAggregate | no |
GET | /v1/hyperliquid/hip4/prices/{symbol} | getHip4PriceHistory | HIP-4 Outcomes - Convenience | ApiResponsePriceSnapshotArray | no |
GET | /v1/hyperliquid/hip4/summary/{symbol} | getHip4Summary | HIP-4 Outcomes - Convenience | ApiResponseCoinSummary | no |
GET | /v1/hyperliquid/hip4/trades/{symbol} | getHip4Trades | HIP-4 Outcomes - Trades | ApiResponseTradeArray | no |
GET | /v1/hyperliquid/hip4/trades/{symbol}/recent | getHip4RecentTrades | HIP-4 Outcomes - Trades | ApiResponseTradeArray | no |
GET | /v1/hyperliquid/instruments | listHyperliquidInstruments | Hyperliquid - Instruments | ApiResponseInstrumentArray | no |
GET | /v1/hyperliquid/instruments/{symbol} | getHyperliquidInstrument | Hyperliquid - Instruments | ApiResponseInstrument | no |
GET | /v1/hyperliquid/liquidations/{symbol} | getHyperliquidLiquidations | Hyperliquid - Liquidations | ApiResponseLiquidationArray | no |
GET | /v1/hyperliquid/liquidations/{symbol}/volume | getHyperliquidLiquidationVolume | Hyperliquid - Convenience | ApiResponseLiquidationVolumeArray | no |
GET | /v1/hyperliquid/liquidations/user/{user} | getHyperliquidLiquidationsByUser | Hyperliquid - Liquidations | ApiResponseLiquidationArray | no |
GET | /v1/hyperliquid/openinterest/{symbol} | getHyperliquidOpenInterest | Hyperliquid - Open Interest | ApiResponseOpenInterestArray | no |
GET | /v1/hyperliquid/openinterest/{symbol}/current | getCurrentHyperliquidOpenInterest | Hyperliquid - Open Interest | ApiResponseOpenInterest | no |
GET | /v1/hyperliquid/orderbook/{symbol} | getHyperliquidOrderbook | Hyperliquid - Order Book | ApiResponseOrderBook | no |
GET | /v1/hyperliquid/orderbook/{symbol}/history | getHyperliquidOrderbookHistory | Hyperliquid - Order Book | ApiResponseOrderBookArray | no |
GET | /v1/hyperliquid/orderbook/{symbol}/l4 | getHyperliquidL4Orderbook | Hyperliquid - L4 Order Book | object | no |
GET | /v1/hyperliquid/orderbook/{symbol}/l4/diffs | getHyperliquidL4Diffs | Hyperliquid - L4 Order Book | object | no |
GET | /v1/hyperliquid/orderbook/{symbol}/l4/history | getHyperliquidL4History | Hyperliquid - L4 Order Book | object | no |
GET | /v1/hyperliquid/orders/{symbol}/flow | getHyperliquidOrderFlow | Hyperliquid - Orders | object | no |
GET | /v1/hyperliquid/orders/{symbol}/history | getHyperliquidOrderHistory | Hyperliquid - Orders | object | no |
GET | /v1/hyperliquid/orders/{symbol}/tpsl | getHyperliquidTpsl | Hyperliquid - Orders | object | no |
GET | /v1/hyperliquid/prices/{symbol} | getHyperliquidPriceHistory | Hyperliquid - Convenience | ApiResponsePriceSnapshotArray | no |
GET | /v1/hyperliquid/spot/candles/{symbol} | getSpotCandles | Hyperliquid Spot - Candles | ApiResponseCandleArray | no |
GET | /v1/hyperliquid/spot/freshness/{symbol} | getHyperliquidSpotFreshness | Hyperliquid Spot | ApiResponseSpotFreshness | no |
GET | /v1/hyperliquid/spot/orderbook/{symbol} | getHyperliquidSpotOrderbook | Hyperliquid Spot | ApiResponseOrderBook | no |
GET | /v1/hyperliquid/spot/orderbook/{symbol}/l4 | getHyperliquidSpotL4Orderbook | Hyperliquid Spot | object | no |
GET | /v1/hyperliquid/spot/orderbook/{symbol}/l4/diffs | getHyperliquidSpotL4Diffs | Hyperliquid Spot | object | no |
GET | /v1/hyperliquid/spot/orderbook/{symbol}/l4/history | getHyperliquidSpotL4History | Hyperliquid Spot | object | no |
GET | /v1/hyperliquid/spot/orders/{symbol}/history | getHyperliquidSpotOrderHistory | Hyperliquid Spot | object | no |
GET | /v1/hyperliquid/spot/pairs | getHyperliquidSpotPairs | Hyperliquid Spot | ApiResponseSpotPairArray | no |
GET | /v1/hyperliquid/spot/pairs/{symbol} | getHyperliquidSpotPair | Hyperliquid Spot | ApiResponseSpotPair | no |
GET | /v1/hyperliquid/spot/trades/{symbol} | getHyperliquidSpotTrades | Hyperliquid Spot | ApiResponseTradeArray | no |
GET | /v1/hyperliquid/spot/twap/{symbol} | getHyperliquidSpotTwap | Hyperliquid Spot | ApiResponseSpotTwapArray | no |
GET | /v1/hyperliquid/spot/twap/user/{user} | getHyperliquidSpotUserTwap | Hyperliquid Spot | ApiResponseSpotTwapArray | no |
GET | /v1/hyperliquid/summary/{symbol} | getHyperliquidSummary | Hyperliquid - Convenience | ApiResponseCoinSummary | no |
GET | /v1/hyperliquid/trades/{symbol} | getHyperliquidTrades | Hyperliquid - Trades | ApiResponseTradeArray | no |
GET | /v1/instruments | listInstruments | Legacy | ApiResponseInstrumentArray | yes |
GET | /v1/instruments/{symbol} | getInstrument | Legacy | ApiResponseInstrument | yes |
GET | /v1/lighter/candles/{symbol} | getLighterCandles | Lighter - Candles | ApiResponseCandleArray | no |
GET | /v1/lighter/freshness/{symbol} | getLighterFreshness | Lighter - Convenience | ApiResponseCoinFreshness | no |
GET | /v1/lighter/funding/{symbol} | getLighterFundingHistory | Lighter - Funding | ApiResponseFundingRateArray | no |
GET | /v1/lighter/funding/{symbol}/current | getCurrentLighterFunding | Lighter - Funding | ApiResponseFundingRate | no |
GET | /v1/lighter/instruments | listLighterInstruments | Lighter - Instruments | ApiResponseLighterInstrumentArray | no |
GET | /v1/lighter/instruments/{symbol} | getLighterInstrument | Lighter - Instruments | ApiResponseLighterInstrument | no |
GET | /v1/lighter/l3orderbook/{symbol} | getLighterL3Orderbook | Lighter - L3 Order Book | object | no |
GET | /v1/lighter/l3orderbook/{symbol}/history | getLighterL3OrderbookHistory | Lighter - L3 Order Book | object | no |
GET | /v1/lighter/openinterest/{symbol} | getLighterOpenInterest | Lighter - Open Interest | ApiResponseOpenInterestArray | no |
GET | /v1/lighter/openinterest/{symbol}/current | getCurrentLighterOpenInterest | Lighter - Open Interest | ApiResponseOpenInterest | no |
GET | /v1/lighter/orderbook/{symbol} | getLighterOrderbook | Lighter - Order Book | ApiResponseOrderBook | no |
GET | /v1/lighter/orderbook/{symbol}/history | getLighterOrderbookHistory | Lighter - Order Book | ApiResponseOrderBookArray | no |
GET | /v1/lighter/prices/{symbol} | getLighterPriceHistory | Lighter - Convenience | ApiResponsePriceSnapshotArray | no |
GET | /v1/lighter/summary/{symbol} | getLighterSummary | Lighter - Convenience | ApiResponseCoinSummary | no |
GET | /v1/lighter/trades/{symbol} | getLighterTrades | Lighter - Trades | ApiResponseTradeArray | no |
GET | /v1/lighter/trades/{symbol}/recent | getLighterRecentTrades | Lighter - Trades | ApiResponseTradeArray | no |
GET | /v1/openinterest/{symbol} | getOpenInterest | Legacy | ApiResponseOpenInterestArray | yes |
GET | /v1/openinterest/{symbol}/current | getCurrentOpenInterest | Legacy | ApiResponseOpenInterest | yes |
GET | /v1/orderbook/{symbol} | getOrderbook | Legacy | ApiResponseOrderBook | yes |
GET | /v1/orderbook/{symbol}/history | getOrderbookHistory | Legacy | ApiResponseOrderBookArray | yes |
GET | /v1/trades/{symbol} | getTrades | Legacy | ApiResponseTradeArray | yes |
GET | /v1/trades/{symbol}/cursor | getTradesCursor | Legacy | ApiResponseTradeArray | yes |
POST | /v1/web3/keys | web3ListKeys | Web3 Authentication | Web3KeysResponse | no |
POST | /v1/web3/keys/revoke | web3RevokeKey | Web3 Authentication | Web3RevokeResponse | no |
POST | /v1/web3/signup | web3Signup | Web3 Authentication | Web3SignupResponse | no |
POST | /v1/web3/subscribe | web3Subscribe | Web3 Authentication | Web3SubscribeResponse | no |