On this page

latest contributor to this doc

Last Edit:

@smk762

Orderbook

API-v1orderbook

The orderbook method requests from the network the currently available orders for the specified trading pair.

ParameterTypeRequiredDescription
basestringBase currency of a pair
relstringRelated currency, also known as the "quote currency"

ParameterTypeDescription
asksarray of objectsAn array of standard OrderDataV1 objects containing outstanding asks
basestringThe name of the coin the user desires to receive
netidnumberThe id of the network on which the request is made
numbidsnumberThe number of outstanding bids
numasksnumberThe number of outstanding asks
relstringThe name of the coin the user will trade
timestampnumberThe timestamp of the orderbook request
bidsarray of objectsAn array of standard OrderDataV1 objects containing outstanding bids
total_asks_base_volstring (decimal)The base volumes sum of all asks
total_asks_base_vol_fractionfractionThe total_asks_base_vol represented as a standard FractionalValue object.
total_asks_base_vol_ratrationalThe total_asks_base_vol represented as a standard RationalValue object.
total_asks_rel_volstring (decimal)The rel volumes sum of all asks
total_asks_rel_vol_fractionfractionThe total_asks_rel_vol represented as a standard FractionalValue object.
total_asks_rel_vol_ratrationalThe total_asks_rel_vol represented as a standard RationalValue object.
total_bids_base_volstring (decimal)The base volumes sum of all bids
total_bids_base_vol_fractionfractionThe total_bids_base_vol represented as a standard FractionalValue object.
total_bids_base_vol_ratrationalThe total_bids_base_vol represented as a standard RationalValue object.
total_bids_rel_volstring (decimal)The rel volumes sum of all bids
total_bids_rel_vol_fractionfractionThe total_bids_rel_vol represented as a standard FractionalValue object.
total_bids_rel_vol_ratrationalThe total_bids_rel_vol represented as a standard RationalValue object.

orderbook

POST
orderbook
{
  "userpass": "RPC_UserP@SSW0RD",
  "method": "orderbook",
  "base": "DOC",
  "rel": "MARTY"
}