Skip to content

Get ticker data for all traded pairs of a specific base currency

GET
/iou/ticker_data/{base}

Retrieve ticker data for a given currency pair over defined period (interval). Sorted descending by base volume.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
base
required
string

  • Base currency of the pair as issuer address, followed by _ and the currency code. (Or XAH with no issuer)

  • Examples: XAH or rEvernodee8dJLaFsujS6q1EiXvZYmHXr8_EVR

Query Parameters

Section titled “Query Parameters ”
interval
required
string

  • Aggregation interval. Possible values are: s,m,h,d,M,y.

  • Example: 1d to aggregate data by 1 day intervals

date
string format: date-time

  • Specific date time the request should be based on. Defaults to now.

  • Format: 1970-01-01T00:00:00Z

min_exchanges
number
  • Only include results with the requested minimal number of exchanges.
base_as_counter
boolean
  • If true, reverts the data so that the base token becomes the counter token.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success reponse

  • date_from = Start date of the ticker data

  • date_to = End date of the ticker data

  • base = Base currency of the trading pair

  • counter = Counter currency of the trading pair

  • base_volume = The traded volume of the base currency

  • base_volume_buy = The buy volume of the base currency

  • base_volume_sell = The sell volume of the base currency

  • counter_volume = The toal traded volume of the counter currency

  • counter_volume_buy = The buy volume of the counter currency

  • counter_volume_sell = The sell volume of the counter currency

  • first = The first exchange rate of the pair in this time frame

  • high = The highest exchange rate of the pair in this time frame

  • low = The lowest exchange rate of the pair in this time frame

  • last = The last exchange rate of the pair in this time frame

  • exchanges = Total number of exchanges of the pair in this time frame

  • unique_buyers = Total number of unique accounts buying

  • unique_sellers = Total number of unique accounts selling

  • trend_interval = The rate trend of this pair for this time frame compared to the previous time frame. positive number = rate is in upwards trend. negative number = rate is in downwards trend

Array<object>
TickerData
object
date_from
required
string format: date-time
date_to
required
string format: date-time
base
required
string
counter
required
string
base_volume
required
number format: float
base_volume_buy
required
number format: float
base_volume_sell
required
number format: float
counter_volume
required
number format: float
counter_volume_buy
required
number format: float
counter_volume_sell
required
number format: float
first
required
number format: float
high
required
number format: float
low
required
number format: float
last
required
number format: float
exchanges
required
number format: integer
unique_buyers
required
number format: integer
unique_sellers
required
number format: integer
trend_interval
required
number format: integer

400

Section titled “400 ”

Query input malformed

ValidationError
object
message
required
string
code
string
path
string

Headers

Section titled “Headers ”
x-ratelimit-limit
integer

Maximum number of requests in the rate limit window.

x-ratelimit-remaining
integer

Number of remaining request in current rate limit window.

x-ratelimit-reset
integer

The seconds until the current rate limit window resets.

429

Section titled “429 ”

Too Many Requests

Headers

Section titled “Headers ”
x-ratelimit-limit
integer

Maximum number of requests in the rate limit window.

x-ratelimit-remaining
integer

Number of remaining request in current rate limit window.

x-ratelimit-reset
integer

The seconds until the current rate limit window resets.