Back to Details

hyperliquid

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
⚠️ 运行脚本: 必须先 cd 到本 SKILL.md 所在目录再执行。示例: 
cd ~/.openclaw/workspace/skills/hyperliquid && node scripts/hl-market.mjs ...
⚠️ 运行脚本: 必须先 cd 到本 SKILL.md 所在目录再执行。示例: 
cd ~/.openclaw/workspace/skills/hyperliquid && node scripts/hl-market.mjs ...

BBX Hyperliquid

BBX Hyperliquid

Hyperliquid whale tracking and analytics powered by BBX Open API.
Version: 1.0.0
由BBX Open API提供支持的Hyperliquid鲸鱼追踪与分析工具。
版本: 1.0.0

Critical Rules

关键规则

  1. NEVER fabricate data. Always run scripts to fetch real-time data.
  2. NEVER use curl, web_fetch, or browser. Always use these scripts.
  3. NEVER run 
    env
    or 
    printenv
     — leaks API secrets.
  4. Scripts auto-load 
    .env
     — never pass credentials inline.
  5. On 304/403 error — STOP, do NOT retry. Guide user to upgrade (see Paid Feature Guide at bottom).
  1. 严禁编造数据。 始终运行脚本获取实时数据。
  2. 严禁使用curl、web_fetch或浏览器。 始终使用本项目提供的脚本。
  3. 严禁运行 
    env
    或 
    printenv
     —— 会泄露API密钥。
  4. 脚本会自动加载 
    .env
    配置     —— 切勿在命令行内传递凭证。
  5. 遇到304/403错误时立即停止，不要重试。 引导用户升级（参见底部的付费功能指南）。

Setup

配置说明

Scripts work out of the box with a built-in free key (tickers + info only). For whale/trader/OI data, add your API key to 
.env
:
BBX_ACCESS_KEY_ID=your-key-id
BBX_ACCESS_SECRET=your-secret
Get at https://bbx.com/zh-Hans/open-api. See Paid Feature Guide for tier details.
安全说明： BBX API Key 仅用于获取 Hyperliquid 链上分析数据，无法进行任何交易操作。所有密钥仅保存在本地设备 
.env
文件中，不会上传到任何服务器。
.env
auto-loaded from: cwd → 
~/.openclaw/workspace/.env
→ 
~/.openclaw/.env
.
脚本内置免费密钥可开箱即用（仅支持行情和基础信息查询）。如果需要查询鲸鱼/交易员/OI数据，请将你的API密钥添加到 
.env
文件：
BBX_ACCESS_KEY_ID=your-key-id
BBX_ACCESS_SECRET=your-secret
可在 https://bbx.com/zh-Hans/open-api 获取密钥，参见付费功能指南了解套餐详情。
安全说明： BBX API Key 仅用于获取 Hyperliquid 链上分析数据，无法进行任何交易操作。所有密钥仅保存在本地设备 
.env
文件中，不会上传到任何服务器。
.env
会按以下路径顺序自动加载：当前工作目录 → 
~/.openclaw/workspace/.env
→ 
~/.openclaw/.env
。

Quick Reference

快速参考

