API reference
Client methods, parameters and response types exported by kucoin-api. The same API works in JavaScript and TypeScript.
Clients
Common methods
| Task | Method |
|---|---|
| Spot ticker | getTicker |
| Pair rules | getSymbols |
| Order-book snapshot | getOrderBookLevel20 |
| Spot candles | getKlines |
| Classic Spot balances | getBalances |
| Submit / amend / cancel | submitHFOrder, updateHFOrder, cancelHFOrder |
| Recover one order | getHFOrderDetailsByClientOid, getHFOrderDetailsByOrderId |
| Open orders | getHFActiveOrdersPaginated |
| Completed orders and fills | getHFCompletedOrders, getHFFilledOrders |
| Validate without matching | submitHFOrderTest |
| Subscribe to updates | subscribe |
| WebSocket cancellation | cancelSpotOrder |
Search methods and types with ⌘K / Ctrl+K. Use the authentication, order management and private stream guides for complete workflows.