Skip to main content
Glama

Server Configuration

Describes the environment variables required to run the server.

NameRequiredDescriptionDefault
OXARCHIVE_API_KEYNo0xArchive API key (format: 0xa_...). Get one free at https://0xarchive.io

Capabilities

Features and capabilities supported by this server

CapabilityDetails
tools
{
  "listChanged": true
}

Tools

Functions exposed to the LLM to take actions

NameDescription
get_instrumentsA

List all available Hyperliquid perpetual and spot instruments with leverage, decimals, and active status. Use this to discover valid coin symbols before querying other endpoints.

get_instrumentA

Get details for a single Hyperliquid instrument by coin symbol. Returns leverage, decimals, and active status.

get_orderbookA

Get the current Hyperliquid L2 orderbook snapshot for a coin. Returns bids, asks, mid price, and spread. Optionally specify depth (price levels per side). Requires Pro tier or higher for full depth.

get_orderbook_historyA

Get historical Hyperliquid orderbook snapshots (~1.2s resolution). Returns L2 snapshots with bids/asks over a time range. Data available from April 2023. Free: BTC only (20 levels). Build+: all symbols (200 levels). Pro+: full depth.

get_tradesA

Get Hyperliquid trade/fill history for a coin over a time range. Returns price, size, side, timestamps, and user addresses. Data available from April 2023. Supports cursor pagination.

get_candlesA

Get Hyperliquid OHLCV candle data for a coin. Intervals: 1m, 5m, 15m, 30m, 1h, 4h, 1d, 1w (default 1h). Returns open, high, low, close, volume. Data available from April 2023.

get_funding_currentA

Get the current Hyperliquid funding rate for a coin. Returns the latest funding rate, premium, and timestamp.

get_funding_historyA

Get Hyperliquid funding rate history for a coin over a time range. Returns timestamped funding rates and premiums. Data available from May 2023. Supports aggregation intervals (5m, 15m, 30m, 1h, 4h, 1d).

get_open_interestA

Get the current Hyperliquid open interest for a coin. Returns OI, mark price, oracle price, and 24h volume.

get_open_interest_historyA

Get Hyperliquid open interest history for a coin over a time range. Returns timestamped OI snapshots with mark/oracle prices. Data available from May 2023. Supports aggregation intervals (5m, 15m, 30m, 1h, 4h, 1d).

get_liquidationsA

Get Hyperliquid liquidation history for a coin over a time range. Returns liquidated/liquidator addresses, price, size, side, and PnL. Data available from May 2025. Real-time liquidations are also available on the WebSocket liquidations channel — each event is a fill row with is_liquidation: true, same shape as the trades channel.

get_liquidations_by_userA

Get Hyperliquid liquidation history for a specific user address. Returns liquidations where the user was either liquidated or was the liquidator. Filter by coin optionally.

get_liquidation_volumeA

Get aggregated liquidation volume for a coin in time-bucketed intervals. Returns total, long, and short USD volumes. Data available from May 2025.

get_freshnessA

Get data freshness for a coin across all data types (orderbook, trades, funding, OI, liquidations). Shows when each data type was last updated and current lag.

get_summaryA

Get combined market summary for a coin in a single call. Returns mark price, oracle price, funding rate, open interest, 24h volume, and 24h liquidation volumes.

get_price_historyB

Get mark/oracle price history for a coin over a time range. Returns mark_price, oracle_price, and mid_price at each timestamp. Supports aggregation intervals. Data available from May 2023.

get_hip3_instrumentsA

List all available HIP-3 builder perp instruments on Hyperliquid. HIP-3 symbols are CASE-SENSITIVE (e.g. 'km:US500', 'km:TSLA'). Use this to discover valid symbols before querying HIP-3 data.

get_hip3_instrumentA

Get details for a single HIP-3 instrument. Symbols are CASE-SENSITIVE (e.g. 'km:US500'). Returns mark price, open interest, mid price, and latest timestamp.

