> ## 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-3 Schemas

> Generated operation schema index for HIP-3. 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-3 operation schemas by method and path. Open an operation schema for the raw JSON shape, or use [HIP-3 endpoint reference](/api-reference/hip3) for the full request and response page.

| Method | Path | operationId | Success schema | Deprecated |
| - | - | - | - | - |
| `GET` | `/v1/hyperliquid/hip3/breadth/above-vwap` | [getHip3BreadthAboveVwap](/schemas/operations/get-hip3-breadth-above-vwap) | [ApiResponseBreadthSnapshotArray](/schemas/components/api-response-breadth-snapshot-array) | no |
| `GET` | `/v1/hyperliquid/hip3/breadth/above-vwap/current` | [getHip3BreadthAboveVwapCurrent](/schemas/operations/get-hip3-breadth-above-vwap-current) | [ApiResponseBreadthSnapshot](/schemas/components/api-response-breadth-snapshot) | no |
| `GET` | `/v1/hyperliquid/hip3/candles/{symbol}` | [getHip3Candles](/schemas/operations/get-hip3-candles) | [ApiResponseCandleArray](/schemas/components/api-response-candle-array) | no |
| `GET` | `/v1/hyperliquid/hip3/cvd/{symbol}` | [getHip3Cvd](/schemas/operations/get-hip3-cvd) | [ApiResponseCvdBucketArray](/schemas/components/api-response-cvd-bucket-array) | no |
| `GET` | `/v1/hyperliquid/hip3/freshness/{symbol}` | [getHip3Freshness](/schemas/operations/get-hip3-freshness) | [ApiResponseCoinFreshness](/schemas/components/api-response-coin-freshness) | no |
| `GET` | `/v1/hyperliquid/hip3/funding/{symbol}` | [getHip3FundingHistory](/schemas/operations/get-hip3-funding-history) | [ApiResponseFundingRateArray](/schemas/components/api-response-funding-rate-array) | no |
| `GET` | `/v1/hyperliquid/hip3/funding/{symbol}/current` | [getCurrentHip3Funding](/schemas/operations/get-current-hip3-funding) | [ApiResponseFundingRate](/schemas/components/api-response-funding-rate) | no |
| `GET` | `/v1/hyperliquid/hip3/instruments` | [listHip3Instruments](/schemas/operations/list-hip3-instruments) | [ApiResponseHip3InstrumentArray](/schemas/components/api-response-hip3-instrument-array) | no |
| `GET` | `/v1/hyperliquid/hip3/instruments/{symbol}` | [getHip3Instrument](/schemas/operations/get-hip3-instrument) | [ApiResponseHip3Instrument](/schemas/components/api-response-hip3-instrument) | no |
| `GET` | `/v1/hyperliquid/hip3/liquidations/{symbol}` | [getHip3Liquidations](/schemas/operations/get-hip3-liquidations) | [ApiResponseLiquidationArray](/schemas/components/api-response-liquidation-array) | no |
| `GET` | `/v1/hyperliquid/hip3/liquidations/{symbol}/levels` | [getHip3LiquidationLevels](/schemas/operations/get-hip3-liquidation-levels) | [ApiResponseLiquidationLevels](/schemas/components/api-response-liquidation-levels) | no |
| `GET` | `/v1/hyperliquid/hip3/liquidations/{symbol}/levels/history` | [getHip3LiquidationLevelsHistory](/schemas/operations/get-hip3-liquidation-levels-history) | [ApiResponseLiquidationLevelsHistory](/schemas/components/api-response-liquidation-levels-history) | no |
| `GET` | `/v1/hyperliquid/hip3/liquidations/{symbol}/volume` | [getHip3LiquidationVolume](/schemas/operations/get-hip3-liquidation-volume) | [ApiResponseLiquidationVolumeArray](/schemas/components/api-response-liquidation-volume-array) | no |
| `GET` | `/v1/hyperliquid/hip3/openinterest/{symbol}` | [getHip3OpenInterest](/schemas/operations/get-hip3-open-interest) | [ApiResponseOpenInterestArray](/schemas/components/api-response-open-interest-array) | no |
| `GET` | `/v1/hyperliquid/hip3/openinterest/{symbol}/current` | [getCurrentHip3OpenInterest](/schemas/operations/get-current-hip3-open-interest) | [ApiResponseOpenInterest](/schemas/components/api-response-open-interest) | no |
| `GET` | `/v1/hyperliquid/hip3/oracle/discovery-bounds/{symbol}` | [getHip3OracleDiscoveryBounds](/schemas/operations/get-hip3-oracle-discovery-bounds) | [ApiResponseHip3OracleDiscoveryBounds](/schemas/components/api-response-hip3-oracle-discovery-bounds) | no |
| `GET` | `/v1/hyperliquid/hip3/oracle/external-price/{symbol}` | [getHip3OracleExternalPrice](/schemas/operations/get-hip3-oracle-external-price) | [ApiResponseHip3OracleExternalPrice](/schemas/components/api-response-hip3-oracle-external-price) | no |
| `GET` | `/v1/hyperliquid/hip3/orderbook/{symbol}` | [getHip3Orderbook](/schemas/operations/get-hip3-orderbook) | [ApiResponseOrderBook](/schemas/components/api-response-order-book) | no |
| `GET` | `/v1/hyperliquid/hip3/orderbook/{symbol}/history` | [getHip3OrderbookHistory](/schemas/operations/get-hip3-orderbook-history) | [ApiResponseOrderBookArray](/schemas/components/api-response-order-book-array) | no |
| `GET` | `/v1/hyperliquid/hip3/orderbook/{symbol}/l2` | [getHip3FullDepthL2Orderbook](/schemas/operations/get-hip3-full-depth-l2-orderbook) | [ApiResponseFullDepthL2OrderBook](/schemas/components/api-response-full-depth-l2-order-book) | no |
| `GET` | `/v1/hyperliquid/hip3/orderbook/{symbol}/l2/diffs` | [getHip3FullDepthL2Diffs](/schemas/operations/get-hip3-full-depth-l2-diffs) | [ApiResponseL2OrderBookDiffArray](/schemas/components/api-response-l2-order-book-diff-array) | no |
| `GET` | `/v1/hyperliquid/hip3/orderbook/{symbol}/l2/history` | [getHip3FullDepthL2History](/schemas/operations/get-hip3-full-depth-l2-history) | [ApiResponseFullDepthL2OrderBookArray](/schemas/components/api-response-full-depth-l2-order-book-array) | no |
| `GET` | `/v1/hyperliquid/hip3/orderbook/{symbol}/l4` | [getHip3L4Orderbook](/schemas/operations/get-hip3-l4-orderbook) | [ApiResponseL4OrderBook](/schemas/components/api-response-l4-order-book) | no |
| `GET` | `/v1/hyperliquid/hip3/orderbook/{symbol}/l4/diffs` | [getHip3L4Diffs](/schemas/operations/get-hip3-l4-diffs) | object | no |
| `GET` | `/v1/hyperliquid/hip3/orderbook/{symbol}/l4/history` | [getHip3L4History](/schemas/operations/get-hip3-l4-history) | [ApiResponseL4OrderBookArray](/schemas/components/api-response-l4-order-book-array) | no |
| `GET` | `/v1/hyperliquid/hip3/orders/{symbol}/flow` | [getHip3OrderFlow](/schemas/operations/get-hip3-order-flow) | object | no |
| `GET` | `/v1/hyperliquid/hip3/orders/{symbol}/history` | [getHip3OrderHistory](/schemas/operations/get-hip3-order-history) | object | no |
| `GET` | `/v1/hyperliquid/hip3/orders/{symbol}/tpsl` | [getHip3Tpsl](/schemas/operations/get-hip3-tpsl) | object | no |
| `GET` | `/v1/hyperliquid/hip3/orders/{symbol}/trigger-levels` | [getHip3TriggerLevels](/schemas/operations/get-hip3-trigger-levels) | [ApiResponseTriggerLevels](/schemas/components/api-response-trigger-levels) | no |
| `GET` | `/v1/hyperliquid/hip3/orders/{symbol}/trigger-levels/history` | [getHip3TriggerLevelsHistory](/schemas/operations/get-hip3-trigger-levels-history) | [ApiResponseTriggerLevelsHistory](/schemas/components/api-response-trigger-levels-history) | no |
| `GET` | `/v1/hyperliquid/hip3/positions` | [getHip3AllPositions](/schemas/operations/get-hip3-all-positions) | [ApiResponseMarketPositionArray](/schemas/components/api-response-market-position-array) | no |
| `GET` | `/v1/hyperliquid/hip3/positions/{symbol}` | [getHip3MarketPositions](/schemas/operations/get-hip3-market-positions) | [ApiResponseMarketPositionArray](/schemas/components/api-response-market-position-array) | no |
| `GET` | `/v1/hyperliquid/hip3/positions/{symbol}/summary` | [getHip3MarketPositionsSummary](/schemas/operations/get-hip3-market-positions-summary) | [ApiResponseMarketPositionsSummaryArray](/schemas/components/api-response-market-positions-summary-array) | no |
| `GET` | `/v1/hyperliquid/hip3/prices/{symbol}` | [getHip3PriceHistory](/schemas/operations/get-hip3-price-history) | [ApiResponsePriceSnapshotArray](/schemas/components/api-response-price-snapshot-array) | no |
| `GET` | `/v1/hyperliquid/hip3/summary/{symbol}` | [getHip3Summary](/schemas/operations/get-hip3-summary) | [ApiResponseCoinSummary](/schemas/components/api-response-coin-summary) | no |
| `GET` | `/v1/hyperliquid/hip3/trades/{symbol}` | [getHip3Trades](/schemas/operations/get-hip3-trades) | [ApiResponseTradeArray](/schemas/components/api-response-trade-array) | no |
| `GET` | `/v1/hyperliquid/hip3/trades/{symbol}/recent` | [getHip3RecentTrades](/schemas/operations/get-hip3-recent-trades) | [ApiResponseTradeArray](/schemas/components/api-response-trade-array) | no |
| `GET` | `/v1/hyperliquid/hip3/twap/{symbol}` | [getHip3Twap](/schemas/operations/get-hip3-twap) | [ApiResponseTwapArray](/schemas/components/api-response-twap-array) | no |
| `GET` | `/v1/hyperliquid/hip3/twap/user/{user}` | [getHip3UserTwap](/schemas/operations/get-hip3-user-twap) | [ApiResponseTwapArray](/schemas/components/api-response-twap-array) | no |
| `GET` | `/v1/hyperliquid/hip3/wallets/{address}/account` | [getHip3WalletAccount](/schemas/operations/get-hip3-wallet-account) | [ApiResponseAccountSummaryArray](/schemas/components/api-response-account-summary-array) | no |
| `GET` | `/v1/hyperliquid/hip3/wallets/{address}/account/history` | [getHip3WalletAccountHistory](/schemas/operations/get-hip3-wallet-account-history) | [ApiResponseAccountSummaryArray](/schemas/components/api-response-account-summary-array) | no |
| `GET` | `/v1/hyperliquid/hip3/wallets/{address}/positions` | [getHip3WalletPositions](/schemas/operations/get-hip3-wallet-positions) | [ApiResponseWalletPositions](/schemas/components/api-response-wallet-positions) | no |
| `GET` | `/v1/hyperliquid/hip3/wallets/{address}/positions/changes` | [getHip3WalletPositionChanges](/schemas/operations/get-hip3-wallet-position-changes) | [ApiResponsePositionChangeArray](/schemas/components/api-response-position-change-array) | no |
| `GET` | `/v1/hyperliquid/hip3/wallets/{address}/positions/history` | [getHip3WalletPositionsHistory](/schemas/operations/get-hip3-wallet-positions-history) | [ApiResponsePositionArray](/schemas/components/api-response-position-array) | no |
| `GET` | `/v1/hyperliquid/hip3/wallets/{address}/profile` | [getHip3WalletProfile](/schemas/operations/get-hip3-wallet-profile) | [ApiResponseWalletProfile](/schemas/components/api-response-wallet-profile) | no |
| `GET` | `/v1/hyperliquid/hip3/wallets/classify` | [classifyHip3Wallets](/schemas/operations/classify-hip3-wallets) | [ApiResponseWalletClassifyData](/schemas/components/api-response-wallet-classify-data) | no |


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