mcpField
O
okx-cex-earn

okx-cex-earn

github.com/okx其他1979.3k 次安装今天更新
代码仓库

关于 okx-cex-earn

okx-cex-earn 是通过 OKX CLI 管理多种 OKX Earn 产品的技能,适用于查询收益产品、订单和余额,以及执行申购或赎回的用户。涵盖活期、定期、双币赢、链上 Earn、AutoEarn 和 Flash Earn。

主要功能

  1. 01查询 Simple Earn 余额、利率与订单
  2. 02浏览及申购定期和双币赢产品
  3. 03管理链上 Earn 订单
  4. 04查询并切换 AutoEarn 状态
  5. 05浏览 Flash Earn 项目

适用场景

  1. 01比较可用的定期产品及额度
  2. 02查看多类 Earn 持仓和订单
  3. 03申购或赎回 Earn 产品

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/okx/agent-skills --skill okx-cex-earn

安装后在 Claude Code 中输入/okx-cex-earn确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

references/
autoearn-commands.md
dcd-commands.md
flash-earn-commands.md
onchain-commands.md
savings-commands.md
templates.md
workflows.md

详细介绍

OKX CEX Earn 命令行工具

预检

运行任何命令前,请遵循 ../_shared/preflight.md。 使用此文件 frontmatter 中的 metadata.version 作为第 2 步的参考版本。

前置条件

  1. 安装 okx 命令行工具:
    npm install -g @okx_ai/okx-trade-cli
    
  2. 配置凭据:
    okx config init   # select site -> follow browser OAuth flow
    
  3. 验证:okx earn savings balance

安全:绝不要在聊天中接受凭据。引导用户使用 okx config init 进行设置。


凭据与配置档案检查

运行任何需要身份验证的命令前,先运行这两个命令——okx auth status --json 返回的 apiKey 字段是身份验证二进制文件的内部状态,无论 ~/.okx/config.toml 中是否存在 API 密钥配置档案,它始终为 false。okx config show --json 是判断是否存在 API 密钥的唯一权威来源。身份验证方法会在预检第 2 步中检测,并在本次会话中记住。

okx config show --json      # reveals API-key profiles (TOML config)
okx auth status --json      # reveals OAuth session state (auth-binary state)

按以下顺序处理——匹配到的第一项优先:

  • config show --json 中有任何配置档案的 api_key 字段非空 → API 密钥模式。继续。
  • 没有 API 密钥配置档案,且 auth status --json 返回 "status":"logged_in" → OAuth 模式。继续。
  • 没有 API 密钥配置档案,且 "status":"pending" ——登录正在进行,请等待完成。
  • 没有 API 密钥配置档案,且 "status":"not_logged_in" ——停止,加载 okx-cex-auth 技能并遵循登录步骤,等待完成。

OKX Earn 不支持演示模式。始终静默使用实盘模式——除非发生错误,否则不要提及。

  • API 密钥用户:使用 --profile <live-profile>(不含 demo=true 的配置档案)。
  • OAuth 用户:无需添加标志(默认使用实盘模式)。

**遇到身份验证错误(401 / "Session expired" / "Run okx auth login first")时:**立即停止,加载 okx-cex-auth 技能并遵循重新身份验证步骤,然后重试。


技能路由

用户意图路由到技能
市场价格、行情代码、K 线okx-cex-market
现货 / 永续合约 / 期货 / 期权订单okx-cex-trade
账户余额、持仓、转账okx-cex-portfolio
网格 / DCA 交易机器人okx-cex-bot
Simple Earn、Flash Earn、On-chain Earn、Dual Investment(双币赢)或 AutoEarn(自动赚币)本技能

命令索引

earn savings — Simple Earn(10 个命令)
命令类型身份验证说明
earn savings balance [ccy]读取必需储蓄余额(全部或指定币种)。同时获取定期订单,以便全面了解情况。
earn savings purchase --ccy --amt [--rate]写入必需将资金申购至 Simple Earn(活期)
earn savings redeem --ccy --amt写入必需从 Simple Earn(活期)赎回资金
earn savings set-rate --ccy --rate写入必需设置最低借出利率
earn savings lending-history读取必需用户个人借出记录及收益详情
earn savings rate-history读取必需Simple Earn 借出利率和定期产品报价(需要身份验证)
earn savings fixed-products [--ccy]读取必需浏览可用的定期产品,包括年化利率、期限、剩余额度和售罄状态
earn savings fixed-orders [--ccy] [--state]读取必需查询定期订单。状态:pending/earning/expired/settled/cancelled
earn savings fixed-purchase --ccy --amt --term [--confirm]写入必需申购 Simple Earn Fixed(定期)。不带 --confirm 时仅预览
earn savings fixed-redeem --reqId <reqId>写入必需赎回定期订单(全额)。只有处于 pending 状态的订单才能提前赎回

