API reference
Client methods, parameters and response types exported by gateio-api. The same API works in JavaScript and TypeScript.
Clients
Common methods
| Task | Method |
|---|---|
| Spot ticker | getSpotTicker |
| Pair rules | getSpotCurrencyPair |
| Order-book snapshot | getSpotOrderBook |
| Spot candles | getSpotCandles |
| Spot balances | getSpotAccounts |
| Submit / amend / cancel | submitSpotOrder, updateSpotOrder, cancelSpotOrder |
| Recover one order | getSpotOrder |
| Open and finished orders | getSpotOrders |
| Execution history | getSpotTradingHistory |
| Perpetual-futures tickers | getFuturesTickers |
| Subscribe to updates | subscribe |
| WebSocket order status | getSpotOrderStatus |
Search methods and types with ⌘K / Ctrl+K. Use the authentication, order management and private stream guides for complete workflows.