get_hip3_orderbookA

Get the current HIP-3 orderbook snapshot. Symbols are CASE-SENSITIVE (e.g. 'km:US500'). Returns bids, asks, mid price. Free tier: km:US500 only. Build+: all HIP-3 symbols.

get_hip3_orderbook_historyA

Get historical HIP-3 orderbook snapshots. Symbols are CASE-SENSITIVE (e.g. 'km:US500'). Returns L2 snapshots with bids/asks over a time range. Free tier: km:US500 only. Build+: all HIP-3 symbols.

get_hip3_tradesA

Get HIP-3 trade history. Symbols are CASE-SENSITIVE (e.g. 'km:US500'). Returns trades with price, size, side, and timestamps over a time range. Supports cursor pagination.

get_hip3_trades_recentA

Get most recent HIP-3 trades. Symbols are CASE-SENSITIVE (e.g. 'km:US500'). Returns the latest trades without needing a time range.

get_hip3_candlesA

Get HIP-3 OHLCV candle data. Symbols are CASE-SENSITIVE (e.g. 'km:US500'). Intervals: 1m to 1w (default 1h). Returns open, high, low, close, volume.

get_hip3_funding_currentA

Get the current HIP-3 funding rate for a coin. Symbols are CASE-SENSITIVE (e.g. 'km:US500'). Returns the latest funding rate and timestamp.

get_hip3_fundingA

Get HIP-3 funding rate history. Symbols are CASE-SENSITIVE (e.g. 'km:US500'). Returns timestamped funding rates over a time range. Supports cursor pagination and aggregation intervals (5m, 15m, 30m, 1h, 4h, 1d).

get_hip3_open_interestA

Get the current HIP-3 open interest for a coin. Symbols are CASE-SENSITIVE (e.g. 'km:US500'). Returns OI, mark price, and oracle price.

get_hip3_open_interest_historyA

Get HIP-3 open interest history over a time range. Symbols are CASE-SENSITIVE (e.g. 'km:US500'). Returns timestamped OI snapshots.

get_hip3_liquidationsA

Get HIP-3 liquidation events for a coin over a time range. Returns liquidated/liquidator addresses, price, size, side, and PnL. Symbols are CASE-SENSITIVE (e.g. 'km:US500'). Data available from February 2026. Real-time HIP-3 liquidations are also available on the WebSocket hip3_liquidations channel — each event is a fill row with is_liquidation: true, same shape as the hip3_trades channel.

get_hip3_liquidation_volumeB

Get aggregated HIP-3 liquidation volume for a coin in time-bucketed intervals. Returns total, long, and short USD volumes. Symbols are CASE-SENSITIVE (e.g. 'km:US500'). Data available from February 2026.

get_lighter_instrumentsA

List all available Lighter.xyz instruments with market IDs, fees, size/price decimals, and active status. Use this to discover valid Lighter symbols.

get_lighter_instrumentA

Get details for a single Lighter.xyz instrument by coin symbol. Returns market ID, fees, size/price decimals, and active status.

get_lighter_orderbookA

Get the current Lighter.xyz orderbook snapshot for a coin. Returns bids, asks, mid price, and spread. Optionally specify depth. Requires Pro tier for full depth.

get_lighter_orderbook_historyA

Get historical Lighter.xyz orderbook snapshots. Returns L2 snapshots with bids/asks over a time range. Supports granularity levels: checkpoint (default), 30s, 10s, 1s, tick.

get_lighter_tradesA

Get Lighter.xyz trade history for a coin over a time range. Returns price, size, side, and timestamps. Supports cursor pagination.

get_lighter_trades_recentA

Get most recent Lighter.xyz trades for a coin. Returns the latest trades without needing a time range.

get_lighter_candlesA

Get Lighter.xyz OHLCV candle data for a coin. Intervals: 1m to 1w (default 1h). Returns open, high, low, close, volume.

