最后更新于 2026年6月16日
Hyperliquid API 端点速查:clearinghouseState、candleSnapshot 等参数详解
这是一份按端点组织的速查表,方便你直接搜某个 type(比如 clearinghouseState、candleSnapshot)查它的请求参数和返回字段。完整协议说明看 API 概览,纯 Python 用法看 Python SDK 文档。
所有 Info 端点都是 POST https://api.hyperliquid.xyz/info,请求体里用 type 字段区分。
⚠️ 原始 type 名 vs SDK 方法名
你在搜索里看到的 clearinghouseState、candleSnapshot 是 API 的原始 type 名。Python SDK 把它们封装成了更顺口的方法名(如 info.user_state()),下面每个端点都标了对应关系,两边对得上。
Info API 端点
clearinghouseState — 永续账户状态
用户最常查的端点,返回永续合约账户的保证金、持仓、账户总价值。注意原始 type 名是 clearinghouseState,不是 userState。
请求
{ "type": "clearinghouseState", "user": "0xYourAddress" }
返回关键字段
| 字段 | 含义 |
|---|---|
marginSummary.accountValue | 账户总价值(USDC) |
marginSummary.totalRawUsd | 持仓和余额的原始美元值 |
crossMarginSummary | 全仓保证金汇总 |
assetPositions[].position | 每个持仓:coin 币种、szi 仓位大小、entryPx 开仓均价、unrealizedPnl 浮盈 |
withdrawable | 可提现金额 |
SDK 方法:info.user_state(address)
现货账户用
spotClearinghouseState,返回结构里是balances数组。
candleSnapshot — K 线历史
拉历史 K 线做回测或画图。
请求
{
"type": "candleSnapshot",
"req": {
"coin": "ETH",
"interval": "1h",
"startTime": 1730000000000,
"endTime": 1730100000000
}
}
interval 可选:1m 5m 15m 1h 4h 1d 等。时间是毫秒时间戳。
返回关键字段:数组,每根 K 线含 t(开始时间)、o h l c(开高低收)、v(成交量)、n(成交笔数)。
SDK 方法:info.candles_snapshot(coin, interval, startTime, endTime)
l2Book — L2 订单簿
请求
{ "type": "l2Book", "coin": "ETH" }
返回关键字段:levels 是两个数组 [bids, asks],每档含 px(价格)、sz(数量)、n(订单数)。
SDK 方法:info.l2_snapshot(coin)
allMids — 所有中间价
请求
{ "type": "allMids" }
返回:一个对象,键是币种、值是中间价字符串,如 {"ETH": "3001.5", "BTC": "62000.0"}。适合快速取价,比订单簿轻量。
SDK 方法:info.all_mids()
metaAndAssetCtxs — 元数据 + 实时行情
一次拿到所有交易对的元数据和实时上下文(标记价、资金费率、未平仓量)。
请求
{ "type": "metaAndAssetCtxs" }
返回:长度为 2 的数组。[0].universe 是交易对元数据;[1] 是对应的实时上下文,每项含 markPx(标记价)、funding(资金费率)、openInterest(未平仓)、dayNtlVlm(24h 成交额)。
SDK 方法:info.meta_and_asset_ctxs()
meta — 交易对元数据
请求:{ "type": "meta" }
返回:universe 数组,每个交易对含 name、maxLeverage(最大杠杆)、szDecimals(数量精度)。
SDK 方法:info.meta()
用户相关端点
下面这些都需要传 user 地址。
| type | 用途 | SDK 方法 |
|---|---|---|
openOrders | 当前所有挂单 | info.open_orders(addr) |
userFills | 成交历史 | info.user_fills(addr) |
userFunding | 资金费率收付历史 | info.user_funding(addr, start, end) |
historicalOrders | 历史订单 | info.historical_orders(addr) |
userRateLimit | 当前速率限制状态 | — |
subAccounts | 子账户列表 | — |
Exchange API 端点
所有交易操作走 POST /exchange,请求体含 action、nonce(毫秒时间戳)、signature。每个请求都要钱包签名,建议直接用 Python SDK 处理签名,别手动拼。
| action | 用途 | SDK 方法 |
|---|---|---|
order | 下单(单笔或批量) | exchange.order(...) / market_open(...) |
cancel | 按 oid 撤单 | exchange.cancel(coin, oid) |
cancelByCloid | 按客户端订单 ID 撤单 | exchange.cancel_by_cloid(...) |
modify | 改单 | exchange.modify_order(...) |
updateLeverage | 调整杠杆 | exchange.update_leverage(...) |
usdSend | 转账 USDC | exchange.usd_transfer(...) |
withdraw3 | 提现 | exchange.withdraw_from_bridge(...) |
vaultTransfer | 金库存取 | exchange.vault_usd_transfer(...) |
approveAgent | 授权 agent wallet | exchange.approve_agent() |
approveBuilderFee | 授权 builder code 抽成 | exchange.approve_builder_fee(...) |
🚨 价格精度
下单的 px 必须按交易对的 tick size 取整,否则会被 Invalid price 拒掉。szDecimals 从 meta 端点拿。
相关页面
- API 概览 — 完整协议、认证、WebSocket、速率限制
- Python SDK 文档 — 安装和完整代码示例
- 交易机器人 — 用这些端点搭自动化系统