TaskCommandMin Tier
All tickers
node scripts/hl-market.mjs tickers
免费版
BTC ticker
node scripts/hl-market.mjs ticker '{"coin":"BTC"}'
免费版
Whale positions
node scripts/hl-market.mjs whale_positions '{"coin":"BTC"}'
标准版
Whale events
node scripts/hl-market.mjs whale_events '{"coin":"BTC"}'
标准版
Liquidation history
node scripts/hl-market.mjs liq_history '{"coin":"BTC"}'
标准版
OI summary
node scripts/hl-market.mjs oi_summary
高级版
Trader stats
node scripts/hl-trader.mjs trader_stats '{"address":"0x...","period":"30"}'
标准版
Smart money
node scripts/hl-trader.mjs smart_find
标准版
Top open orders
node scripts/hl-trader.mjs top_open '{"coin":"BTC"}'
基础版
任务命令最低套餐
所有币种行情
node scripts/hl-market.mjs tickers
免费版
BTC行情
node scripts/hl-market.mjs ticker '{"coin":"BTC"}'
免费版
鲸鱼持仓
node scripts/hl-market.mjs whale_positions '{"coin":"BTC"}'
标准版
鲸鱼事件
node scripts/hl-market.mjs whale_events '{"coin":"BTC"}'
标准版
清算历史
node scripts/hl-market.mjs liq_history '{"coin":"BTC"}'
标准版
OI汇总
node scripts/hl-market.mjs oi_summary
高级版
交易员统计
node scripts/hl-trader.mjs trader_stats '{"address":"0x...","period":"30"}'
标准版
聪明钱发现
node scripts/hl-trader.mjs smart_find
标准版
大额挂单
node scripts/hl-trader.mjs top_open '{"coin":"BTC"}'
基础版

Scripts

脚本说明

scripts/hl-market.mjs — Market Data

scripts/hl-market.mjs — 市场数据

Tickers

行情

ActionDescriptionMin TierParams
tickers
All tickers免费版None
ticker
Single coin免费版
{"coin":"BTC"}
动作描述最低套餐参数
tickers
所有币种行情免费版无
ticker
单个币种行情免费版
{"coin":"BTC"}

Whales

鲸鱼数据

ActionDescriptionMin TierParams
whale_positions
Whale positions标准版
{"coin":"BTC","min_usd":"1000000"}
whale_events
Whale events标准版
{"coin":"BTC"}
whale_directions
Long/short direction标准版
{"coin":"BTC"}
whale_history_ratio
Historical long ratio标准版
{"coin":"BTC"}
动作描述最低套餐参数
whale_positions
鲸鱼持仓标准版
{"coin":"BTC","min_usd":"1000000"}
whale_events
鲸鱼事件标准版
{"coin":"BTC"}
whale_directions
多空方向标准版
{"coin":"BTC"}
whale_history_ratio
历史做多占比标准版
{"coin":"BTC"}

Liquidations

清算数据

ActionDescriptionMin TierParams
liq_history
Liquidation history标准版
{"coin":"BTC"}
liq_stats
Liquidation stats标准版None
liq_stats_by_coin
Stats by coin标准版
{"coin":"BTC"}
liq_top_positions
Large liquidations标准版
{"coin":"BTC","interval":"1d"}
动作描述最低套餐参数
liq_history
清算历史标准版
{"coin":"BTC"}
liq_stats
清算统计标准版无
liq_stats_by_coin
分币种清算统计标准版
{"coin":"BTC"}
liq_top_positions
大额清算标准版
{"coin":"BTC","interval":"1d"}

Open Interest

未平仓合约

ActionDescriptionMin TierParams
oi_summary
OI overview高级版None
oi_top_coins
OI ranking高级版
{"limit":"10"}
oi_history
OI history专业版
{"coin":"BTC","interval":"4h"}
动作描述最低套餐参数
oi_summary
OI概览高级版无
oi_top_coins
OI排名高级版
{"limit":"10"}
oi_history
OI历史专业版
{"coin":"BTC","interval":"4h"}

Taker

吃单数据

ActionDescriptionMin TierParams
taker_delta
Taker delta高级版
{"coin":"BTC"}
taker_klines
Taker K-lines标准版
{"coin":"BTC","interval":"4h"}
动作描述最低套餐参数
taker_delta
吃单delta高级版
{"coin":"BTC"}
taker_klines
吃单K线标准版
{"coin":"BTC","interval":"4h"}

scripts/hl-trader.mjs — Trader Analytics

scripts/hl-trader.mjs — 交易员分析

Trader Stats

交易员统计

