v1

latestOpenAPI 3.0.32026-07-17588.3 KB

Market

The transitive orderbook (containing bids and asks) for the given base and quote token.

get/api/v1/markets/{market}

Path parameters

marketstring required

token pair of the form <buy token>-<sell token>

Query parameters

unit'baseunits' | 'atoms'

Example:baseunits

If baseunits (the default) all amounts are denominated in the "natural" unit of the respective token given by the number of decimals specified through the ERC20 interface. If set to atoms all amounts are denominated in the smallest available unit (atom) of the token.

batchIdinteger

The batch ID to compute the estimate for, only accounting orders that are valid at the specified batch. If no batch ID is specified, the current batch that is collecting orders will be used.

ignoreAddressesstring

Comma separated list of addresses in hex notation whose orders should be ignored. Capitalization of letters does not matter. No space after the commas.

blockNumberinteger

The block number to compute the estimate for. This will use the open orderbook at that block (i.e. orders that will be considered for solving the current batch at the block number). This parameter cannot be specified together with the "batchId" query parameter.

Response

Example response

{
  "asks": [
    {
      "price": 407.6755405630054,
      "volume": 9.389082650375993
    }
  ],
  "bids": [
    {
      "price": 5508028446685.359,
      "volume\"": 3.2264600472733105
    }
  ]
}