-
-
Notifications
You must be signed in to change notification settings - Fork 8.8k
ccxt vs okxus api
okxus is a regional entity of OKX — the US entity of OKX, served from us.okx.com.
Because it shares an API dialect with OKX, CCXT implements it by extending its okx class. Everything in the CCXT vs the OKX API comparison applies here — this page covers only what is specific to okxus.
Separate host, separate accounts and a narrower product set than the global venue — notably fewer derivatives, reflecting what the US entity offers.
Credentials are not shared with the global
okxclass.
okxus |
|
|---|---|
| Unified capabilities | 122 (inherited from okx plus its own overrides) |
fetch* methods |
64 |
WebSocket watch* methods |
19 |
| Raw endpoints as implicit methods | 446 |
Testnet via setSandboxMode
|
yes |
| Languages | TypeScript, JavaScript, Python, PHP, C#/.NET, Go, Java, Rust |
| Licence | MIT |
Figures verified September 2026 against CCXT v{{CCXT_VERSION}}, read from the source tree with build/comparisons-facts.cjs. Counts include everything inherited from okx.
The class name is the only thing that changes — every unified method behaves as it does everywhere else in CCXT:
import ccxt
exchange = ccxt.okxus({'apiKey': '...', 'secret': '...'})
markets = exchange.load_markets()
ticker = exchange.fetch_ticker(list(markets)[0])import ccxt from 'ccxt';
const exchange = new ccxt.okxus ({ apiKey: '...', secret: '...' });
const markets = await exchange.loadMarkets ();
const ticker = await exchange.fetchTicker (Object.keys (markets)[0]);Because okxus lists a different market set from okx, call load_markets() and pick symbols from it rather than assuming a pair exists.
Streaming works the same way:
import ccxt.pro, asyncio
async def main():
exchange = ccxt.pro.okxus()
while True:
orderbook = await exchange.watch_order_book('BTC/USDT')
print(orderbook['bids'][0], orderbook['asks'][0])
asyncio.run(main())Use okxus when you hold an account with OKX US specifically. Use okx when you hold an account with the global venue. They are different venues with separate credentials, so this is not a preference — it follows from where your account is.
Do my okx API keys work with okxus?
No. It is a separate legal entity with separate accounts; you need keys issued by OKX US.
Does okxus support the full unified API?
It inherits 122 unified capabilities from okx. Where the venue does not offer a feature, the corresponding has flag is turned off, and the method raises NotSupported rather than failing quietly. Check exchange.has at runtime.
Can I reach OKX US-specific endpoints?
Yes — all 446 endpoints in this class's api block are generated as implicit methods, with signing, rate limiting and error mapping applied. The mechanism is documented on the okx implicit API page; this venue's own endpoint list differs slightly from the parent's.
Is CCXT free? Yes. MIT-licensed, including the WebSocket support.
- CCXT vs the OKX API — the full comparison
-
okxAPI reference —okxusinherits it; it has no separate reference page - Install CCXT
- Manual
- More comparisons
(If the page is not being rendered for you, you can refer to the mirror at https://docs.ccxt.com/)
- Install
- Examples
- Manual
- CCXT Pro
- Contributing
- Supported Exchanges
- Exchanges By Country
- API Spec By Method
- FAQ
- Changelog
- Awesome
- API Spec by Exchange
- alpaca
- apex
- aster
- backpack
- bigone
- binance
- bingx
- bit2c
- bitbank
- bitbns
- bitfinex
- bitflyer
- bitget
- bithumb
- bitmex
- bitopro
- bitrue
- bitso
- bitstamp
- bitteam
- bittrade
- bitvavo
- blockchaincom
- blofin
- btcbox
- btcmarkets
- btcturk
- btse
- bullish
- bybit
- bydfi
- cex
- coinbase
- coinbaseexchange
- coinbaseinternational
- coincheck
- coinex
- coinmate
- coinone
- coinsph
- coinspot
- cryptocom
- cryptomus
- deepcoin
- delta
- deribit
- derive
- digifinex
- dydx
- extended
- foxbit
- gate
- gemini
- grvt
- hashkey
- hibachi
- hitbtc
- hollaex
- htx
- hyperliquid
- independentreserve
- indodax
- kraken
- krakenfutures
- kucoin
- kucoinfutures
- latoken
- lbank
- lighter
- luno
- mercado
- mexc
- modetrade
- mudrex
- nado
- ndax
- okx
- onetrading
- p2b
- pacifica
- paradex
- paymium
- phemex
- poloniex
- revolutx
- tokocrypto
- toobit
- upbit
- weex
- whitebit
- woo
- woofipro
- xt
- zaif
- zebpay
- API Spec by Prediction Exchange