book

Returns a snapshot of the specified order book with max 25 levels on each side

POST api/book

Payload

{
    "instrument": "BTC-USD",
    "tradable": true
}

Payload for Masters

{
    "instrument": "BTC-USD",
    "tradable": true,
    "clientId": 123
}

200 OK

[
    [       // Bids
        [
            1100000000000,    // Price
            11000000          // Size
        ],
        [
            1099900000000,
            100000000
        ]
    ],
    [       // Asks
        [
            1100100000000,    // Price
            80000000          // Size
        ],
        [
            1100200000000,
            200000000
        ]
    ]
]

400 Bad request

{
    "error": 2
}

Request parameters

Field name	Type	Description
instrument	string	Instrument name
tradable	boolean	Default: false Whether to return Tradable order book. By default method returns Global order book.
clientId	unsigned int32	Specify the sub-account ID (Only for Master Accounts)

Response description

Filed name	Type	Description
	Array[2]	Book
0	Array of Levels	Bid Levels (sorted by descending price)
1	Array of Levels	Ask Levels (sorted by ascending price)
Level	Array[2]
0	Efx::Price	Level price
1	Efx::Size	Level total size