Skip to content

galleonlabs/hypergrok-trading-desk / skills/hyperliquid-api-reference

hyperliquid-api-reference

Verified

Compact reference for the Hyperliquid API as the desk uses it - endpoints and envelopes, desk-used /info request types and /exchange actions with their signing schemes, order and status vocabularies, asset ids, tick and lot rules, rate limits, WebSocket subscription list, error strings, and where the official docs are. Use to look up an exact field, request type or limit before writing a call, and to map an error string to its cause.

Hyperliquid API reference (desk edition)

Desk-used contracts rechecked against the official docs and SDKs on 2026-10-25 (scope and evidence). Funding cap, mark-price inputs, market-order notionals and CEX funding intervals were rechecked on 2026-11-12 (evidence). Scoped to what the desk uses, not exhaustive. When in doubt, fetch the page: append .md to any docs URL for raw markdown, for example https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api/exchange-endpoint.md.

Endpoints

MainnetTestnet
RESThttps://api.hyperliquid.xyzhttps://api.hyperliquid-testnet.xyz
WebSocketwss://api.hyperliquid.xyz/wswss://api.hyperliquid-testnet.xyz/ws
HyperEVM RPChttps://rpc.hyperliquid.xyz/evm (chain 999)https://rpc.hyperliquid-testnet.xyz/evm (chain 998)
  • POST /info body {"type": "<request>", ...}, unsigned; response is the bare payload. Unknown type or missing field: HTTP 422; invalid JSON: HTTP 400; unknown dex: HTTP 500.
  • POST /exchange body {"action": {...}, "nonce": <ms>, "signature": {"r","s","v"}, "vaultAddress"?: "0x...", "expiresAfter"?: <ms>}; response {"status":"ok","response":{"type":"order"|"cancel"|"default"|..., "data"?: {...}}} or {"status":"err","response":"<string>"}, both HTTP 200.
  • Header Content-Type: application/json.

/info request types

