Get the aggregated order book for a market within an event. The response contains bid and ask arrays with cumulative depth data at each price level, allowing you to assess market liquidity and your position within it.
Endpoint GET https://api.futuur.com/events/{id}/order_book/
Authentication HMAC authentication is required. Include the following headers with every request:
Header Description KeyYour public API key TimestampCurrent Unix timestamp HMACSHA-512 signature of the request payload
Parameters The unique identifier of the event.
The currency mode to query. Accepted values: play_money, real_money.
The ID of the market within the event for which to retrieve the order book.
The position side to query. Accepted values: l (long), s (short).
Response Aggregated bid levels, sorted from highest to lowest price. Price per share at this level (0–1).
Total number of shares available at this price level.
Total currency amount represented at this price level.
Cumulative shares from the best bid down to and including this level.
Cumulative currency amount from the best bid down to and including this level.
Number of shares at this level belonging to you.
total_user_shares_requested
Number of shares at this level you have requested but that have not yet been filled.
Aggregated ask levels, sorted from lowest to highest price. Price per share at this level (0–1).
Total number of shares offered at this price level.
Total currency amount represented at this price level.
Cumulative shares from the best ask up to and including this level.
Cumulative currency amount from the best ask up to and including this level.
Number of shares at this level belonging to you.
total_user_shares_requested
Number of shares at this level you have requested but that have not yet been filled.
Example curl --request GET \ --url "https://api.futuur.com/events/1023/order_book/?currency_mode=play_money&market=501&position=l" \ --header "Key: YOUR_PUBLIC_KEY" \ --header "Timestamp: 1712500000" \ --header "HMAC: YOUR_HMAC_SIGNATURE"
{ "bids" : [ { "price" : 0.62 , "total_shares" : 120.0 , "total_amount" : 74.4 , "cumulative_shares" : 120.0 , "cumulative_amount" : 74.4 , "total_user_shares" : 50.0 , "total_user_shares_requested" : 0.0 }, { "price" : 0.60 , "total_shares" : 80.0 , "total_amount" : 48.0 , "cumulative_shares" : 200.0 , "cumulative_amount" : 122.4 , "total_user_shares" : 0.0 , "total_user_shares_requested" : 0.0 } ], "asks" : [ { "price" : 0.64 , "total_shares" : 95.0 , "total_amount" : 60.8 , "cumulative_shares" : 95.0 , "cumulative_amount" : 60.8 , "total_user_shares" : 0.0 , "total_user_shares_requested" : 10.0 }, { "price" : 0.66 , "total_shares" : 60.0 , "total_amount" : 39.6 , "cumulative_shares" : 155.0 , "cumulative_amount" : 100.4 , "total_user_shares" : 0.0 , "total_user_shares_requested" : 0.0 } ] }
