On this page

latest contributor to this doc

Last Edit:

@gcharang

orderbook

orderbook base rel

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

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

StructureTypeDescription
asksarray of objectsAn array of standard OrderDataV1 objects containing outstanding asks
bidsarray of objectsAn array of standard OrderDataV1 objects containing outstanding bids
numasksnumberthe number of outstanding asks
numbidsnumberthe number of outstanding bids
basestringthe name of the coin the user desires to receive
relstringthe name of the coin the user will trade
timestampnumberthe timestamp of the orderbook request
netidnumberthe id of the network on which the request is made (default is 0)
total_asks_base_volstring (decimal)the base volumes sum of all asks
total_asks_base_vol_ratrationalthe total_asks_base_vol represented as a standard RationalValue object.
total_asks_base_vol_fractionfractionthe total_asks_base_vol represented as a standard FractionalValue object.
total_asks_rel_volstring (decimal)the rel volumes sum of all asks
total_asks_rel_vol_ratrationalthe total_asks_rel_vol represented as a standard RationalValue object.
total_asks_rel_vol_fractionfractionthe total_asks_rel_vol represented as a standard FractionalValue object.
total_bids_base_volstring (decimal)the base volumes sum of all bids
total_bids_base_vol_ratrationalthe total_bids_base_vol represented as a standard RationalValue object.
total_bids_base_vol_fractionfractionthe total_bids_base_vol represented as a standard FractionalValue object.
total_bids_rel_volstring (decimal)the rel volumes sum of all bids
total_bids_rel_vol_ratrationalthe total_bids_rel_vol represented as a standard RationalValue object.
total_bids_rel_vol_fractionfractionthe total_bids_rel_vol represented as a standard FractionalValue object.

Orderbook

POST
orderbook
{
  "userpass": "RPC_UserP@SSW0RD",
  "method": "orderbook",
  "base": "HELLO",
  "rel": "WORLD"
}