typeparamsreturns
allMidsdex?{coin: midPx}
metadex?{universe:[{name, szDecimals, maxLeverage, marginTableId?, onlyIsolated?, marginMode?, isDelisted?}], marginTables:[[id,{description, marginTiers:[{lowerBound, maxLeverage}]}]], collateralToken}
metaAndAssetCtxsdex?[meta, [{funding, openInterest, prevDayPx, dayNtlVlm, dayBaseVlm, premium, oraclePx, markPx, midPx, impactPxs}]]
spotMeta{tokens:[{name, szDecimals, weiDecimals, index, tokenId, ...}], universe:[{name, tokens:[base,quote], index}]}
spotMetaAndAssetCtxs[spotMeta, [{coin, dayNtlVlm, dayBaseVlm, markPx, midPx, prevDayPx, circulatingSupply, totalSupply}]]
l2Bookcoin, nSigFigs? (2-5), mantissa? (1,2,5){coin, time, levels:[[{px,sz,n}...bids],[...asks]]} up to 20 a side
recentTradescoin[{coin, side, px, sz, time, hash, tid, users}]
candleSnapshotreq:{coin, interval, startTime, endTime}[{t,T,s,i,o,c,h,l,v,n}], most recent 5000 only
fundingHistorycoin, startTime, endTime?[{coin, fundingRate (hourly), premium, time}]
predictedFundings[[coin, [[venue, {fundingRate, nextFundingTime, fundingIntervalHours?}]]]]; venue is HlPerp, BinPerp or BybitPerp, payload null when unlisted there. Normalise by fundingIntervalHours (HlPerp always 1; CEX venues 1, 4 or 8 per coin, or omitted), never by a fixed 8
perpsAtOpenInterestCapdex?[coin]
perpDexs[null, {name, fullName, deployer, ...}]
clearinghouseStateuser, dex?{assetPositions:[{type, position:{coin, szi, entryPx, leverage{type,value,rawUsd?}, liquidationPx, marginUsed, positionValue, unrealizedPnl, returnOnEquity, cumFunding, maxLeverage}}], marginSummary{accountValue,totalNtlPos,totalRawUsd,totalMarginUsed}, crossMarginSummary, crossMaintenanceMarginUsed, withdrawable, time}
spotClearinghouseStateuser{balances:[{coin, token, hold, total, entryNtl}]}
openOrdersuser, dex?[{coin, side (A/B), limitPx, sz, oid, timestamp}]
frontendOpenOrdersuser, dex?adds origSz, cloid, orderType, tif, reduceOnly, isTrigger, triggerPx, triggerCondition, isPositionTpsl, children
orderStatususer, oid (number or cloid hex){status:"order", order:{order, status, statusTimestamp}} or {status:"unknownOid"}
historicalOrdersuser[{order, status, statusTimestamp}] up to 2000
userFillsuser, aggregateByTime?[{coin, px, sz, side, time, startPosition, dir, closedPnl, hash, oid, crossed, fee, feeToken, builderFee?, tid, cloid?, twapId}] up to 2000
userFillsByTimeuser, startTime, endTime?, aggregateByTime?same, up to 2000 per call from the last 10000
userFundinguser, startTime, endTime?[{time, hash, delta:{type:"funding", coin, usdc, szi, fundingRate, nSamples}}]
userNonFundingLedgerUpdatesuser, startTime, endTime?deposits, withdrawals, transfers, liquidations, vault flows
userTwapSliceFillsuser[{fill, twapId}]
portfoliouser[["day",{accountValueHistory, pnlHistory, vlm}], ["week",...], ["month",...], ["allTime",...], perp variants]
userFeesuser{userCrossRate, userAddRate, userSpotCrossRate, userSpotAddRate, feeSchedule, activeReferralDiscount, activeStakingDiscount}
userRateLimituser{cumVlm, nRequestsUsed, nRequestsCap, nRequestsSurplus}
userRoleuser`{role: missing
extraAgentsuser[{address, name, validUntil}]
activeAssetDatauser, coin{leverage, maxTradeSzs:[buy,sell], availableToTrade:[buy,sell], markPx}
maxBuilderFeeuser, builderinteger (tenths of a bp)
subAccountsuser[{name, subAccountUser, master, clearinghouseState, spotState}]
vaultDetailsvaultAddress, user?vault info
userVaultEquitiesuser[{vaultAddress, equity}]
referral, delegations, delegatorSummary, delegatorHistory, delegatorRewards, userAbstraction, borrowLendUserState, tokenDetails, spotDeployState, perpDexLimits, allPerpMetasniche; see docs

Pagination for time-ranged reads: 500 items per response for ledger/funding style queries; use the last time as the next startTime.

/exchange actions

L1-signed actions can be signed by an API wallet; user-signed actions need the account's main wallet (the desk never has it).

actionparamsschemedesk
order`orders:[{a,b,p,s,r,t,c?}], grouping: nanormalTpslpositionTpsl, builder?`
cancelcancels:[{a,o}], f? (fast, omit if false)L1yes
cancelByCloidcancels:[{asset, cloid}]L1yes
modify / batchModifyoid (or cloid), order:{...} / modifies:[{oid, order}]; without a (always_place) the new order must be non-trigger and rest (Alo, or a non-executable Gtc, whose tif the exchange overrides to Alo)L1yes, resting limits only
scheduleCanceltime? (ms >= now+5s)L1yes, on request
updateLeverageasset, isCross, leverageL1yes
updateIsolatedMarginasset, isBuy, ntli (USD x 1e6, negative removes)L1yes
twapOrder / twapCanceltwap:{a,b,s,r,m (minutes),t (randomise)} / a, t (twapId); 5 min to 7 days, min 100 USDL1yes, on request
noopL1rarely
reserveRequestWeightweightL1user's call
vaultTransfer, subAccountTransfer, createSubAccount, subAccountSpotTransfer, agentSendAsset, cDeposit2, agentSetAbstractionL1no
approveAgentagentAddress, agentName?userin app
approveBuilderFeemaxFeeRate, builderuserno
usdSend, spotSend, sendAsset, withdraw3, usdClassTransferuserno
cDeposit, cWithdraw, tokenDelegate, userSetAbstractionuserno

Order fields: a asset index, b isBuy, p price string, s size string, r reduceOnly, t {"limit":{"tif":"Alo"|"Ioc"|"Gtc"}} or {"trigger":{"isMarket":bool,"triggerPx":"...","tpsl":"tp"|"sl"}}, c cloid (0x + 32 hex). Order statuses: {"resting":{"oid"}}, {"filled":{"totalSz","avgPx","oid"}}, "waitingForTrigger", "waitingForFill", {"error":"..."}. Cancel statuses: "success" or {"error":"..."}.

Order status vocabulary (orderStatus, historicalOrders, WS orderUpdates): open, filled, canceled, triggered, rejected, marginCanceled, vaultWithdrawalCanceled, openInterestCapCanceled, selfTradeCanceled, reduceOnlyCanceled, siblingFilledCanceled, delistedCanceled, liquidatedCanceled, scheduledCancel, tickRejected, minTradeNtlRejected, perpMarginRejected, reduceOnlyRejected, badAloPxRejected, iocCancelRejected, badTriggerPxRejected, marketOrderNoLiquidityRejected, positionIncreaseAtOpenInterestCapRejected, positionFlipAtOpenInterestCapRejected, tooAggressiveAtOpenInterestCapRejected, openInterestIncreaseRejected, insufficientSpotBalanceRejected, oracleRejected, perpMaxPositionRejected.

Signing (what the SDKs do for you)

  • L1 actions: msgpack the action, append nonce, vault flag/address and optional expiresAfter, keccak it, sign an EIP-712 Agent {source, connectionId} under domain Exchange (chainId 1337) where source is a for mainnet and b for testnet.
  • User-signed actions: EIP-712 typed data under domain HyperliquidSignTransaction with the action's hyperliquidChain (Mainnet/Testnet) and signatureChainId; the action's nonce/time must equal the outer nonce.
  • Nonce: unix ms; per signer; must exceed the 100th-highest used and lie within (now - 2 days, now + 1 day).
  • A bad signature surfaces as User or API Wallet 0x<recovered> does not exist., not as "bad signature".
  • Addresses lowercase; numbers as strings without trailing zeros; -0 becomes 0.

Asset ids and coin names

  • Perp: index in meta.universe (default dex). Read it live; never hardcode.
  • Spot: 10000 + index in spotMeta.universe; coin name PURR/USDC or @<index>; size decimals from the base token.
  • HIP-3 perps: 100000 + 10000 x dex index + index; name dex:COIN.
  • HIP-4 outcomes: 100000000 + encoding, where encoding = 10 x outcome + side (side 0 or 1); coin #<encoding>.
  • Ids differ between mainnet and testnet.

Tick and lot

  • Price: at most 5 significant figures and at most 6 - szDecimals decimals (perps) or 8 - szDecimals (spot). Integer prices are always valid.
  • Size: rounded to szDecimals. Round down on the desk.
  • Minimum order value: 10 USD (perps) / 10 quote tokens (spot). Max market order value is $30,000,000 when max leverage is at least 25, $5,000,000 for [20, 25), $2,000,000 for [10, 20), otherwise $500,000; limit orders are 10x that.
  • Open orders per account: 1000 + 1 per 5M USDC volume, cap 5000; at 1000 open orders new reduce-only and trigger orders are rejected.

Rate limits

  • Per IP: 1200 weight per minute across REST. /exchange weight 1 + floor(n/40). /info weight 2 for l2Book, allMids, clearinghouseState, orderStatus, spotClearinghouseState, exchangeStatus; 60 for userRole; 20 for the rest; +1 per 20 items for list queries; candleSnapshot +1 per 60 candles.
  • Per address (actions): 10,000 buffer + 1 per 1 USDC cumulative volume; when exhausted, 1 action per 10 s; cancels get min(limit + 100000, 2 x limit). Stale expiresAfter rejections cost 5x. A batch of n orders or cancels counts once against the IP limit and n times against the address limit. Unified and portfolio-margin accounts are also capped at 50k user actions per day.
  • WebSocket per IP: 10 connections, 30 new per minute, 1000 subscriptions, 10 distinct users, 2000 messages per minute, 100 in-flight posts.

WebSocket

{"method":"subscribe","subscription":{...}}; heartbeat {"method":"ping"} / {"channel":"pong"}; the server closes a connection it has not sent a message to in 60 s. Types: allMids, notification, webData3, candle, l2Book, trades, orderUpdates, userEvents (channel "user"), userFills, userFundings, userNonFundingLedgerUpdates, activeAssetCtx, activeAssetData, userTwapSliceFills, userTwapHistory, twapStates, bbo, clearinghouseState, openOrders, spotState, allDexsClearinghouseState, allDexsAssetCtxs, outcomeMetaUpdates, fastAssetCtxs. Post /info or signed actions over the socket with {"method":"post","id":n,"request":{"type":"info"|"action","payload":{...}}}.

Error strings

Price must be divisible by tick size. | Order must have minimum value of $10. | Insufficient margin to place order. | Reduce only order would increase position. | Post only order would have immediately matched, bbo was ... | Order could not immediately match against any resting orders. | Invalid TP/SL price. | No liquidity available for market order. | Order price too far from oracle | Order would cause position to exceed margin tier limit at current leverage | Order was never placed, already canceled, or filled. | User or API Wallet 0x... does not exist. | Must deposit before performing actions. User: 0x... | Invalid TWAP duration: ...

Trading facts the desk quotes

  • Funding: hourly, peer to peer, computed from an 8h formula paid 1/8 each hour, capped at 0.5% per hour independent of the asset, paid on oracle price; API rates are hourly.
  • Mark price is the median of (oracle + 150s EMA of mid minus oracle), the median of best bid, best ask and last trade, and the median of Binance, OKX, Bybit, Gate IO and MEXC perp mids (weights 3, 2, 2, 1, 1). When only two of those inputs exist, the 30s EMA of the Hyperliquid median is included too. It drives margining, liquidation, unrealized PnL and TP/SL triggers.
  • Maintenance margin = half the initial margin at the tier's max leverage; partial liquidations first for large positions; cross liquidation price ignores the leverage setting.
  • Fees: base taker 0.045% / maker 0.015% perps, 0.07% / 0.04% spot, tiered by 14-day volume, staking and referral discounts; account base rates via userFees; apply referral, aligned-quote, stable-pair and HIP-3 deployer/growth modifiers for the market. Actual fill fees remain the reconciliation source.
  • Testnet: same API; faucet at app.hyperliquid-testnet.xyz/drip (needs an address that has deposited on mainnet); much tighter margin tiers; asset ids differ.

Official pages worth fetching

for-developers/api/info-endpoint, .../info-endpoint/perpetuals, .../info-endpoint/spot, .../exchange-endpoint, .../signing, .../nonces-and-api-wallets, .../rate-limits-and-user-limits, .../tick-and-lot-size, .../asset-ids, .../error-responses, .../websocket/subscriptions, .../websocket/post-requests; trading/order-types, trading/take-profit-and-stop-loss-orders-tp-sl, trading/margining, trading/margin-tiers, trading/liquidations, trading/funding, trading/fees, trading/contract-specifications, trading/robust-price-indices, trading/sub-accounts; onboarding/testnet-faucet. All under https://hyperliquid.gitbook.io/hyperliquid-docs/.

rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization.Stars: 467kUpdated Claude CodeCodexVerifiedInstall
academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content.Stars: 196kUpdated Claude CodeCodexVerifiedInstall
claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file).Stars: 196kUpdated Claude CodeCodexUnverifiedInstall
doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks.Stars: 196kUpdated Claude CodeCodexVerifiedInstall