AnnouncementsGuidesAPI ReferenceSupport
API Reference

Orderbook

Request

The requests is consisted of JSON Object and the response is also JSON Object. Requests are divided into ticket field, type field, and format field, and multiple type fields can be specified in one request. Please refer to Request method and format for ticket field and format field.

📘

Request format

[{Ticket Field},{Type Field},....,{Type Field},{Format Field}]

Type Field

In this field, you have to list the market data you want to receive.

"is_only_snapshot" and "is_only_realtime" fields are optional and both snapshot and real-time data will be received if they are omitted.

Field Name
Type
Description
Required
Default
typeStringdata type
- orderbook: Orderbooks		O
codesListMarket code list
*Must be requested in capital letters.		O
is_only_snapshotBooleanOnly provides snapshot dataXfalse
is_only_realtimeBooleanOnly provides real-time dataXfalse

📘

Custom function for Orderbook Unit quantity is added from v1.1.0

From v1.1.0, you can adjust the quantity of Orderbook Units within the maximum provided amount (30) only for orderbook type packets.

Please input the market code and unit quantity in the codes as follows.

Format: {code}.{count}
ex) "SGD-BTC.5", "SGD-ETH.3"

Response

Field Name
Simplified Format (format: SIMPLE)
Description
TypeValue
typetyTypeStringorderbook
codecdMarket code (ex. SGD-BTC)String
total_ask_sizetasTotal remaining volume of asking ordersDouble
total_bid_sizetbsTotal remaining volume of bidding ordersDouble
orderbook_unitsobuOrder book detailsList of Objects
ask_priceapAsk priceDouble
bid_pricebpBid priceDouble
ask_sizeasRemaining volume of askingDouble
bid_sizebsRemaining volume of biddingDouble
timestamptmsTimestamp (millisecond)Long

Example

Request

[
  {
    "ticket": "test example"
  },
  {
    "type": "orderbook",
    "codes": [
      "SGD-BTC",
      "SGD-ETH"
    ]
  },
  {
    "format": "DEFAULT"
  }
]

Response

{
  "type": "orderbook",
  "code": "SGD-BTC",
  "timestamp": 1746602359173,
  "total_ask_size": 0.68780013,
  "total_bid_size": 0.78754733,
  "orderbook_units": [
    {
      "ask_price": 125056.0,
      "bid_price": 124743.0,
      "ask_size": 0.17,
      "bid_size": 0.17
    },
    {
      "ask_price": 125207.0,
      "bid_price": 124332.0,
      "ask_size": 0.09,
      "bid_size": 0.09
    },
    {
      "ask_price": 125416.0,
      "bid_price": 124167.0,
      "ask_size": 0.2,
      "bid_size": 0.2
    },
    {
      "ask_price": 126661.0,
      "bid_price": 122917.0,
      "ask_size": 0.01210697,
      "bid_size": 0.01844114
    },
    {
      "ask_price": 126786.0,
      "bid_price": 122716.0,
      "ask_size": 0.01142233,
      "bid_size": 0.0175997
    },
    {
      "ask_price": 126997.0,
      "bid_price": 122577.0,
      "ask_size": 0.01442522,
      "bid_size": 0.02204438
    },
    {
      "ask_price": 127288.0,
      "bid_price": 122283.0,
      "ask_size": 0.0139072,
      "bid_size": 0.02114427
    },
    {
      "ask_price": 127451.0,
      "bid_price": 122002.0,
      "ask_size": 0.01378211,
      "bid_size": 0.0203521
    },
    {
      "ask_price": 127946.0,
      "bid_price": 121665.0,
      "ask_size": 0.0128153,
      "bid_size": 0.01977116
    },
    {
      "ask_price": 127970.0,
      "bid_price": 121504.0,
      "ask_size": 0.0084267,
      "bid_size": 0.0129707
    },
    {
      "ask_price": 128351.0,
      "bid_price": 121372.0,
      "ask_size": 0.00766313,
      "bid_size": 0.04750075
    },
    {
      "ask_price": 128649.0,
      "bid_price": 121263.0,
      "ask_size": 0.00716242,
      "bid_size": 0.0123517
    },
    {
      "ask_price": 128849.0,
      "bid_price": 120969.0,
      "ask_size": 0.00690843,
      "bid_size": 0.01155361
    },
    {
      "ask_price": 128956.0,
      "bid_price": 120643.0,
      "ask_size": 0.00732903,
      "bid_size": 0.01096038
    },
    {
      "ask_price": 129000.0,
      "bid_price": 120436.0,
      "ask_size": 0.03875968,
      "bid_size": 0.01039539
    },
    {
      "ask_price": 129066.0,
      "bid_price": 120095.0,
      "ask_size": 0.00655781,
      "bid_size": 0.01010256
    },
    {
      "ask_price": 129228.0,
      "bid_price": 119824.0,
      "ask_size": 0.00684494,
      "bid_size": 0.00948499
    },
    {
      "ask_price": 129231.0,
      "bid_price": 119618.0,
      "ask_size": 0.00626955,
      "bid_size": 0.00903197
    },
    {
      "ask_price": 129515.0,
      "bid_price": 119279.0,
      "ask_size": 0.00595153,
      "bid_size": 0.00853212
    },
    {
      "ask_price": 129579.0,
      "bid_price": 119120.0,
      "ask_size": 0.0064701,
      "bid_size": 0.00172935
    },
    {
      "ask_price": 130312.0,
      "bid_price": 118969.0,
      "ask_size": 0.00553463,
      "bid_size": 0.0080544
    },
    {
      "ask_price": 130535.0,
      "bid_price": 118613.0,
      "ask_size": 0.00450619,
      "bid_size": 0.00770287
    },
    {
      "ask_price": 130797.0,
      "bid_price": 118290.0,
      "ask_size": 0.00413189,
      "bid_size": 0.00712616
    },
    {
      "ask_price": 131288.0,
      "bid_price": 118107.0,
      "ask_size": 0.00452539,
      "bid_size": 0.00674375
    },
    {
      "ask_price": 131399.0,
      "bid_price": 117808.0,
      "ask_size": 0.00369111,
      "bid_size": 0.00658978
    },
    {
      "ask_price": 131510.0,
      "bid_price": 117595.0,
      "ask_size": 0.00417261,
      "bid_size": 0.0060327
    },
    {
      "ask_price": 131727.0,
      "bid_price": 117300.0,
      "ask_size": 0.00342738,
      "bid_size": 0.00566733
    },
    {
      "ask_price": 131821.0,
      "bid_price": 117156.0,
      "ask_size": 0.00392284,
      "bid_size": 0.00538776
    },
    {
      "ask_price": 131867.0,
      "bid_price": 116805.0,
      "ask_size": 0.00326427,
      "bid_size": 0.00533339
    },
    {
      "ask_price": 132107.0,
      "bid_price": 116593.0,
      "ask_size": 0.00382137,
      "bid_size": 0.00494292
    }
  ],
  "stream_type": "SNAPSHOT"
}