get_lighter_funding_currentA

Get the current Lighter.xyz funding rate for a coin. Returns the latest funding rate and timestamp.

get_lighter_fundingA

Get Lighter.xyz funding rate history for a coin over a time range. Returns timestamped funding rates. Supports cursor pagination and aggregation intervals (5m, 15m, 30m, 1h, 4h, 1d).

get_lighter_open_interestA

Get the current Lighter.xyz open interest for a coin. Returns OI, mark price, and oracle price.

get_lighter_open_interest_historyA

Get Lighter.xyz open interest history for a coin over a time range. Returns timestamped OI snapshots.

get_lighter_freshnessA

Get data freshness for a Lighter.xyz coin across all data types (orderbook, trades, funding, OI). Shows when each data type was last updated and current lag.

get_lighter_summaryA

Get combined Lighter.xyz market summary for a coin in a single call. Returns mark price, oracle price, funding rate, and open interest.

get_lighter_price_historyA

Get mark/oracle price history for a Lighter.xyz coin over a time range. Returns mark_price, oracle_price, and mid_price at each timestamp. Supports aggregation intervals.

get_hip3_freshnessA

Get data freshness for a HIP-3 coin across all data types (orderbook, trades, funding, OI). Symbols are CASE-SENSITIVE (e.g. 'km:US500'). Shows when each data type was last updated and current lag.

get_hip3_summaryA

Get combined HIP-3 market summary for a coin in a single call. Symbols are CASE-SENSITIVE (e.g. 'km:US500'). Returns mark price, oracle price, mid price, funding rate, and open interest.

get_hip3_price_historyA

Get mark/oracle/mid price history for a HIP-3 coin over a time range. Symbols are CASE-SENSITIVE (e.g. 'km:US500'). Returns mark_price, oracle_price, and mid_price at each timestamp. Supports aggregation intervals.

get_lighter_l3_orderbookA

Get Lighter L3 order-level orderbook (Pro+ tier). Returns individual orders with order IDs, user addresses, prices, and sizes.

get_lighter_l3_orderbook_historyA

Get historical Lighter L3 orderbook snapshots (Pro+ tier). Returns order-level snapshots with individual order IDs, user addresses, prices, and sizes over a time range.

get_order_historyA

Get Hyperliquid order history with user attribution (Build+ tier). Returns order lifecycle events including placements, fills, cancellations, and modifications with user addresses.

get_order_flowA

Get Hyperliquid order flow aggregation (Build+ tier). Returns aggregated order placement, cancellation, and fill metrics over time intervals.

get_tpslA

Get Hyperliquid TP/SL order history (Pro+ tier). Returns take-profit and stop-loss orders with trigger prices, user addresses, and triggered status.

get_l4_orderbookB

Get Hyperliquid L4 orderbook reconstruction (Pro+ tier). Returns full order-level orderbook at a specific timestamp with individual order IDs, user addresses, prices, and sizes.

get_l4_diffsA

Get Hyperliquid L4 orderbook diffs (Pro+ tier). Returns raw order-level changes (new orders, modifications, cancellations, fills) over a time range.

get_l4_orderbook_historyA

Get Hyperliquid L4 orderbook checkpoints (Pro+ tier). Returns periodic full order-level orderbook snapshots over a time range for reconstruction.

get_l2_orderbookA

Get Hyperliquid L2 full-depth orderbook (Build+ tier). Returns aggregated price levels with total size and order count per level. Derived from L4 data. Data from March 2026+.

get_l2_orderbook_historyA

Get Hyperliquid L2 full-depth orderbook checkpoints (Build+ tier). Returns periodic aggregated orderbook snapshots over a time range.

get_l2_diffsA

Get Hyperliquid L2 tick-level orderbook diffs (Pro+ tier). Returns price-level changes over a time range.

get_hip3_order_historyA

Get HIP-3 order history with user attribution (Build+ tier). Symbols are CASE-SENSITIVE (e.g. 'km:US500'). Returns order lifecycle events with user addresses.