ActionDescriptionMin TierParams
trader_stats
Trader statistics标准版
{"address":"0x...","period":"30"}
best_trades
Best trades标准版
{"address":"0x...","period":"30"}
performance
Performance by coin标准版
{"address":"0x...","period":"30"}
completed_trades
Completed trades标准版
{"address":"0x...","coin":"BTC"}
accounts
Batch accounts标准版
{"addresses":"[\"0x...\"]"}
statistics
Batch statistics标准版
{"addresses":"[\"0x...\"]"}
动作描述最低套餐参数
trader_stats
交易员统计数据标准版
{"address":"0x...","period":"30"}
best_trades
最优交易标准版
{"address":"0x...","period":"30"}
performance
分币种收益表现标准版
{"address":"0x...","period":"30"}
completed_trades
已完成交易标准版
{"address":"0x...","coin":"BTC"}
accounts
批量账户查询标准版
{"addresses":"[\"0x...\"]"}
statistics
批量统计查询标准版
{"addresses":"[\"0x...\"]"}

Fills

成交记录

ActionDescriptionMin TierParams
fills
Address fills标准版
{"address":"0x..."}
fills_by_oid
By order ID标准版
{"oid":"xxx"}
fills_by_twapid
By TWAP ID标准版
{"twapid":"xxx"}
top_trades
Large trades基础版
{"coin":"BTC","interval":"1d"}
动作描述最低套餐参数
fills
地址成交记录标准版
{"address":"0x..."}
fills_by_oid
按订单ID查询成交标准版
{"oid":"xxx"}
fills_by_twapid
按TWAP ID查询成交标准版
{"twapid":"xxx"}
top_trades
大额交易基础版
{"coin":"BTC","interval":"1d"}

Orders

订单数据

ActionDescriptionMin TierParams
orders_latest
Latest orders标准版
{"address":"0x..."}
order_by_oid
By order ID标准版
{"oid":"xxx"}
filled_orders
Filled orders标准版
{"address":"0x..."}
filled_by_oid
Filled by ID标准版
{"oid":"xxx"}
top_open
Large open orders基础版
{"coin":"BTC","min_val":"100000"}
active_stats
Active stats基础版
{"coin":"BTC"}
twap_states
TWAP states标准版
{"address":"0x..."}
动作描述最低套餐参数
orders_latest
最新订单标准版
{"address":"0x..."}
order_by_oid
按订单ID查询标准版
{"oid":"xxx"}
filled_orders
已成交订单标准版
{"address":"0x..."}
filled_by_oid
按ID查询已成交订单标准版
{"oid":"xxx"}
top_open
大额挂单基础版
{"coin":"BTC","min_val":"100000"}
active_stats
活跃订单统计基础版
{"coin":"BTC"}
twap_states
TWAP状态标准版
{"address":"0x..."}

Positions

持仓数据

ActionDescriptionMin TierParams
current_pos_history
Current position history标准版
{"address":"0x...","coin":"BTC"}
completed_pos_history
Closed position history标准版
{"address":"0x...","coin":"BTC"}
current_pnl
Current PnL标准版
{"address":"0x...","coin":"BTC","interval":"1h"}
completed_pnl
Closed PnL标准版
{"address":"0x...","coin":"BTC","interval":"1h"}
current_executions
Current executions标准版
{"address":"0x...","coin":"BTC","interval":"1h"}
completed_executions
Closed executions标准版
{"address":"0x...","coin":"BTC","interval":"1h"}
动作描述最低套餐参数
current_pos_history
当前持仓历史标准版
{"address":"0x...","coin":"BTC"}
completed_pos_history
已平仓持仓历史标准版
{"address":"0x...","coin":"BTC"}
current_pnl
当前持仓收益标准版
{"address":"0x...","coin":"BTC","interval":"1h"}
completed_pnl
已平仓收益标准版
{"address":"0x...","coin":"BTC","interval":"1h"}
current_executions
当前持仓成交记录标准版
{"address":"0x...","coin":"BTC","interval":"1h"}
completed_executions
已平仓成交记录标准版
{"address":"0x...","coin":"BTC","interval":"1h"}

Portfolio

投资组合