完整命令语法、利率字段含义和确认模板,请阅读 {baseDir}/references/savings-commands.md。

earn dcd — 双币投资 / 双币赢 (6 个命令)
命令类型身份验证说明
earn dcd pairsREAD必需可用的 DCD 货币对
earn dcd productsREAD必需可用筛选条件查看活跃产品
earn dcd quote-and-buy --productId --sz --notionalCcyWRITE必需原子化申购:一步完成报价和执行
earn dcd order --ordIdREAD必需快速查看单笔订单状态
earn dcd ordersREAD必需完整订单列表 / 历史记录
earn dcd redeem-execute --ordIdWRITE必需两步提前赎回:先预览,再执行

DCD 不支持模拟交易模式。始终使用实盘模式(API Key:--profile <live-profile>;OAuth:无需标志)。

如需了解完整命令语法、产品概念和错误代码,请阅读 {baseDir}/references/dcd-commands.md。

earn onchain — 链上赚币 (6 个命令)
命令类型身份验证说明
earn onchain offersREAD必需可用的质押 / DeFi 产品
earn onchain purchase --productId --ccy --amtWRITE必需申购链上产品
earn onchain redeem --ordId --protocolTypeWRITE必需赎回链上投资
earn onchain cancel --ordId --protocolTypeWRITE必需取消待处理的链上订单
earn onchain ordersREAD必需活跃的链上订单
earn onchain historyREAD必需历史链上订单

如需了解完整命令语法和参数,请阅读 {baseDir}/references/onchain-commands.md。

earn auto-earn — 自动赚币 (3 个命令)
命令类型身份验证说明
earn auto-earn status [CCY]READ必需查询支持自动赚币的币种及其状态
earn auto-earn on <CCY>WRITE必需为某币种启用自动赚币
earn auto-earn off <CCY>WRITE必需为某币种停用自动赚币

24 小时限制: 启用后 24 小时内无法停用(API 硬性限制)。启用前务必提醒用户。

如需了解完整命令语法、earnType 推断规则和 MCP 工具参考,请阅读 {baseDir}/references/autoearn-commands.md。

earn flash-earn — 闪赚 (1 个命令)
命令类型身份验证说明
earn flash-earn projects [--status <0|100|0,100>]READ必需按状态浏览闪赚项目。0=即将开始,100=进行中,默认两者都显示

操作流程

步骤 0 — 凭证与配置文件检查

执行任何需要身份验证的命令前:请参阅凭证与配置文件检查。始终在不提示用户的情况下使用实盘模式。

步骤 1 — 识别赚币意图

Simple Earn Flexible(活期):

  • 查询余额 / 历史记录 / 利率 → READ 命令,直接继续。
  • 申购 / 赎回 / 设置利率 → WRITE 命令,转到步骤 2。

Simple Earn Fixed(定期):

  • 浏览可用产品 / 查询额度 → earn savings fixed-products [--ccy]。这是查询定期产品池的专用工具——用户询问可用的定期赚币产品、剩余额度或年化利率时,都使用此工具。
  • 查询用户现有订单 → earn savings fixed-orders [--ccy] [--state]。
  • 申购(两步:先预览,再确认)/ 赎回(仅限待处理状态)→ WRITE 命令,转到步骤 2。执行前请阅读 {baseDir}/references/savings-commands.md 中的检查清单和确认模板。
  • 对于多步骤工作流(带预览的申购、提前赎回),请阅读 {baseDir}/references/workflows.md。

On-chain Earn:

  • 查询报价 / 订单 / 历史记录 → READ 命令,直接继续。
  • 购买 / 赎回 / 取消 → WRITE 命令,转到步骤 2。