get_hip3_order_flowA

Get HIP-3 order flow aggregation (Build+ tier). Symbols are CASE-SENSITIVE (e.g. 'km:US500'). Returns aggregated order placement, cancellation, and fill metrics.

get_hip3_tpslA

Get HIP-3 TP/SL order history (Pro+ tier). Symbols are CASE-SENSITIVE (e.g. 'km:US500'). Returns take-profit and stop-loss orders with trigger prices and triggered status.

get_hip3_l4_orderbookA

Get HIP-3 L4 orderbook reconstruction (Pro+ tier). Symbols are CASE-SENSITIVE (e.g. 'km:US500'). Returns full order-level orderbook at a specific timestamp.

get_hip3_l4_diffsA

Get HIP-3 L4 orderbook diffs (Pro+ tier). Symbols are CASE-SENSITIVE (e.g. 'km:US500'). Returns raw order-level changes over a time range.

get_hip3_l4_orderbook_historyA

Get HIP-3 L4 orderbook checkpoints (Pro+ tier). Symbols are CASE-SENSITIVE (e.g. 'km:US500'). Returns periodic full order-level orderbook snapshots.

get_hip3_l2_orderbookB

Get HIP-3 L2 full-depth orderbook (Build+ tier). Symbols are CASE-SENSITIVE (e.g. 'km:US500'). Returns aggregated price levels. Derived from L4 data.

get_hip3_l2_orderbook_historyA

Get HIP-3 L2 full-depth orderbook checkpoints (Build+ tier). Symbols are CASE-SENSITIVE. Returns periodic aggregated snapshots.

get_hip3_l2_diffsA

Get HIP-3 L2 tick-level orderbook diffs (Pro+ tier). Symbols are CASE-SENSITIVE. Returns price-level changes.

get_spot_pairsA

List all Hyperliquid Spot pairs with metadata (base/quote asset, wire symbol, asset index, decimals, latest mark/mid price, active status). 294 pairs available. Symbols are dashed canonical (e.g. 'HYPE-USDC', 'PURR-USDC'). Use this to discover valid spot pair symbols before querying other spot tools.

get_spot_pairA

Get details for a single Hyperliquid Spot pair by dashed canonical symbol (e.g. 'HYPE-USDC'). Returns base/quote asset, wire symbol, asset index, decimals, latest mark/mid price, and active status.

get_spot_orderbookA

Get the current Hyperliquid Spot L2 orderbook snapshot for a pair. Symbols are dashed canonical (e.g. 'HYPE-USDC'). Returns bids, asks, mid price, and spread. Optionally specify depth (price levels per side). Live from 2026-05-05. Pro+ tier required for full depth.

get_spot_orderbook_historyA

Get historical Hyperliquid Spot L2 orderbook snapshots over a time range. Symbols are dashed canonical (e.g. 'HYPE-USDC'). Returns L2 snapshots with bids/asks. Live coverage from 2026-05-05 (no historical backfill before that date because Hyperliquid does not publish historical spot orderbook data). Build+ tier required for non-default depth.

get_spot_tradesA

Get Hyperliquid Spot trade/fill history for a pair over a time range. Symbols are dashed canonical (e.g. 'HYPE-USDC'). Returns price, size, side, timestamps, and user addresses. S3 backfill from 2025-03-22 (the earliest published date); live since. Supports cursor pagination and optional user wallet filter.

get_spot_trades_recentA

Get the most recent Hyperliquid Spot trades for a pair. Symbols are dashed canonical (e.g. 'HYPE-USDC'). Returns the latest trades without needing a time range. Live since 2026-05-05.

get_spot_order_historyA

Get Hyperliquid Spot order lifecycle events with user attribution (Pro+ tier). Symbols are dashed canonical (e.g. 'HYPE-USDC'). Returns placements, fills, cancellations, and modifications with user addresses. Live from 2026-05-05.

