Broker API HubMenu

Bitget books

messagebooksBitget WebSocket APIWebSocketPublic channels

Order book depth for one symbol. The topic chooses the depth: books for every level, books1 for 1, books5 for 5 and books50 for 50. books and books50 send a snapshot first and then incremental updates, while books1 and books5 send a snapshot every time.

Risk warning: CFDs and spread bets are complex instruments and come with a high risk of losing money rapidly due to leverage. You can lose money on these products, and each provider publishes its own loss figure under FCA rules. You should consider whether you understand how they work and whether you can afford to take the high risk of losing your money. Automated and API trading can amplify losses through bugs, connectivity failures and runaway orders.

Independent and unofficialbitget.comchecked

This is a subscription of the Bitget WebSocket API, not an HTTP endpoint. It has no method and no path: it is sent as JSON over an open WebSocket connection.

The page gives the push frequency as 1 ms for books1, 10 ms for books5, 20 ms for books50 and 50 ms for books, for spot and for futures. It says the seq of one update must equal the pseq of the next, and that after a release or restart the numbers can be reset, in which case a message with pseq 0 is likely.

The message

Name
books
Direction
Subscription, opened by the client and then fed by the server
Subscribed to as
books
Carried by
WebSocket. This channel is in the public section of Bitget's WebSocket documentation. The addresses are the ones on Bitget's quick start page (bitget.com/docs/uta/quick-start), opened the same day, which also lists VIP and low latency hosts.
Public channel
wss://ws.bitget.com/v3/ws/public
Public channel, demo trading
wss://wspap.bitget.com/v3/ws/public

Fields

NameTypeDescription
oprequiredStringsubscribe to start the channel, unsubscribe to stop it.
argsrequiredList<Object>The channels to act on. Each entry names one.
args[].instTyperequiredStringThe product type: spot, usdt-futures, coin-futures or usdc-futures.
args[].topicrequiredStringbooks, books1, books5 or books50.
args[].symbolrequiredStringThe symbol, for example BTCUSDT.

What arrives

books: A message with the event subscribe and the same arg confirms the subscription, with a connId for the connection. On an error the event is error, with a code and a msg. Data then arrives as below.

The vendor's page does not say which of these fields are required or always present.

NameTypeDescription
argObjectThe channel the data belongs to: the instType, the topic and, on a public channel, the symbol that were subscribed to.
actionStringsnapshot for a full push, update for an incremental one.
tsStringThe time of the push.
dataList<Object>The depth data.
data[].aList<String>The asks, in ascending order of price. Each entry holds a price and a quantity.
data[].bList<String>The bids, in descending order of price. Each entry holds a price and a quantity.
data[].seqStringA serial number that rises when the order book is updated. It shows whether messages arrived out of order.
data[].pseqStringThe serial number of the previous push, which shows whether a message was lost. It has a value on books and books50 only.
data[].maxDepthStringThe most levels the symbol has, from 0 to 1000. It has a value on books only.
data[].tsStringWhen the data was generated, as Unix time in milliseconds.

Sample

Written by this site from the fields recorded on this page. It has not been run against a terminal, a server or an account, and the values in it are placeholders. No credential is typed into it: where a field holds one, the placeholder says where it comes from. Nothing is entered on this site.

{
  "op": "subscribe",
  "args": [
    {
      "instType": "usdt-futures",
      "topic": "books",
      "symbol": "BTCUSDT"
    }
  ]
}

Limits that apply at Bitget

LimitValueScopeSource
Public market data, legacy v1 API20 per 2 s per IP, public market dataPer IP address, public market data endpoints of the legacy v1 APIbitgetlimited.github.iochecked
Overall requests a minute6,000Per IP address, all requests to the common domain name, with REST and WebSocket sharing one allowancebitget.comchecked
Concurrent WebSocket connections100Per IP addressbitget.comchecked
WebSocket messages a second10Per WebSocket connection, counting ping, login, subscribe and unsubscribe messagesbitget.comchecked
WebSocket subscription requests an hour240Per WebSocket connectionbitget.comchecked
Concurrent WebSocket channel subscriptions1,000Per WebSocket connectionbitget.comchecked