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

# HIP-4 Schemas

> Generated operation schema index for HIP-4. Includes 0xArchive route contracts, success schemas, deprecation labels, and linked operation schema pages.

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

Use this page to find HIP-4 operation schemas by method and path. Open an operation schema for the raw JSON shape, or use [HIP-4 endpoint reference](/api-reference/hip4) for the full request and response page.

| Method | Path | operationId | Success schema | Deprecated |
| - | - | - | - | - |
| `GET` | `/v1/hyperliquid/hip4/candles/{symbol}` | [getHip4Candles](/schemas/operations/get-hip4-candles) | [ApiResponseCandleArray](/schemas/components/api-response-candle-array) | no |
| `GET` | `/v1/hyperliquid/hip4/freshness/{symbol}` | [getHip4Freshness](/schemas/operations/get-hip4-freshness) | [ApiResponseCoinFreshness](/schemas/components/api-response-coin-freshness) | no |
| `GET` | `/v1/hyperliquid/hip4/instruments` | [listHip4Instruments](/schemas/operations/list-hip4-instruments) | [ApiResponseHip4OutcomeArray](/schemas/components/api-response-hip4-outcome-array) | no |
| `GET` | `/v1/hyperliquid/hip4/instruments/{symbol}` | [getHip4Instrument](/schemas/operations/get-hip4-instrument) | [ApiResponseHip4Outcome](/schemas/components/api-response-hip4-outcome) | no |
| `GET` | `/v1/hyperliquid/hip4/openinterest/{symbol}` | [getHip4OpenInterest](/schemas/operations/get-hip4-open-interest) | [ApiResponseHip4OpenInterestArray](/schemas/components/api-response-hip4-open-interest-array) | no |
| `GET` | `/v1/hyperliquid/hip4/openinterest/{symbol}/current` | [getCurrentHip4OpenInterest](/schemas/operations/get-current-hip4-open-interest) | [ApiResponseHip4OpenInterest](/schemas/components/api-response-hip4-open-interest) | no |
| `GET` | `/v1/hyperliquid/hip4/orderbook/{symbol}` | [getHip4Orderbook](/schemas/operations/get-hip4-orderbook) | [ApiResponseOrderBook](/schemas/components/api-response-order-book) | no |
| `GET` | `/v1/hyperliquid/hip4/orderbook/{symbol}/history` | [getHip4OrderbookHistory](/schemas/operations/get-hip4-orderbook-history) | [ApiResponseOrderBookArray](/schemas/components/api-response-order-book-array) | no |
| `GET` | `/v1/hyperliquid/hip4/orderbook/{symbol}/l4` | [getHip4L4Orderbook](/schemas/operations/get-hip4-l4-orderbook) | [ApiResponseL4OrderBook](/schemas/components/api-response-l4-order-book) | no |
| `GET` | `/v1/hyperliquid/hip4/orderbook/{symbol}/l4/diffs` | [getHip4L4Diffs](/schemas/operations/get-hip4-l4-diffs) | object | no |
| `GET` | `/v1/hyperliquid/hip4/orderbook/{symbol}/l4/history` | [getHip4L4History](/schemas/operations/get-hip4-l4-history) | [ApiResponseL4OrderBookArray](/schemas/components/api-response-l4-order-book-array) | no |
| `GET` | `/v1/hyperliquid/hip4/orders/{symbol}/flow` | [getHip4OrderFlow](/schemas/operations/get-hip4-order-flow) | object | no |
| `GET` | `/v1/hyperliquid/hip4/orders/{symbol}/history` | [getHip4OrderHistory](/schemas/operations/get-hip4-order-history) | object | no |
| `GET` | `/v1/hyperliquid/hip4/orders/{symbol}/tpsl` | [getHip4Tpsl](/schemas/operations/get-hip4-tpsl) | object | no |
| `GET` | `/v1/hyperliquid/hip4/outcomes` | [listHip4Outcomes](/schemas/operations/list-hip4-outcomes) | [ApiResponseHip4OutcomeAggregateArray](/schemas/components/api-response-hip4-outcome-aggregate-array) | no |
| `GET` | `/v1/hyperliquid/hip4/outcomes/{outcome_id}` | [getHip4Outcome](/schemas/operations/get-hip4-outcome) | [ApiResponseHip4OutcomeAggregate](/schemas/components/api-response-hip4-outcome-aggregate) | no |
| `GET` | `/v1/hyperliquid/hip4/outcomes/by-slug/{slug}` | [getHip4OutcomeBySlug](/schemas/operations/get-hip4-outcome-by-slug) | [ApiResponseHip4OutcomeAggregate](/schemas/components/api-response-hip4-outcome-aggregate) | no |
| `GET` | `/v1/hyperliquid/hip4/prices/{symbol}` | [getHip4PriceHistory](/schemas/operations/get-hip4-price-history) | [ApiResponsePriceSnapshotArray](/schemas/components/api-response-price-snapshot-array) | no |
| `GET` | `/v1/hyperliquid/hip4/questions` | [listHip4Questions](/schemas/operations/list-hip4-questions) | [ApiResponseHip4QuestionArray](/schemas/components/api-response-hip4-question-array) | no |
| `GET` | `/v1/hyperliquid/hip4/questions/{question_id}` | [getHip4Question](/schemas/operations/get-hip4-question) | [ApiResponseHip4Question](/schemas/components/api-response-hip4-question) | no |
| `GET` | `/v1/hyperliquid/hip4/summary/{symbol}` | [getHip4Summary](/schemas/operations/get-hip4-summary) | [ApiResponseCoinSummary](/schemas/components/api-response-coin-summary) | no |
| `GET` | `/v1/hyperliquid/hip4/trades/{symbol}` | [getHip4Trades](/schemas/operations/get-hip4-trades) | [ApiResponseTradeArray](/schemas/components/api-response-trade-array) | no |
| `GET` | `/v1/hyperliquid/hip4/trades/{symbol}/recent` | [getHip4RecentTrades](/schemas/operations/get-hip4-recent-trades) | [ApiResponseTradeArray](/schemas/components/api-response-trade-array) | no |
| `GET` | `/v1/hyperliquid/hip4/twap/{symbol}` | [getHip4Twap](/schemas/operations/get-hip4-twap) | [ApiResponseTwapArray](/schemas/components/api-response-twap-array) | no |
| `GET` | `/v1/hyperliquid/hip4/twap/user/{user}` | [getHip4UserTwap](/schemas/operations/get-hip4-user-twap) | [ApiResponseTwapArray](/schemas/components/api-response-twap-array) | no |


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