Skip to content

API reference ​

Client methods, parameters and response types exported by okx-api. The same API works in JavaScript and TypeScript.

Clients ​

Common methods ​

TaskMethod
Public tickergetTicker
Instrument metadatagetInstruments
Order-book snapshotgetOrderBook
Trading-account balancesgetBalance
Funding-account balancesgetBalances
Submit / amend / cancelsubmitOrder, amendOrder, cancelOrder
Recover one ordergetOrderDetails
Open orders and positionsgetOrderList, getPositions
Order and execution historygetOrderHistory, getFills
Subscribe to updatessubscribe
WebSocket order commandsubmitNewOrder

Search methods and types with ⌘K / Ctrl+K. Use the authentication, order lifecycle and private stream guides for complete workflows.

Reference index · OKX API documentation

Built by Siebly. Open source SDKs for exchange APIs.