← Brokers

OKX

Global

betaRead-only API

How to create the read-only key

  1. okx.com → profile icon → API → "Create API key".
  2. Name it (Asterholm), create a passphrase and tick only "Read". Optional: restrict it to the server IP.
  3. Confirm with your two-step verification and copy the API key and the Secret key.
  4. Paste the API key, the Secret key and the passphrase here and press "Test connection".

Read-only. Create the key with ONLY the "Read" permission. Asterholm checks the permissions on connect and rejects keys that can trade or withdraw.

Reads spot trades (the OKX API only gives the last 3 months; from the day you connect, Asterholm keeps them), deposits, withdrawals, conversions and balances (trading, funding and Simple Earn). New connector: review the first result.

API keyAPI secretPassphrase
Read-only by design: Read-only: we can never trade or move money.