okx-account

Category: 数据与AI | Uploader: billionaire-aicrypto | Downloads: 0 | Version: v1.0（Latest）

Use this skill when users need to manage their OKX trading account: check balance, view positions, get bills/transaction history, configure account settings (leverage, margin mode, position mode), manage collateral, check risk state, or handle borrowing/repaying. For placing/canceling orders, use okx-trade. For funding account (deposits/withdrawals), use okx-asset.

Changelog: Source: GitHub https://github.com/billionaire-aicrypto/okx-skills

Directory Structure

Current level: skills/okx-account/

📄 SKILL.md 4.7 KB

SKILL.md

---
name: okx-account
description: "Use this skill when users need to manage their OKX trading account: check balance, view positions, get bills/transaction history, configure account settings (leverage, margin mode, position mode), manage collateral, check risk state, or handle borrowing/repaying. For placing/canceling orders, use okx-trade. For funding account (deposits/withdrawals), use okx-asset."
license: Apache-2.0
metadata:
  author: billionaire-aicrypto
  version: "1.0.0"
  homepage: "https://www.okx.com/docs-v5/zh/#trading-account"
---

# OKX Trading Account CLI

37+ commands for trading account management: balance, positions, bills, leverage, margin, risk, collateral, and configuration.

## Pre-flight Checks

Every time before running any `okx` command, follow these steps:

1. **Confirm installed**: Run `which okx`. If not found, install:
   ```bash
   cd <project-root>/cli && npm install && npm link
   ```

2. **API credentials**: Ensure `.env` file exists in project root or `~/.okx/.env`:
   ```
   OKX_API_KEY=your-api-key
   OKX_SECRET_KEY=your-secret-key
   OKX_PASSPHRASE=your-passphrase
   ```

## Skill Routing

- For order placement/cancellation → use `okx-trade`
- For market data (tickers, candles, order book) → use `okx-market`
- For public data (instruments, funding rate) → use `okx-public`
- For funding account (deposit/withdrawal/transfer) → use `okx-asset`
- For trading bots (grid, signal, DCA) → use `okx-trading-bot`

## Commands

### Get Account Balance
```bash
okx account balance
okx account balance --ccy BTC,ETH
```

### Get Positions
```bash
okx account positions
okx account positions --instType SWAP
okx account positions --instId BTC-USDT-SWAP
```

### Get Historical Positions
```bash
okx account positions-history
okx account positions-history --instType SWAP --limit 50
```

### Get Account Position Risk
```bash
okx account position-risk
okx account position-risk --instType SWAP
```

### Get Bills (7 days)
```bash
okx account bills
okx account bills --instType SPOT --ccy BTC
okx account bills --type 2 --limit 50
```

### Get Bills Archive (3 months)
```bash
okx account bills-archive --instType SWAP
```

### Get Account Configuration
```bash
okx account config
```

### Set Position Mode
```bash
okx account set-position-mode --posMode long_short_mode
okx account set-position-mode --posMode net_mode
```

### Set Leverage
```bash
okx account set-leverage --instId BTC-USDT-SWAP --lever 10 --mgnMode cross
okx account set-leverage --instId BTC-USDT-SWAP --lever 5 --mgnMode isolated --posSide long
```

### Get Maximum Order Size
```bash
okx account max-size --instId BTC-USDT --tdMode cash
okx account max-size --instId BTC-USDT-SWAP --tdMode cross
```

### Get Maximum Available Size
```bash
okx account max-avail-size --instId BTC-USDT --tdMode cash
```

### Adjust Margin (Isolated)
```bash
okx account adjust-margin --instId BTC-USDT-SWAP --posSide long --type add --amt 10
okx account adjust-margin --instId BTC-USDT-SWAP --posSide long --type reduce --amt 5
```

### Get Leverage Info
```bash
okx account leverage-info --instId BTC-USDT-SWAP --mgnMode cross
```

### Get Max Loan
```bash
okx account max-loan --instId BTC-USDT-SWAP --mgnMode cross
```

### Get Trade Fee Rates
```bash
okx account trade-fee --instType SPOT
okx account trade-fee --instType SWAP --instFamily BTC-USDT
```

### Get Interest Accrued
```bash
okx account interest-accrued
okx account interest-accrued --ccy USDT
```

### Get Interest Rate
```bash
okx account interest-rate
okx account interest-rate --ccy BTC
```

### Set Greeks Display (PA/BS)
```bash
okx account set-greeks --greeksType PA
okx account set-greeks --greeksType BS
```

### Get Max Withdrawal
```bash
okx account max-withdrawal
okx account max-withdrawal --ccy USDT
```

### Get Risk State
```bash
okx account risk-state
```

### Get Interest Limits
```bash
okx account interest-limits
okx account interest-limits --ccy BTC
```

### Manual Borrow/Repay
```bash
okx account spot-borrow-repay --ccy USDT --side borrow --amt 1000
okx account spot-borrow-repay --ccy USDT --side repay --amt 1000
```

### Get Account Greeks
```bash
okx account greeks
okx account greeks --ccy BTC
```

### Set Account Level
```bash
okx account set-account-level --acctLv 2
```

### Set Collateral Assets
```bash
okx account set-collateral-assets --ccy BTC,ETH,USDT
```

### Get Collateral Assets
```bash
okx account collateral-assets
```

### Get Instruments (Private)
```bash
okx account instruments --instType SPOT
okx account instruments --instType SWAP --instFamily BTC-USDT
```

## Response Format

All responses are JSON with structure:
```json
{
  "code": "0",
  "msg": "",
  "data": [...]
}
```
`code` = "0" means success. Non-zero means error — check `msg` for details.

Comments 0

Latest | Hot

Please login before commenting.

No comments yet. Be the first one!

okx-account

Directory Structure

SKILL.md

Report

Notice