python-okx

Overview

This is an unofficial Python wrapper for the OKX exchange v5 API

If you came here looking to purchase cryptocurrencies from the OKX exchange, please go here.

Source code

https://github.com/okxapi/python-okx

API trading tutorials

Spot trading: https://www.okx.com/help/how-can-i-do-spot-trading-with-the-jupyter-notebook
Derivative trading: https://www.okx.com/help/how-can-i-do-derivatives-trading-with-the-jupyter-notebook

Make sure you update often and check the Changelog for new features and bug fixes.

Features

Implementation of all Rest API endpoints.
Private and Public Websocket implementation
Testnet support
Websocket handling with reconnection and multiplexed connections

Quick start

Prerequisites

python version：>=3.7

Step 1: Register an account on OKX and apply for an API key

Register for an account: https://www.okx.com/account/register
Apply for an API key: https://www.okx.com/account/users/myApi

Step 2: Install python-okx

pip install python-okx

API Credentials

Option 1: Hardcoded credentials

from okx import Account

account = Account.AccountAPI(
    api_key="your-api-key-here",
    api_secret_key="your-api-secret-here",
    passphrase="your-passphrase-here",
    flag="1",  # 0 = live trading, 1 = demo trading
    debug=False
)

Option 2: Using `.env` file (recommended)

Create a .env file in your project root:

OKX_API_KEY=your-api-key-here
OKX_API_SECRET=your-api-secret-here
OKX_PASSPHRASE=your-passphrase-here
OKX_FLAG=1

Then load it in your code:

import os
from dotenv import load_dotenv
from okx import Account

load_dotenv()

account = Account.AccountAPI(
    api_key=os.getenv('OKX_API_KEY'),
    api_secret_key=os.getenv('OKX_API_SECRET'),
    passphrase=os.getenv('OKX_PASSPHRASE'),
    flag=os.getenv('OKX_FLAG', '1'),
    debug=False
)

Development Setup

For contributors or local development:

# Clone the repository
git clone https://github.com/okxapi/python-okx.git
cd python-okx

# Install dependencies
pip install -r dev_requirements.txt
pip install -e .

# Run tests
pytest test/unit/ -v

Step 3: Run examples

Fill in API credentials in the corresponding examples

api_key = ""
secret_key = ""
passphrase = ""

RestAPI
- For spot trading: run example/get_started_en.ipynb
- For derivative trading: run example/trade_derivatives_en.ipynb
- Tweak the value of the parameter flag (live trading: 0, demo trading: 1 ) to switch between live and demo trading environment
WebSocketAPI
- Run test/WsPrivateTest.py for private websocket channels
- Run test/WsPublicTest.py for public websocket channels
- Use different URLs for different environment
  - Live trading URLs: https://www.okx.com/docs-v5/en/#overview-production-trading-services
  - Demo trading URLs: https://www.okx.com/docs-v5/en/#overview-demo-trading-services

Note

To learn more about OKX API, visit official OKX API documentation

If you face any questions when using WebSocketAPI,you can consult the following links

asyncio、websockets document/github：

https://docs.python.org/3/library/asyncio-dev.html
https://websockets.readthedocs.io/en/stable/intro.html
https://github.com/aaugustin/websockets

About code=1006：

https://github.com/Rapptz/discord.py/issues/1996
https://github.com/aaugustin/websockets/issues/587

Metadata

Release files for python-okx 0.4.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for python-okx 0.4.4
File	Size	Uploaded
python_okx-0.4.4.tar.gz	41.5 kB	Sep 7, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for python-okx 0.4.4
File	Interpreter	ABI	Platform	Reset
python_okx-0.4.4-py3-none-any.whl 40.6 kB Sep 7, 2026	Python 3	none	any	Details

Total release size: 82.0 kB

Release files / python_okx-0.4.4.tar.gz

Download URL	python_okx-0.4.4.tar.gz
Size	41.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`9c01cfdfb01a604384b0d167b1443d3e3fd6437c11647b741912fd4ed5fab4de`
BLAKE2b-256 checksum How to use checksums	`bfb35d6bdd3ed94188947695555846972c19118246264971da5f926819be796d`
Upload date	Sep 7, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.14.6`

Release files / python_okx-0.4.4-py3-none-any.whl

Download URL	python_okx-0.4.4-py3-none-any.whl
Size	40.6 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`0478059cc326adad3e413da32dd5785b510f4fe026b26ea10b95831e1a56346a`
BLAKE2b-256 checksum How to use checksums	`30480fe26772f2eadbdca1148e27786a0c6cdf5307794083f47bc81239490c8e`
Upload date	Sep 7, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.14.6`