Skip to main content
POST
/
market-data
/
order-book
/
volume-for-price
Get Volume For Price
curl --request POST \
  --url http://localhost:8000/market-data/order-book/volume-for-price \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connector_name": "<string>",
  "trading_pair": "<string>",
  "is_buy": true,
  "price": 123
}
'
{
  "trading_pair": "<string>",
  "is_buy": true,
  "timestamp": 123,
  "query_volume": 123,
  "query_price": 123,
  "result_price": 123,
  "result_volume": 123,
  "result_quote_volume": 123,
  "average_price": 123
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

Request model for getting volume at a specific price

connector_name
string
required

Name of the connector

trading_pair
string
required

Trading pair

is_buy
boolean
required

True for buy side, False for sell side

price
number
required

Price to query volume for

Response

Successful Response

Response for order book query operations

trading_pair
string
required

Trading pair

is_buy
boolean
required

Query side (buy/sell)

timestamp
number
required

Query timestamp

query_volume
number | null

Queried volume

query_price
number | null

Queried price

result_price
number | null

Resulting price

result_volume
number | null

Resulting volume

result_quote_volume
number | null

Resulting quote volume

average_price
number | null

Average/VWAP price