Order book

Get the aggregated order book for a market. 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/v2.0/markets/{id}/book/

Authentication

No authentication is required for this endpoint.

Parameters

integer

required

The unique identifier of the market.

string

required

The currency mode to query. Accepted values: play_money, real_money.

string

default:"long"

The position side to query. Accepted values: long, short.

Response

object[]

required

Aggregated bid levels, sorted from highest to lowest price.

Show properties

number

Price per share at this level (0–1).

number

Total number of shares available at this price level.

number

Total currency amount represented at this price level.

number

Total fees attributable to the shares offered at this price level.

number

Cumulative shares from the best bid down to and including this level.

number

Cumulative currency amount from the best bid down to and including this level.

number

Cumulative fees from the best bid down to and including this level.

number

Number of shares at this level belonging to you. Present when authenticated.

number

Number of shares at this level you have requested but that have not yet been filled. Present when authenticated.

object[]

required

Aggregated ask levels, sorted from lowest to highest price.

Show properties

number

Price per share at this level (0–1).

number

Total number of shares offered at this price level.

number

Total currency amount represented at this price level.

number

Total fees attributable to the shares offered at this price level.

number

Cumulative shares from the best ask up to and including this level.

number

Cumulative currency amount from the best ask up to and including this level.

number

Cumulative fees from the best ask up to and including this level.

number

Number of shares at this level belonging to you. Present when authenticated.

number

Number of shares at this level you have requested but that have not yet been filled. Present when authenticated.

Example

cURL

curl --request GET \
  --url "https://api.futuur.com/v2.0/markets/501/book/?currency_mode=play_money&position=long"

Sample response

{
  "bid": [
    {
      "price": 0.62,
      "total_shares": 120.0,
      "total_amount": 74.4,
      "total_fees": 0.12,
      "cumulative_shares": 120.0,
      "cumulative_amount": 74.4,
      "cumulative_fees": 0.12,
      "total_user_shares": 50.0,
      "total_user_shares_requested": 0.0
    },
    {
      "price": 0.60,
      "total_shares": 80.0,
      "total_amount": 48.0,
      "total_fees": 0.08,
      "cumulative_shares": 200.0,
      "cumulative_amount": 122.4,
      "cumulative_fees": 0.20,
      "total_user_shares": 0.0,
      "total_user_shares_requested": 0.0
    }
  ],
  "ask": [
    {
      "price": 0.64,
      "total_shares": 95.0,
      "total_amount": 60.8,
      "total_fees": 0.10,
      "cumulative_shares": 95.0,
      "cumulative_amount": 60.8,
      "cumulative_fees": 0.10,
      "total_user_shares": 0.0,
      "total_user_shares_requested": 10.0
    },
    {
      "price": 0.66,
      "total_shares": 60.0,
      "total_amount": 39.6,
      "total_fees": 0.06,
      "cumulative_shares": 155.0,
      "cumulative_amount": 100.4,
      "cumulative_fees": 0.16,
      "total_user_shares": 0.0,
      "total_user_shares_requested": 0.0
    }
  ]
}

Events

Markets

Orders

Wagers

Account

Realtime (websockets)

Endpoint

Authentication

Parameters

Response

Example

​Endpoint

​Authentication

​Parameters

​Response

​Example

Endpoint

Authentication

Parameters

Response

Example