Skip to content

API reference ​

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

Clients ​

Common methods ​

TaskMethod
Spot tickergetSpotTicker
Pair rulesgetSpotCurrencyPair
Order-book snapshotgetSpotOrderBook
Spot candlesgetSpotCandles
Spot balancesgetSpotAccounts
Submit / amend / cancelsubmitSpotOrder, updateSpotOrder, cancelSpotOrder
Recover one ordergetSpotOrder
Open and finished ordersgetSpotOrders
Execution historygetSpotTradingHistory
Perpetual-futures tickersgetFuturesTickers
Subscribe to updatessubscribe
WebSocket order statusgetSpotOrderStatus

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

Reference index · Gate API documentation

Built by Siebly. Open source SDKs for exchange APIs.