get_spot_l4_orderbookA

Get Hyperliquid Spot L4 orderbook reconstruction at a specific timestamp (Pro+ tier). Symbols are dashed canonical (e.g. 'HYPE-USDC'). Returns the full order-level orderbook with individual order IDs, user addresses, prices, and sizes. Live from 2026-05-05.

get_spot_l4_diffsA

Get Hyperliquid Spot L4 orderbook diffs (Pro+ tier). Symbols are dashed canonical (e.g. 'HYPE-USDC'). Returns raw order-level changes (new orders, modifications, cancellations, fills) over a time range. Live from 2026-05-05.

get_spot_l4_orderbook_historyA

Get Hyperliquid Spot L4 orderbook checkpoints (Build+ tier). Symbols are dashed canonical (e.g. 'HYPE-USDC'). Returns periodic full order-level orderbook snapshots over a time range for reconstruction. Live from 2026-05-05.

get_spot_twap_by_symbolA

Get Hyperliquid Spot TWAP statuses for a single pair (every TWAP touching this pair). Symbols are dashed canonical (e.g. 'HYPE-USDC'). Returns timestamped TWAP status records with twap_id, user_address, side, size, filled_size, status, and execution metadata. Sourced from the L4 order stream. Live from 2026-05-05.

get_spot_twap_by_userA

Get Hyperliquid Spot TWAP statuses for a single user wallet across every spot pair. Returns timestamped TWAP status records with coin, twap_id, side, size, filled_size, status, and execution metadata. Sourced from the L4 order stream. Live from 2026-05-05.

get_spot_freshnessA

Get per-pair data freshness for Hyperliquid Spot across all data types (orderbook, trades, L4, TWAP). Symbols are dashed canonical (e.g. 'HYPE-USDC'). Shows when each data type was last updated and current lag.

get_hip4_instrumentsA

List all available HIP-4 outcome-market instruments (one row per side, e.g. '0', '1'). HIP-4 coins use the bare numeric format '<10*outcome_id + side>' (legacy '#0' / '%230' forms also accepted). Use this to discover valid HIP-4 symbols.

get_hip4_instrumentA

Get details for a single HIP-4 instrument by coin symbol (e.g. '0'). Bare numeric coins are canonical; legacy '#0' / '%230' forms are also accepted.Returns per-side metadata including outcome_id, side, asset_id, name, recurring class/underlying/expiry, builder address, and is_settled status.

get_hip4_outcomesA

List HIP-4 outcome markets aggregated across both sides. Optionally filter by settlement status. Each outcome groups its '<10id>' Yes / '<10id+1>' No sides. Listen for the WebSocket outcome_settled event to get notified when an outcome resolves. The list response omits aggregated_oi; use get_hip4_outcome for the OI snapshot.

get_hip4_outcomeA

Get a single HIP-4 outcome by outcome_id. Returns the full Hip4OutcomeAggregate including aggregated_oi (latest both-sides OI snapshot, paired set supply, parity, and currency).

get_hip4_orderbookA

Get the current HIP-4 L2 orderbook snapshot for a coin (e.g. '0'). Bare numeric coins are canonical; legacy '#0' / '%230' forms are also accepted.Returns bids and asks. Note: mark_price for HIP-4 is an implied probability (0..1), not a USD price. Pro+ tier required.

get_hip4_orderbook_historyA

Get historical HIP-4 L2 orderbook snapshots for a coin (e.g. '0'). Bare numeric coins are canonical; legacy '#0' / '%230' forms are also accepted.Returns L2 snapshots over a time range. Pro+ tier required.

get_hip4_tradesA

Get HIP-4 trade/fill history for a coin (e.g. '0'). Bare numeric coins are canonical; legacy '#0' / '%230' forms are also accepted.Returns price, size, side, and timestamps over a time range. Supports cursor pagination.

get_hip4_trades_recentA

