跳至正文
OpenAgentSkill
浏览已开放 · 目录记录日期 2026-11-21 · 自动更新和账户服务暂时关闭。
设计与 UI

hyperliquid-api-reference

Compact reference for the Hyperliquid API as the desk uses it - endpoints and envelopes, every /info request type, every /exchange action with its signing scheme, 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.

Galleon Labs · 已有静态检查记录

安装与使用

运行命令前先阅读来源与依赖说明。复制命令不会自动安装或执行。

npx skills add galleonlabs/hypergrok-trading-desk --skill hyperliquid-api-reference

技能说明


name: hyperliquid-api-reference description: Compact reference for the Hyperliquid API as the desk uses it - endpoints and envelopes, every /info request type, every /exchange action with its signing scheme, 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. license: MIT metadata: version: "1.0.0" author: Galleon Labs category: hyperliquid docs: https://hyperliquid.gitbook.io/hyperliquid-docs/for-developers/api

Hyperliquid API reference (desk edition)

Verified against the official docs on 2026-08-16. 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.
  • 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}]}]]}
metaAndAssetCtxsdex?[meta, [{funding, openInterest, prevDayPx, dayNtlVlm, premium, oraclePx, markPx, midPx, impactPxs}]]
spotMeta{tokens:[{name, szDecimals, weiDecimals, index, tokenId, ...}], universe:[{name, tokens:[base,quote], index}]}
spotMetaAndAssetCtxs[spotMeta, [{dayNtlVlm, markPx, midPx, prevDayPx, circulatingSupply}]]
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}]
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 1; CEX venues 4 or 8 per coin), 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?}] 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 ledge

阅读完整来源 ↗