Skip to main content

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 builder perps are Hyperliquid-scoped markets with their own route family. Use /v1/hyperliquid/hip3/* when the symbol carries a builder prefix, such as km:US500, or when the product needs builder-perp history, depth, funding, OI, liquidations, or L4/order-level data.

Symbol Pattern

HIP-3 symbols commonly use a builder prefix, for example:
km:US500

First Request

curl "https://api.0xarchive.io/v1/hyperliquid/hip3/trades/km:US500" \
  -H "X-API-Key: $OXARCHIVE_API_KEY"

Common Work

Builder-perp market history

Pull bounded windows of trades, candles, funding, OI, or depth.

Venue selection

Keep HIP-3 market routing explicit in your client.

Symbol Handling

Preserve the builder prefix in stored records and generated code. A value such as km:US500 is not the same kind of instrument as a core Hyperliquid BTC symbol, even though both live under the Hyperliquid top-level venue. Store venue_family=hip3 or an equivalent field when you persist results. HIP-3 jobs often need the same data families as core perps: order books, trades, candles, funding, open interest, liquidations, and freshness. The difference is namespace and symbol semantics. Use the generated reference for exact routes and parameters, then check Data Quality before exporting or modeling long windows.

HIP-3 Request Packet

Use this packet before a HIP-3 symbol enters code, tests, fixtures, or an agent prompt.
FieldHIP-3 value
Namespace/v1/hyperliquid/hip3/*
Symbol styleBuilder-prefixed symbols such as km:US500
Stored contextPreserve the prefix and a HIP-3 venue-family field
First probeInstrument lookup, one trades page, one order-book request, or one freshness check
Stop ruleDo not strip the prefix or fall back to /v1/hyperliquid/* because the market resembles a perp

Product Uses

Use HIP-3 pages for builder-deployed perps, RWA-style markets, indices, or other prefixed instruments that should not be collapsed into core perps. For generic Hyperliquid BTC or ETH, use Hyperliquid REST API. For Lighter, use Lighter REST API.

Prefix Failures

Do not strip the builder prefix. Do not URL-decode a colon in a way that changes the symbol. Do not substitute a core Hyperliquid route because the market “looks like a perp.” If a user provides a namespaced symbol and does not specify a venue, HIP-3 is the first family to inspect. Open Venue Coverage for family selection, Markets for public market-family context, or Best HIP-3 Data API for the buying-context page.

Generated Client Guidance

HIP-3 is Hyperliquid-scoped but not the same route family as core Hyperliquid perps. Use the HIP-3 prefix in generated code, comments, logs, and tests. If a test strips the prefix, the test is weakening the most important HIP-3 routing rule. Leave fixture symbols namespaced. Use km:US500 as the default example unless a user names another builder market.
Last modified on May 18, 2026