API reference
Client methods, parameters and response types exported by bitget-api. The same API works in JavaScript and TypeScript. Start with client selection to match your account and API version.
Clients
- RestClientV3: UTA and V3 product REST APIs.
- WebsocketClientV3: UTA subscriptions and low-level commands.
- WebsocketAPIClient: awaitable UTA trading commands.
- RestClientV2: Classic REST APIs.
- WebsocketClientV2: Classic subscriptions.
Common workflows
| Task | Method |
|---|---|
| UTA ticker / instruments | getTickers, getInstruments |
| UTA balances | getBalances |
| UTA submit / amend / cancel | submitNewOrder, modifyOrder, cancelOrder |
| UTA order recovery | getOrderInfo, getHistoryOrders, getTradeFills |
| UTA public/private subscription | subscribe |
| Classic Spot ticker | getSpotTicker |
| Classic Spot instruments / balances | getSpotSymbolInfo, getSpotAccountAssets |
| Classic subscription alternative | subscribeTopic |
| UTA WebSocket command | submitNewOrder |
Search methods and types with ⌘K / Ctrl+K. Use authentication, orders and private streams for complete workflows. The generated reference includes the release's additional product endpoints; verify account eligibility and current exchange requirements before using them.