GET

Level2 Order Book

Establish a WebSocket connection to get real-time updates for order books. Subscribe to a live feed of all outstanding buy and sell orders on the market for specific coins and tokens. Send messages when specific market conditions occur.

Header Params

Authorization string required

Bearer token for authorization

Body Params

object

type string required

The event type (e.g. "subscribe" or "unsubscribe")
channel string required

The subscription channel (e.g. "level2" for order books)
accountId string required

The ID of the account
productId string required

The ID of product. (e.g. "TBTC-TUSD*")
includeCumulative boolean

Include cumulative size in each price level. When true, each level is [price, size, cumulativeSize] instead of [price, size]. cumulativeSize is the running total of size from the top of that side through the level.

Defaults to false

Responses

101

Switching Protocols. Once connected, the server may send:

WsOrderBooksResponse — level2 order book snapshot/updates
WsSubscriptionResponse — confirmation after every subscribe/unsubscribe request

Response Body

ONE OF

channel string

The channel name (e.g. "level2").
type string

The type of the response (e.g. "snapshot").
product string

The product name (e.g. "TBTC-TUSD*").
time string date-time

The timestamp of the snapshot.
bids array of array

An array of bid levels [price, size] or [price, size, cumulativeSize] when includeCumulative is true. cumulativeSize is the running total of size from the top of that side through the level.
asks array of array

An array of ask levels [price, size] or [price, size, cumulativeSize] when includeCumulative is true. cumulativeSize is the running total of size from the top of that side through the level.

type string enum required

Always "subscription_response".

subscription_response
channel string enum required

The channel the subscription applies to ("orders" or "level2").

orderslevel2
status string enum required
Outcome of the subscribe/unsubscribe request:
- subscribed — subscription was accepted and is now active.
- already_subscribed — (orders channel only) a subscription for this accountId was already active; no duplicate was created. For the level2 channel, duplicate subscribe requests return an error instead, because includeCumulative is fixed for the lifetime of a subscription and cannot be changed without unsubscribing first.
- unsubscribed — subscription was successfully removed.
subscribedalready_subscribedunsubscribed
accountId string

The ID of the account
productId string

The product ID, present for level2 subscriptions.
session_id string

The session ID for this WebSocket connection.

403

Forbidden - Insufficient permissions

Response Body

object

error string required
errorName string required
reqId string required

curl --request GET \ --url 'https://app.bitgo-test.com/api/prime/trading/v1/ws (level2)' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Authorization: string' \ --header 'content-type: application/json' \ --data '{,"type":"subscribe","channel":"level2","accountId":"f230fdebfa084ffebc7e00515f54603f","productId":"TBTC-TUSD*","includeCumulative":false}'

require 'uri' require 'net/http' url = URI("https://app.bitgo-test.com/api/prime/trading/v1/ws (level2)") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' request["Authorization"] = 'string' request["content-type"] = 'application/json' request.body = '{,"type":"subscribe","channel":"level2","accountId":"f230fdebfa084ffebc7e00515f54603f","productId":"TBTC-TUSD*","includeCumulative":false}' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://app.bitgo-test.com/api/prime/trading/v1/ws (level2)', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', 'Authorization' => 'string', 'content-type' => 'application/json', ], 'body' => '{,"type":"subscribe","channel":"level2","accountId":"f230fdebfa084ffebc7e00515f54603f","productId":"TBTC-TUSD*","includeCumulative":false}', ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/prime/trading/v1/ws (level2)" payload = {,"type":"subscribe","channel":"level2","accountId":"f230fdebfa084ffebc7e00515f54603f","productId":"TBTC-TUSD*","includeCumulative":false} headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN", "Authorization": "string", "content-type": "application/json" } response = requests.get(url, json=payload, headers=headers) print(response.text)

{ "asks": [ [ "7002.55", "2.7524" ] ], "bids": [ [ "7001.10", "1.5084" ] ], "channel": "level2", "product": "TBTC-TUSD*", "time": "2020-01-01T09:35:26.465Z", "type": "snapshot" }

{ "asks": [ [ "7002.55", "2.7524", "2.7524" ], [ "7003.00", "1.2000", "3.9524" ] ], "bids": [ [ "7001.10", "1.5084", "1.5084" ], [ "7000.50", "0.8000", "2.3084" ] ], "channel": "level2", "product": "TBTC-TUSD*", "time": "2020-01-01T09:35:26.465Z", "type": "snapshot" }