Okx Cex Earn

1---2name: okx-cex-earn3description: "Manages OKX Simple Earn (flexible savings/lending), Flash Earn, On-chain Earn (staking/DeFi), Dual Investment (DCD/双币赢), and AutoEarn (自动赚币) via the okx CLI. Use this skill whenever the user wants to check earn balances, browse flash-earn projects, subscribe or redeem earn products, view or set lending rates, monitor on-chain staking orders, interact with dual investment structured products, or manage auto-earn — even if phrased casually as 活期赚币, 定期赚币, 闪赚, 赚币, 申购, 赎回, 链上赚币, 质押, 理财, 双币赢, 双币理财, 双币申购, 高卖, 低买, dual investment, DCD, flash earn, buy low, sell high structured product, earn with target price, 目标价, 自动赚币, auto earn, auto-earn, 自动借出, 自动质押, auto lend, auto staking, USDG earn, USDG 赚币, 闲置资金自动理财, fixed earn, fixed deposit, term deposit, 定期理财, 定期. Also use when the user asks about idle funds and whether to earn on them."4license: MIT5metadata:6  author: okx7  version: "1.3.1"8  homepage: "https://www.okx.com"9  agent:10    requires:11      bins: ["okx"]12    install:13      - id: npm14        kind: node15        package: "@okx_ai/okx-trade-cli"16        bins: ["okx"]17        label: "Install okx CLI (npm)"18---19 20# OKX CEX Earn CLI21 22## Preflight23 24Before running any command, follow [`../_shared/preflight.md`](../_shared/preflight.md).25Use `metadata.version` from this file's frontmatter as the reference for Step 2.26 27## Prerequisites28 291. Install `okx` CLI:30   ```bash31   npm install -g @okx_ai/okx-trade-cli32   ```332. Configure credentials:34   ```bash35   okx config add-profile AK=<your_api_key> SK=<your_secret_key> PP=<your_passphrase> name=live36   # or interactive wizard:37   okx config init38   ```393. Verify: `okx --profile live earn savings balance`40 41---42 43## Credential & Profile Check44 45Run `okx config show` before any authenticated command.46 47- Error or no configuration → **stop**, guide user to run `okx config init`, wait for completion.48- Credentials configured → proceed.49 50OKX Earn does not support demo mode. Always use `--profile live` silently — don't mention it unless there's an error.51 52**On 401 errors:** stop immediately, tell the user their credentials may be invalid or expired, guide them to update `~/.okx/config.toml` (do NOT ask them to paste credentials into chat), then verify with `okx config show` and retry.53 54---55 56## Skill Routing57 58| User intent | Route to skill |59|---|---|60| Market prices, tickers, candles | `okx-cex-market` |61| Spot / swap / futures / options orders | `okx-cex-trade` |62| Account balance, positions, transfers | `okx-cex-portfolio` |63| Grid / DCA trading bots | `okx-cex-bot` |64| Simple Earn, Flash Earn, On-chain Earn, Dual Investment (双币赢), or AutoEarn (自动赚币) | **This skill** |65 66---67 68## Command Index69 70### earn savings — Simple Earn (9 commands)71 72| Command | Type | Auth | Description |73|---|---|---|---|74| `earn savings balance [ccy]` | READ | Required | Savings balance (all or specific currency). Also fetch fixed-term orders for a complete picture. |75| `earn savings purchase --ccy --amt [--rate]` | WRITE | Required | Subscribe funds to Simple Earn (活期) |76| `earn savings redeem --ccy --amt` | WRITE | Required | Redeem funds from Simple Earn (活期) |77| `earn savings set-rate --ccy --rate` | WRITE | Required | Set minimum lending rate |78| `earn savings lending-history` | READ | Required | User's personal lending records with earnings detail |79| `earn savings rate-history` | READ | Required | Simple Earn lending rates and fixed-term offers (require auth) |80| `earn savings fixed-orders [--ccy] [--state]` | READ | Required | Query fixed-term (定期) orders. States: pending/earning/expired/settled/cancelled |81| `earn savings fixed-purchase --ccy --amt --term [--confirm]` | WRITE | Required | Subscribe to Simple Earn Fixed (定期). Without `--confirm`: preview only |82| `earn savings fixed-redeem <reqId>` | WRITE | Required | Redeem a fixed-term order (full amount). Only `pending` state orders can be redeemed early |83 84For full command syntax, rate field semantics, and confirmation templates, read `{baseDir}/references/savings-commands.md`.85 86### earn dcd — Dual Investment / 双币赢 (6 commands)87 88| Command | Type | Auth | Description |89|---|---|---|---|90| `earn dcd pairs` | READ | Required | Available DCD currency pairs |91| `earn dcd products` | READ | Required | Active products with filters |92| `earn dcd quote-and-buy --productId --sz --notionalCcy` | WRITE | Required | Atomic subscribe: quote + execute in one step |93| `earn dcd order --ordId` | READ | Required | Quick state check for a single order |94| `earn dcd orders` | READ | Required | Full order list / history |95| `earn dcd redeem-execute --ordId` | WRITE | Required | Two-step early redemption: preview then execute |96 97> DCD does **not** support demo/simulated trading mode. Always use `--profile live`.98 99For full command syntax, product concepts, and error codes, read `{baseDir}/references/dcd-commands.md`.100 101### earn onchain — On-chain Earn (6 commands)102 103| Command | Type | Auth | Description |104|---|---|---|---|105| `earn onchain offers` | READ | Required | Available staking/DeFi products |106| `earn onchain purchase --productId --ccy --amt` | WRITE | Required | Subscribe to on-chain product |107| `earn onchain redeem --ordId --protocolType` | WRITE | Required | Redeem on-chain investment |108| `earn onchain cancel --ordId --protocolType` | WRITE | Required | Cancel pending on-chain order |109| `earn onchain orders` | READ | Required | Active on-chain orders |110| `earn onchain history` | READ | Required | Historical on-chain orders |111 112For full command syntax and parameters, read `{baseDir}/references/onchain-commands.md`.113 114### earn auto-earn — AutoEarn / 自动赚币 (3 commands)115 116| Command | Type | Auth | Description |117|---|---|---|---|118| `earn auto-earn status [CCY]` | READ | Required | Query currencies supporting auto-earn and their status |119| `earn auto-earn on <CCY>` | WRITE | Required | Enable auto-earn for a currency |120| `earn auto-earn off <CCY>` | WRITE | Required | Disable auto-earn for a currency |121 122> **24h restriction:** Cannot disable within 24 hours of enabling (API hard limit). Always warn user before enabling.123 124For full command syntax, earnType inference rules, and MCP tool reference, read `{baseDir}/references/autoearn-commands.md`.125 126### earn flash-earn — Flash Earn / 闪赚 (1 command)127 128| Command | Type | Auth | Description |129|---|---|---|---|130| `earn flash-earn projects [--status <0\|100\|0,100>]` | READ | Required | Browse Flash Earn projects by status. `0`=upcoming, `100`=in-progress, default is both |131 132---133 134## Operation Flow135 136### Step 0 — Credential & Profile Check137 138Before any authenticated command: see [Credential & Profile Check](#credential--profile-check). Always use `--profile live` silently.139 140### Step 1 — Identify earn intent141 142**Simple Earn Flexible (活期):**143- Query balance / history / rates → READ command, proceed directly.144- Subscribe / redeem / set-rate → WRITE command, go to Step 2.145 146**Simple Earn Fixed (定期):**147- Query offers / order list → READ command, proceed directly.148- Subscribe (two-step: preview then confirm) / redeem (pending state only) → WRITE command, go to Step 2. Read `{baseDir}/references/savings-commands.md` for pre-execution checklists and confirmation templates.149- For multi-step workflows (subscribe with preview, early redemption), read `{baseDir}/references/workflows.md`.150 151**On-chain Earn:**152- Query offers / orders / history → READ command, proceed directly.153- Purchase / redeem / cancel → WRITE command, go to Step 2.154 155**AutoEarn (自动赚币):**156- Query auto-earn status → READ, proceed directly.157- Enable / disable auto-earn → WRITE, go to Step 2. Read `{baseDir}/references/autoearn-commands.md` for confirmation templates and earnType inference.158 159**Flash Earn (闪赚):**160- Browse projects → READ, proceed directly.161- Use `--status 0` for upcoming projects, `--status 100` for in-progress projects, or omit the flag to view both.162 163When user asks to view "earn positions" or "赚币持仓" (regardless of whether they mention DCD explicitly), query all position-bearing sub-modules simultaneously (Flash Earn is query-only, no positions):164 165```bash166okx --profile live earn savings balance --json        # Simple Earn Flexible (活期)167okx --profile live earn savings fixed-orders --json   # Simple Earn Fixed (定期)168okx --profile live earn onchain orders --json         # On-chain Earn169okx --profile live earn dcd orders --json             # Dual Investment (双币赢)170```171 172Only present sections that have actual holdings. For DCD: translate state codes using the table in `{baseDir}/references/dcd-commands.md`.173 174**Dual Investment (DCD / 双币赢):**175- Browse products / pairs → READ; when user specifies a currency, read `{baseDir}/references/workflows.md` (DCD browse flow) for the mandatory parallel pre-fetch before rendering the product table176- Subscribe (quote-and-buy) → WRITE → see `{baseDir}/references/workflows.md` (DCD subscribe flow)177- Early redeem → WRITE → see `{baseDir}/references/workflows.md` (DCD early redeem flow)178 179For multi-step workflows (idle fund analysis, subscribe + verify, redeem + transfer, on-chain subscribe), read `{baseDir}/references/workflows.md`.180 181### Step 2 — Confirm write operation182 183For all WRITE commands, present a summary and wait for explicit confirmation.184 185> "just do it" / "直接搞" is NOT valid confirmation — the user must see the summary first.186 187For Simple Earn confirmation dialog format, read `{baseDir}/references/savings-commands.md`. For On-chain confirmation, read `{baseDir}/references/onchain-commands.md`.188 189### Step 3 — Execute and verify190 191After any purchase, verify based on product type:192- **DCD** `quote-and-buy` succeeded → run `earn dcd orders --json`, show only the matching order.193- **On-chain** purchase (response contains `ordId`) → run `earn onchain orders --json`, show only the matching order.194- **Simple Earn Flexible** purchase (no `ordId` in response) → run `earn savings balance --ccy <ccy> --json`.195- **Simple Earn Fixed** purchase → run `earn savings fixed-orders --ccy <ccy> --state pending --json`, show the new order.196 197**Simple Earn Flexible purchase:** Run in parallel — `earn savings balance --ccy <ccy>` and `earn savings rate-history --ccy <ccy> --limit 1 --json`. For output format, read `{baseDir}/references/savings-commands.md`.198 199**Simple Earn Flexible redeem:** Run `earn savings balance --ccy <ccy>` to confirm updated balance. Inform user funds returned to funding account.200 201**Simple Earn Fixed purchase:** Run `earn savings fixed-orders --ccy <ccy> --state pending --json` to confirm the order was created. Show order details including APR, term, and expected expiry date.202 203**Simple Earn Fixed redeem:** Run `earn savings fixed-orders --json` to confirm the order state changed to `cancelled`. Inform user full principal returned to funding account — no interest earned for early cancellation.204 205**On-chain redeem:** Query `earn onchain orders` to confirm state. Show `estSettlementTime` as estimated arrival time.206 207**On-chain cancel:** Query `earn onchain orders` after submission:208- Order gone from list → inform user: cancellation complete, funds returned to funding account.209- `state: 3` (cancelling) → inform user: cancellation in progress, funds will return to funding account shortly.210 211---212 213## Global Notes214 215- **Security:** Never ask users to paste API keys or secrets into chat.216- **Output:** Always pass `--json` to list/query commands and render results as a Markdown table — never paste raw terminal output.217- **Network errors:** If commands fail with a connection error, prompt user to check VPN: `curl -I https://www.okx.com`218- **Language:** Always respond in the user's language.219 220For number/time formatting and response structure conventions, read `{baseDir}/references/templates.md`.