Get the most recent HIP-4 trades for a coin (e.g. '0'). Bare numeric coins are canonical; legacy '#0' / '%230' forms are also accepted.Returns the latest trades without needing a time range.

get_hip4_open_interestA

Get HIP-4 per-side open interest history for a coin (e.g. '0'). Bare numeric coins are canonical; legacy '#0' / '%230' forms are also accepted.Returns timestamped OI snapshots; mark_price is an implied probability (0..1). For paired-set / display OI use get_hip4_outcome.

get_hip4_open_interest_currentA

Get the current HIP-4 per-side open interest for a coin (e.g. '0'). Bare numeric coins are canonical; legacy '#0' / '%230' forms are also accepted.Returns the latest OI row; mark_price is an implied probability (0..1). For paired-set / display OI use get_hip4_outcome.

get_hip4_freshnessA

Get HIP-4 data freshness for a coin (e.g. '0') across all available data types (orderbook, trades, OI, L4). Bare numeric coins are canonical; legacy '#0' / '%230' forms are also accepted.Shows when each data type was last updated and current lag.

get_hip4_summaryA

Get a combined HIP-4 24h market summary for a coin (e.g. '0'). Bare numeric coins are canonical; legacy '#0' / '%230' forms are also accepted.Returns price, volume, and OI aggregates. mark_price is an implied probability (0..1), not USD.

get_hip4_pricesA

Get HIP-4 mid-price (implied probability, 0..1) history for a coin (e.g. '0'). Bare numeric coins are canonical; legacy '#0' / '%230' forms are also accepted.Returns timestamped price snapshots over a time range with cursor pagination.

get_hip4_order_historyA

Get HIP-4 order lifecycle events with user attribution (Pro+ tier) for a coin (e.g. '0'). Bare numeric coins are canonical; legacy '#0' / '%230' forms are also accepted.Returns placements, fills, cancellations, modifications.

get_hip4_order_flowA

Get HIP-4 order flow aggregation (Pro+ tier) for a coin (e.g. '0'). Bare numeric coins are canonical; legacy '#0' / '%230' forms are also accepted.Returns time-bucketed order placement, cancellation, and fill metrics.

get_hip4_tpslA

Get HIP-4 TP/SL order history (Pro+ tier) for a coin (e.g. '0'). Bare numeric coins are canonical; legacy '#0' / '%230' forms are also accepted.Returns take-profit and stop-loss orders with trigger prices and triggered status.

get_hip4_l4_orderbookA

Get HIP-4 L4 orderbook reconstruction (Pro+ tier) for a coin (e.g. '0'). Bare numeric coins are canonical; legacy '#0' / '%230' forms are also accepted.Returns the full order-level orderbook at a specific timestamp with individual order IDs, user addresses, prices, and sizes.

get_hip4_l4_diffsA

Get HIP-4 L4 orderbook diffs (Pro+ tier) for a coin (e.g. '0'). Bare numeric coins are canonical; legacy '#0' / '%230' forms are also accepted.Returns raw order-level changes (new orders, modifications, cancellations, fills) over a time range.

get_hip4_l4_orderbook_historyC

Get HIP-4 L4 orderbook checkpoints (Build+ tier) for a coin (e.g. '0'). Bare numeric coins are canonical; legacy '#0' / '%230' forms are also accepted.Returns periodic full order-level snapshots. Hard cap limit=10 per request.

get_data_quality_statusA

Get the current system status for supported venue APIs and data types. Returns overall health (operational/degraded/outage), per-scope status with latency, per-data-type completeness, and active incident count.

get_data_coverageA

Get data coverage across supported venue APIs. Returns earliest/latest timestamps, total records, symbol count, resolution, lag, and completeness per data type per venue scope.

Prompts

Interactive templates invoked by user choice

NameDescription

No prompts

Resources

Contextual data attached and managed by the client

NameDescription

No resources

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/0xArchiveIO/0xarchive-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server