orderbook
orderbook base rel
The v2 orderbook method requests from the network the currently available orders for the specified trading pair.
| Structure | Type | Description |
|---|---|---|
| base | string | Base currency of a pair |
| rel | string | Related currency, also known as the "quote currency" |
| Structure | Type | Description |
|---|---|---|
| base | string | the name of the coin the user desires to receive |
| rel | string | the name of the coin the user will trade |
| numasks | integer | the number of outstanding asks |
| numbids | integer | the number of outstanding bids |
| netid | integer | the id of the network on which the request is made (default is 8762) |
| asks | array of objects | an array of standard Order objects containing outstanding asks |
| bids | array of objects | an array of standard Order objects containing outstanding bids |
| timestamp | integer | the time the orderbook was requested |
| total_asks_base_vol | object | A standard OrderAmount object. |
| total_asks_rel_vol | object | A standard OrderAmount object. |
| total_bids_base_vol | object | A standard OrderAmount object. |
| total_bids_rel_vol | object | A standard OrderAmount object. |
OrderAddress object structure
| Structure | Type | Description |
|---|---|---|
| address_type | string | Generally Transparent, but may be Shielded for supporting coins. |
| address_data | string | The actual address text for sending and receiving funds. |
OrderAmount object structure
| Structure | Type | Description |
|---|---|---|
| decimal | string (decimal) | Decimal numeric representation of the volume |
| rational | object | Rational number representation of the volume (num-rational crate format) |
| fraction | object | A FractionAmount object, representing the volume |
FractionAmount object structure
| Structure | Type | Description |
|---|---|---|
| numer | string (decimal) | The numerator of the fraction |
| denom | object | The denominator of the fraction |
Order object structure
| Structure | Type | Description |
|---|---|---|
| coin | string | The name of the base coin; the user desires this |
| address | object | A standard OrderAddress object |
| price | object | The price in rel the user is willing to pay per one unit of the base coin |
| pubkey | string | The pubkey of the offer provider |
| uuid | string | The uuid of order |
| is_mine | bool | Whether the order is placed by me |
| conf_settings | object | A standard ConfSettings object |
| base_max_volume | object | A standard OrderAmount object representing the maximum base amount for this order |
| base_min_volume | object | A standard OrderAmount object representing the minimum base amount for this order |
| rel_max_volume | object | A standard OrderAmount object representing the maximum rel amount for this order |
| rel_min_volume | object | A standard OrderAmount object representing the minimum rel amount for this order |
| base_max_volume_aggr | object | A standard OrderAmount object representing the maximum aggregated base amount at the specified price. The sum of max base volumes of the current order and all orders with a worse price. |
| rel_max_volume_aggr | object | A standard OrderAmount object representing the maximum aggregated rel amount at the specified price. The sum of max rel volumes of the current order and all orders with a worse price. |
ConfSettings object structure
| Structure | Type | Description |
|---|---|---|
| base_confs | number | the confirmations settings of base coin set by the offer provider |
| base_nota | bool | the notarisation settings of base coin set by the offer provider |
| rel_confs | number | the confirmations settings of rel coin set by the offer provider |
| rel_nota | bool | the notarisation settings of rel coin set by the offer provider |
Orderbook
POST
orderbook{
"mmrpc": "2.0",
"userpass": "testpsw",
"method": "orderbook",
"params": {
"base": "DGB",
"rel": "DASH"
},
"id": 42
}