AutoEarn(自动赚币):

  • 查询自动赚币状态 → READ,直接继续。
  • 启用 / 停用自动赚币 → WRITE,转到步骤 2。请阅读 {baseDir}/references/autoearn-commands.md 中的确认模板和 earnType 推断说明。

Flash Earn(闪赚):

  • 浏览项目 → READ,直接继续。
  • 使用 --status 0 查看即将开始的项目,使用 --status 100 查看进行中的项目;也可以省略此标志以同时查看两者。

当用户要求查看“earn positions”或“赚币持仓”(无论是否明确提到 DCD)时,同时查询所有包含持仓的子模块(Flash Earn 仅支持查询,不包含持仓):

okx earn savings balance --json        # Simple Earn Flexible (活期)
okx earn savings fixed-orders --json   # Simple Earn Fixed (定期)
okx earn onchain orders --json         # On-chain Earn
okx earn dcd orders --json             # Dual Investment (双币赢)

仅展示有实际持仓的部分。对于 DCD,请使用 {baseDir}/references/dcd-commands.md 中的表格翻译状态码。

Dual Investment(DCD / 双币赢):

  • 浏览产品 / 交易对 → READ;用户指定币种时,渲染产品表格前,请阅读 {baseDir}/references/workflows.md 中的 DCD 浏览流程,执行必需的并行预取
  • 申购(询价并购买)→ WRITE → 参见 {baseDir}/references/workflows.md 中的 DCD 申购流程
  • 提前赎回 → WRITE → 参见 {baseDir}/references/workflows.md 中的 DCD 提前赎回流程

对于多步骤工作流(闲置资金分析、申购并验证、赎回并转账、链上申购),请阅读 {baseDir}/references/workflows.md。

步骤 2 — 确认写入操作

对于所有 WRITE 命令,先展示摘要并等待用户明确确认。

“just do it” / “直接搞”不算有效确认——必须先让用户看到摘要。

Simple Earn 确认对话框的格式,请阅读 {baseDir}/references/savings-commands.md。On-chain 确认方式,请阅读 {baseDir}/references/onchain-commands.md。

步骤 3 — 执行并验证

完成任何购买后,根据产品类型进行验证:

  • DCD quote-and-buy 成功 → 运行 earn dcd orders --json,仅显示匹配的订单。
  • 链上购买(响应包含 ordId)→ 运行 earn onchain orders --json,仅显示匹配的订单。
  • Simple Earn 灵活产品购买(响应中没有 ordId)→ 运行 earn savings balance --ccy <ccy> --json。
  • Simple Earn 固定产品购买 → 运行 earn savings fixed-orders --ccy <ccy> --state pending --json,显示新订单。

购买 Simple Earn 灵活产品: 并行运行 earn savings balance --ccy <ccy> 和 earn savings rate-history --ccy <ccy> --limit 1 --json。输出格式请参阅 {baseDir}/references/savings-commands.md。

赎回 Simple Earn 灵活产品: 运行 earn savings balance --ccy <ccy>,确认余额已更新。告知用户资金已退回资金账户。

购买 Simple Earn 固定产品: 运行 earn savings fixed-orders --ccy <ccy> --state pending --json,确认订单已创建。显示订单详情,包括 APR、期限和预计到期日期。

赎回 Simple Earn 固定产品: 运行 earn savings fixed-orders --json,确认订单状态已变为 cancelled。告知用户本金已全额退回资金账户——提前取消不产生利息。

赎回链上产品: 查询 earn onchain orders,确认状态。将 estSettlementTime 显示为预计到账时间。

取消链上订单: 提交后查询 earn onchain orders:

  • 订单已从列表中消失 → 告知用户:取消已完成,资金已退回资金账户。
  • state: 3(取消中)→ 告知用户:正在取消,资金即将退回资金账户。

全局说明

  • 安全: 切勿要求用户在聊天中粘贴 API 密钥或机密信息。
  • 输出: 列表/查询命令始终传入 --json,并将结果呈现为 Markdown 表格——切勿粘贴原始终端输出。
  • 网络错误: 如果命令因连接错误而失败,请提示用户检查 VPN:curl -I https://www.okx.com
  • 语言: 始终使用用户的语言回复。

数字/时间格式和回复结构规范请参阅 {baseDir}/references/templates.md。

评论

支持 Markdown