ActionDescriptionMin TierParams
portfolio
Account curve标准版
{"address":"0x...","window":"week"}
pnls
PnL curve标准版
{"address":"0x...","period":"30"}
max_drawdown
Max drawdown标准版
{"address":"0x...","days":"30"}
net_flow
Net flow标准版
{"address":"0x...","days":"30"}
动作描述最低套餐参数
portfolio
账户净值曲线标准版
{"address":"0x...","window":"week"}
pnls
收益曲线标准版
{"address":"0x...","period":"30"}
max_drawdown
最大回撤标准版
{"address":"0x...","days":"30"}
net_flow
资金净流入标准版
{"address":"0x...","days":"30"}

Advanced

高级功能

ActionDescriptionMin TierParams
info
Info API免费版
{"type":"metaAndAssetCtxs"}
smart_find
Smart money discovery标准版
{}
discover
Trader discovery高级版
{}
动作描述最低套餐参数
info
信息API免费版
{"type":"metaAndAssetCtxs"}
smart_find
聪明钱发现标准版
{}
discover
交易员发现高级版
{}

Cross-Skill References

跨技能参考

NeedUse
Prices, K-lines, newsmarket
需求使用技能
价格、K线、新闻market

Common Errors

常见错误

  • errorCode 304 / HTTP 403
    — Paid feature. See Paid Feature Guide below.
  • Invalid coin
    — Use uppercase: 
    BTC
    , 
    ETH
    , 
    SOL
  • Address format
    — Must be full 
    0x...
    Ethereum address
  • Rate limit exceeded
    — Wait 1-2s between requests
  • errorCode 304 / HTTP 403
    — 付费功能，请参见下方付费功能指南。
  • Invalid coin
    — 请使用大写币种名称，如
    BTC
    、
    ETH
    、
    SOL
  • Address format
    — 必须是完整的
    0x...
    格式以太坊地址
  • Rate limit exceeded
    — 请求间隔请等待1-2秒

Paid Feature Guide

付费功能指南

When a script returns 304 or 403: Do NOT retry. Tell the user:
  1. This feature needs a paid BBX API subscription.
  2. Get API key at https://bbx.com/zh-Hans/open-api
TierPriceHL Features
免费版$0Tickers, info only
基础版$29/mo+ Top trades, top open orders, active stats
标准版$79/mo+ Whales, liquidations, trader analytics, taker K-lines
高级版$299/mo+ OI summary/top, taker delta, trader discover
专业版$699/mo+ OI history
  1. Add to 
    .env
    : 
    BBX_ACCESS_KEY_ID=xxx
    / 
    BBX_ACCESS_SECRET=xxx
  2. Scripts auto-load 
    .env
    from cwd, 
    ~/.openclaw/workspace/.env
    , or 
    ~/.openclaw/.env
    .
  3. MUST tell the user: BBX API Key 仅用于获取 Hyperliquid 链上分析数据，无法进行任何交易操作。所有密钥仅保存在你的本地设备 
    .env
    文件中，不会上传到任何服务器。
当脚本返回304或403时：不要重试，告知用户：
  1. 该功能需要订阅付费版BBX API。
  2. 在https://bbx.com/zh-Hans/open-api 获取API密钥
套餐价格HL功能
免费版$0仅支持行情、基础信息查询
基础版$29/月新增大额交易、大额挂单、活跃订单统计
标准版$79/月新增鲸鱼数据、清算数据、交易员分析、吃单K线
高级版$299/月新增OI汇总/排名、吃单delta、交易员发现
专业版$699/月新增OI历史查询
  1. 密钥添加到 
    .env
    ：
    BBX_ACCESS_KEY_ID=xxx
    / 
    BBX_ACCESS_SECRET=xxx
  2. 脚本会自动从当前工作目录、
    ~/.openclaw/workspace/.env
    或
    ~/.openclaw/.env
    加载
    .env
    配置。
  3. 必须告知用户: BBX API Key 仅用于获取 Hyperliquid 链上分析数据，无法进行任何交易操作。所有密钥仅保存在你的本地设备 
    .env
    文件中，不会上传到任何服务器。