| Schema | Family | Referenced by | Description |
|---|---|---|---|
| AccountSummary | Shared | 0 | Account summary. |
| ApiLatency | Shared | 0 | Generated JSON Schema contract from OpenAPI. |
| ApiMeta | Shared | 0 | Response metadata |
| ApiResponseAccountSummaryArray | HIP-3 | 8 | Account summaries (current: one per account or HIP-3 dex; history: one per hour). |
| ApiResponseBreadthSnapshot | HIP-3 | 2 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseBreadthSnapshotArray | HIP-3 | 2 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseCandleArray | HIP-3 | 6 | API response containing an array of candle data |
| ApiResponseCoinFreshness | HIP-3 | 5 | API response wrapping coin freshness data |
| ApiResponseCoinSummary | HIP-3 | 5 | API response wrapping a market summary |
| ApiResponseCvdBucketArray | HIP-3 | 2 | API response containing CVD buckets. |
| ApiResponseFullDepthL2OrderBook | HIP-3 | 2 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseFullDepthL2OrderBookArray | HIP-3 | 2 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseFundingRate | HIP-3 | 5 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseFundingRateArray | HIP-3 | 5 | 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 |
| ApiResponseHip3OracleDiscoveryBounds | HIP-3 | 1 | API response containing HIP-3 oracle discovery bounds. |
| ApiResponseHip3OracleExternalPrice | HIP-3 | 1 | API response containing HIP-3 oracle external price data. |
| 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 | 2 | 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 |
| ApiResponseHip4Question | HIP-4 | 1 | API response containing one HIP-4 question. |
| ApiResponseHip4QuestionArray | HIP-4 | 1 | API response containing HIP-4 questions. |
| ApiResponseInstrument | Hyperliquid Core | 2 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseInstrumentArray | Hyperliquid Core | 2 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseL2OrderBookDiffArray | HIP-3 | 2 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseL3OrderBook | Lighter | 1 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseL3OrderBookArray | Lighter | 1 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseL4OrderBook | HIP-3 | 4 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseL4OrderBookArray | HIP-3 | 4 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseLighterInstrument | Lighter | 2 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseLighterInstrumentArray | Lighter | 2 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseLighterL1Accounts | Lighter | 1 | Lighter accounts owned by an L1 address. |
| ApiResponseLighterLiquidationArray | Lighter | 2 | API response containing an array of native Lighter liquidation events |
| ApiResponseLighterTradeArray | Lighter | 4 | API response containing an array of Lighter trades. |
| ApiResponseLiquidationArray | Hyperliquid Core | 3 | API response containing an array of liquidation events |
| ApiResponseLiquidationLevels | HIP-3 | 2 | API response containing projected forced-liquidation levels for one snapshot. |
| ApiResponseLiquidationLevelsHistory | HIP-3 | 2 | Paginated historical liquidation-levels snapshots, ascending by snapshot_ts. |
| ApiResponseLiquidationVolumeArray | HIP-3 | 4 | API response containing an array of aggregated liquidation volumes |
| ApiResponseMarketPositionArray | HIP-3 | 8 | Open positions in a market or across markets. |
| ApiResponseMarketPositionsSummaryArray | HIP-3 | 4 | Market long/short aggregates: one point now, or one per hour. |
| ApiResponseOpenInterest | HIP-3 | 5 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseOpenInterestArray | HIP-3 | 5 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseOrderBook | HIP-3 | 7 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseOrderBookArray | HIP-3 | 7 | Generated JSON Schema contract from OpenAPI. |
| ApiResponsePositionArray | HIP-3 | 4 | Hourly position rows. |
| ApiResponsePositionChangeArray | HIP-3 | 4 | Position change log legs in timestamp order. |
| ApiResponsePositionsFreshnessArray | Data Quality | 1 | Freshness of every positions product. |
| ApiResponsePriceSnapshotArray | HIP-3 | 5 | 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 | 9 | Generated JSON Schema contract from OpenAPI. |
| ApiResponseTriggerLevels | HIP-3 | 2 | API response containing the pending trigger-order map. |
| ApiResponseTriggerLevelsHistory | HIP-3 | 2 | Paginated historical trigger-levels snapshots, ascending by snapshot_ts. |
| ApiResponseWalletClassifyData | HIP-3 | 2 | API response containing bulk wallet classification results. |
| ApiResponseWalletPositions | HIP-3 | 4 | Positions of one wallet or account. |
| ApiResponseWebhookAck | Webhooks | 4 | API response for a webhook management call that returns nothing beyond confirmation. |
| ApiResponseWebhookDeliveryArray | Webhooks | 1 | API response containing an endpoint’s delivery log. |
| ApiResponseWebhookDeliveryQueued | Webhooks | 1 | API response containing a newly queued delivery. |
| ApiResponseWebhookDryRun | Webhooks | 1 | API response containing a subscription dry-run. |
| ApiResponseWebhookEndpointArray | Webhooks | 1 | API response containing your webhook delivery endpoints. |
| ApiResponseWebhookEndpointCreated | Webhooks | 1 | API response containing a newly created endpoint and its signing secret. |
| ApiResponseWebhookEndpointSecret | Webhooks | 1 | API response containing a rotated signing secret. |
| ApiResponseWebhookEstimate | Webhooks | 1 | API response containing a subscription estimate. |
| ApiResponseWebhookEventTypeArray | Webhooks | 1 | API response containing the served webhook event catalog. |
| ApiResponseWebhookLimits | Webhooks | 1 | API response containing webhook plan limits and current usage. |
| ApiResponseWebhookRedelivery | Webhooks | 1 | API response containing a delivery queued for another attempt. |
| ApiResponseWebhookSubscription | Webhooks | 2 | API response containing one webhook subscription. |
| ApiResponseWebhookSubscriptionArray | Webhooks | 1 | API response containing your webhook subscriptions. |
| ApiResponseWebhookSubscriptionResume | Webhooks | 1 | API response for resuming one paused subscription. |
| ApiResponseWebhookSubscriptionResumeAll | Webhooks | 1 | API response for resuming every paused subscription on the account. |
| ApiResponseWebhookWatchedAddress | Webhooks | 1 | API response containing one watched wallet address. |
| ApiResponseWebhookWatchedAddressArray | Webhooks | 1 | API response containing your watched wallet addresses. |
| BreadthCounts | Shared | 0 | Auditable counts behind an aggregate Hyperliquid core perpetual or HIP-3 breadth snapshot. |
| BreadthNamespaceCounts | Shared | 0 | Per-namespace count breakdowns for the shared core and HIP-3 breadth shape. |
| BreadthSnapshot | Shared | 0 | Aggregate percentage of eligible Hyperliquid core perpetual or HIP-3 instruments trading above their current UTC-session VWAP. |
| Candle | Shared | 0 | OHLCV candle data |
| ClassifiedWallet | Shared | 0 | Wallet plus its precomputed behavior metrics. |
| CoinFreshness | Shared | 0 | Shared route-family freshness shape. |
| CoinSummary | Shared | 0 | Shared market-summary shape. |
| CompletenessMetrics | Shared | 0 | Generated JSON Schema contract from OpenAPI. |
| CoverageGap | Shared | 0 | A gap in data coverage |
| CoverageResponse | Data Quality | 2 | Overall coverage response |
| CvdBucket | Shared | 0 | Cumulative volume delta bucket. |
| 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 | Lighter | 40 | Error response |
| ExchangeCoverageResponse | Data Quality | 1 | Coverage for one venue-family key recognized by this route |
| ExchangeLatency | Shared | 0 | Latency metrics for an exchange |
| ExchangeStatus | Shared | 0 | Status of a single exchange |
| FullDepthL2OrderBook | Shared | 0 | Generated JSON Schema contract from OpenAPI. |
| FundingRate | Shared | 0 | Funding rate record |
| Hip3Instrument | Shared | 0 | HIP-3 Builder Perps instrument with latest market data. |
| Hip3OracleDiscoveryBounds | Shared | 0 | Instantaneous HIP-3 discovery bounds derived from the current reference price and max leverage. |
| Hip3OracleExternalPrice | Shared | 0 | Latest deployer-pushed external and mark price for a HIP-3 market. |
| 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). |
| Hip4Question | Shared | 0 | HIP-4 question: multi-choice resolver that groups N binary outcomes under one ballot. |
| 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) |
| L2OrderBookDiff | Shared | 0 | Full-depth L2 aggregate diff event derived from L4 deltas |
| L3Order | Shared | 0 | Individual resting order in a Lighter L3 snapshot. |
| L3OrderBookSnapshot | Shared | 0 | Current or historical Lighter L3 orderbook snapshot. |
| L4Order | Shared | 0 | Individual resting order in a Hyperliquid-family L4 snapshot. |
| L4OrderBookSnapshot | Shared | 0 | Current or reconstructed Hyperliquid-family L4 orderbook snapshot. |
| LatencyResponse | Data Quality | 1 | Latency metrics response |
| LighterInstrument | Shared | 0 | Trading instrument specification (Lighter). |
| LighterL1Account | Shared | 0 | Generated JSON Schema contract from OpenAPI. |
| LighterL1Accounts | Shared | 0 | Lighter mainnet accounts owned by one L1 address. |
| LighterLiquidation | Shared | 0 | Native Lighter liquidation event. |
| LighterTrade | Shared | 0 | Lighter trade (fill) record. |
| Liquidation | Shared | 0 | Liquidation event |
| LiquidationLevelBucket | Shared | 0 | One price bucket of projected forced-liquidation exposure. |
| LiquidationLevelsData | Shared | 0 | Projected forced-liquidation levels computed from clearinghouse positions and margin state (positions plus maintenance-margin tiers), aggregated into price buckets around the snapshot mark price. |
| LiquidationLevelsHistoryItem | Shared | 0 | One historical liquidation-levels snapshot. |
| LiquidationVolume | Shared | 0 | Aggregated liquidation volume for a time bucket |
| MarketPosition | Shared | 0 | One open position in a market-wide listing (/positions/{symbol} and bulk /positions). |
| MarketPositionsSummary | Shared | 0 | Long and short aggregates of every open position in one market at one snapshot. |
| 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 |
| Position | Shared | 0 | One open position. |
| PositionChange | Shared | 0 | One leg of the position change log: a trade, liquidation, auto-deleverage, or settlement that changed (or touched) a position, with the position before and after. |
| PositionCumulativeFunding | Shared | 0 | Cumulative funding in USD (decimal strings). |
| PositionLeverage | Shared | 0 | Leverage of a position. |
| PositionsFreshness | Shared | 0 | Freshness of one positions product. |
| PositionsMeta | Shared | 0 | Response metadata of the account positions routes. |
| PriceLevel | Shared | 0 | Single price level in the order book |
| PriceSnapshot | Shared | 0 | Price snapshot with family-applicable price fields. |
| 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. |
| StatsResponse | System | 1 | Public lightweight API/site statistics. |
| 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 |
| SymbolEntry | Shared | 0 | Public market symbol entry. |
| SymbolsResponse | System | 1 | Public symbol universe response. |
| Trade | Shared | 0 | Trade/fill record with full execution details |
| TriggerLevel | Shared | 0 | Aggregated currently open trigger orders at one rounded price bucket. |
| TriggerLevelsData | Shared | 0 | Currently pending stop-loss and take-profit trigger orders grouped into price buckets around the current mid/mark price. |
| TriggerLevelsHistoryItem | Shared | 0 | One historical trigger-levels snapshot (15-minute cadence). |
| WalletClassifyData | Shared | 0 | Bulk wallet classification response body. |
| WalletClassifyMetrics | Shared | 0 | Precomputed wallet behavior metrics. |
| WalletPositions | Shared | 0 | Positions of one wallet or account at one instant. |
| Web3ApiKey | Shared | 0 | Generated JSON Schema contract from OpenAPI. |
| Web3AuthResponse | Web3 Auth | 1 | Successful SIWE verification response for an existing wallet account. |
| Web3ChallengeRequest | Web3 Auth | 1 | Generated JSON Schema contract from OpenAPI. |
| Web3ChallengeResponse | Web3 Auth | 1 | Generated JSON Schema contract from OpenAPI. |
| Web3ErrorResponse | Web3 Auth | 3 | 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 | Shared | 0 | Legacy request shape retained for compatibility clients. |
| Web3SubscribeRequest | Web3 Auth | 1 | Generated JSON Schema contract from OpenAPI. |
| Web3SubscribeResponse | Web3 Auth | 1 | Generated JSON Schema contract from OpenAPI. |
| Web3UserInfo | Shared | 0 | Generated JSON Schema contract from OpenAPI. |
| Web3VerifyRequest | Web3 Auth | 1 | Generated JSON Schema contract from OpenAPI. |
| WebSocketLatency | Shared | 0 | Generated JSON Schema contract from OpenAPI. |
| WebhookDelivery | Shared | 0 | One delivery attempt record for one event to one endpoint. |
| WebhookDeliveryBudget | Shared | 0 | Today’s delivery budget. |
| WebhookDeliveryQueued | Shared | 0 | A delivery that has just been queued. |
| WebhookDryRun | Shared | 0 | Which occurrences in the requested window a would-be subscription would have delivered. |
| WebhookDryRunRequest | Webhooks | 1 | A would-be subscription to evaluate against recent history. |
| WebhookEndpoint | Shared | 0 | A delivery destination. |
| WebhookEndpointCreateRequest | Webhooks | 1 | A new delivery destination. |
| WebhookEndpointCreated | Shared | 0 | A newly created endpoint, including the signing secret. |
| WebhookEndpointSecret | Shared | 0 | A freshly rotated signing secret. |
| WebhookEstimate | Shared | 0 | How often a would-be subscription would have fired over the requested window. |
| WebhookEstimateBasis | Shared | 0 | How the estimate was produced, so the numbers can be read for what they are. |
| WebhookEstimateDayCount | Shared | 0 | One 24 hour bin of the estimate window. |
| WebhookEstimateDistribution | Shared | 0 | Quantiles of the primary metric over the matched occurrences, for choosing a threshold against real history. |
| WebhookEstimateRequest | Webhooks | 1 | A would-be subscription to evaluate against history. |
| WebhookEstimateRung | Shared | 0 | One rung of the threshold ladder: the daily rate the same configuration would have had at a different threshold. |
| WebhookEventType | Shared | 0 | One entry in the served webhook event catalog. |
| WebhookEventTypeMetric | Shared | 0 | A metric an event carries, and therefore a metric a subscription condition may be written against. |
| WebhookEventTypeParam | Shared | 0 | A tunable parameter declared by an event type. |
| WebhookLimitUsage | Shared | 0 | One cap: what the plan allows, what is in use, and what is left. |
| WebhookLimits | Shared | 0 | What this plan allows and what is in use, in one call. |
| WebhookPausedSubscriptions | Shared | 0 | Paused rules on the account. |
| WebhookPreviewOccurrence | Shared | 0 | One occurrence that would have been delivered, in the shape the delivered payload carries. |
| WebhookPreviewWindow | Shared | 0 | The window a preview vouches for. |
| WebhookRedelivery | Shared | 0 | A past delivery queued for another attempt. |
| WebhookResumeGap | Shared | 0 | The window a resume just closed. |
| WebhookSubscription | Shared | 0 | A rule: one event type, one configuration, delivered to one endpoint. |
| WebhookSubscriptionCondition | Shared | 0 | One condition on an event metric. |
| WebhookSubscriptionConfig | Shared | 0 | What a subscription matches on. |
| WebhookSubscriptionCreateRequest | Webhooks | 1 | A new rule. |
| WebhookSubscriptionUpdateRequest | Webhooks | 1 | Edit a rule in place. |
| WebhookWatchedAddress | Shared | 0 | A wallet on your watched list. |
| WebhookWatchedAddressCreateRequest | Webhooks | 1 | A wallet to add to your watched list. |
Component Schemas
Generated JSON Schema index for every OpenAPI component schema, including field types, references, and response envelope contracts.
Source OpenAPI: 0xArchive API 1.7.0; 218 paths; 210 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.
Last modified on September 26, 2026