How to get a OKX API key

Create your OKX API key

1. 1

   Open API management

   Log in and open Profile → API (okx.com/account/my-api). For a demo key, first switch to Demo Trading.

2. 2

   Create a V5 API key

   Click Create API key, choose API trading, and set a name.

3. 3

   Set a passphrase

   Choose a passphrase and save it; OKX cannot show it again.

4. 4

   Choose permissions

   Tick Read and Trade. Never tick Withdraw for a bot.

5. 5

   Bind IPs and confirm

   Add your server IP (keys without IPs may expire after inactivity), confirm with 2FA, then copy the key and secret.

Test the key

Before wiring the key into a strategy, make one request by hand. It separates “the key is wrong” from “my code is wrong”.

import base64, hashlib, hmac, os, urllib.request
from datetime import datetime, timezone
ts = datetime.now(timezone.utc).strftime("%Y-%m-%dT%H:%M:%S.%f")[:-3] + "Z"
path = "/api/v5/account/balance"
sign = base64.b64encode(hmac.new(os.environ["OKX_API_SECRET"].encode(), (ts + "GET" + path).encode(), hashlib.sha256).digest()).decode()
req = urllib.request.Request("https://www.okx.com" + path, headers={
    "OK-ACCESS-KEY": os.environ["OKX_API_KEY"], "OK-ACCESS-SIGN": sign, "OK-ACCESS-TIMESTAMP": ts,
    "OK-ACCESS-PASSPHRASE": os.environ["OKX_PASSPHRASE"], "x-simulated-trading": "1"})
print(urllib.request.urlopen(req).read().decode())

Frequently asked questions