Orderbook
API-v1orderbook
The orderbook
method requests from the network the currently available orders for the specified trading pair.
Parameter | Type | Required | Description |
---|---|---|---|
base | string | ✓ | Base currency of a pair |
rel | string | ✓ | Related currency, also known as the "quote currency" |
Parameter | Type | Description |
---|---|---|
asks | array of objects | An array of standard OrderDataV1 objects containing outstanding asks |
base | string | The name of the coin the user desires to receive |
netid | number | The id of the network on which the request is made |
numbids | number | The number of outstanding bids |
numasks | number | The number of outstanding asks |
rel | string | The name of the coin the user will trade |
timestamp | number | The timestamp of the orderbook request |
bids | array of objects | An array of standard OrderDataV1 objects containing outstanding bids |
total_asks_base_vol | string (decimal) | The base volumes sum of all asks |
total_asks_base_vol_fraction | fraction | The total_asks_base_vol represented as a standard FractionalValue object. |
total_asks_base_vol_rat | rational | The total_asks_base_vol represented as a standard RationalValue object. |
total_asks_rel_vol | string (decimal) | The rel volumes sum of all asks |
total_asks_rel_vol_fraction | fraction | The total_asks_rel_vol represented as a standard FractionalValue object. |
total_asks_rel_vol_rat | rational | The total_asks_rel_vol represented as a standard RationalValue object. |
total_bids_base_vol | string (decimal) | The base volumes sum of all bids |
total_bids_base_vol_fraction | fraction | The total_bids_base_vol represented as a standard FractionalValue object. |
total_bids_base_vol_rat | rational | The total_bids_base_vol represented as a standard RationalValue object. |
total_bids_rel_vol | string (decimal) | The rel volumes sum of all bids |
total_bids_rel_vol_fraction | fraction | The total_bids_rel_vol represented as a standard FractionalValue object. |
total_bids_rel_vol_rat | rational | The total_bids_rel_vol represented as a standard RationalValue object. |
orderbook
POST
orderbook{
"userpass": "RPC_UserP@SSW0RD",
"method": "orderbook",
"base": "DOC",
"rel": "MARTY"
}