Skip to content

Get raw exchanges

GET
/iou/exchanges/{base}/{counter}

Retrieve Exchanges for a given currency pair over time.

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

counter
required
string
  • Counter currency of the pair as issuer address, followed by _ and a currency code. (Or XAH with no issuer)

  • Examples: XAH or rEvernodee8dJLaFsujS6q1EiXvZYmHXr8_EVR

account
string
  • Xahau Network address to use as filter.

  • The given address is used as filter on the fields: buyer, seller, provider and taker

start
string format: date-time
  • Filters results no earlier than the specified date time.

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

end
string format: date-time
  • Filters results no later than the specified date time.

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

min_base_volume
number
  • Only include exchanges with the requested minimal base volume.
min_counter_volume
number
  • Only include exchanges with the requested minimal counter volume.
descending
boolean
  • If true, return results in reverse chronological order by timestamp.
skip
number
  • Skip a defined number of entries.
limit
number
  • Limit the entries in the response.

  • Higher values result in slower response times!

Success response

  • base_amount = The amount of the base currency that was traded

  • counter_amount = The amount of the counter currency that was traded

  • rate = The amount of the counter currency acquired per 1 unit of the base currency

  • buyer = The account that acquired the base currency

  • seller = The account that acquired the counter currency

  • provider = The account that provided liquidity for this trade via existing offers

  • taker = The account that sent the transaction and took the liquidity

  • ledger_index = The ledger that included this transaction

  • tx_hash = The identifying hash of the transaction that executed this exchange

  • executed_time = The time the exchange occurred (usually the close time of the validated ledger_index)

Array<object>
Exchange

An object for exchange of currencies

object
base_amount
required

The amount of the base currency that was traded

number format: float
counter_amount
required

The amount of the counter currency that was traded

number format: float
rate
required

The amount of the counter currency acquired per 1 unit of the base currency

number format: float
buyer
required

The account that acquired the base currency

string
>= 1 characters
seller
required

The account that acquired the counter currency

string
>= 1 characters
provider
required

The account that had an existing offer in the ledger

string
>= 1 characters
taker
required

The account that sent the transaction which executed this exchange

string
>= 1 characters
ledger_index
required

The ledger that included this transaction

integer
tx_hash
required

The identifying hash of the transaction that executed this exchange

string
>= 1 characters
executed_time
required

The time the exchange occurred

string format: date-time

Query input malformed

ValidationError
object
message
required
string
code
string
path
string
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.

Too Many Requests

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.