orders_history_by_filter
orders_history_by_filter (order_type initial_action base rel from_price to_price from_volume to_volume from_timestamp to_timestamp was_taker status include_details)
The orders_history_by_filter method returns all orders whether active or inactive that match the selected filters. Please note that all filters (order_type initial_action, etc.) are combined using logical AND.
| Structure | Type | Description |
|---|---|---|
| order_type | string | return only orders that match the order_type; order_type can be "Maker" or "Taker" |
| initial_action | string | return only orders that match the initial_action; initial_action can be "Sell" or "Buy". Note that maker order initial_action is considered "Sell" |
| base | string | return only orders that match the order.base = base condition |
| rel | string | return only orders that match the order.rel = rel condition |
| from_price | varies | return only orders that match the order.price >= from_price condition |
| to_price | varies | return only orders that match the order.price <= to_price condition |
| from_volume | varies | return only orders that match the order.volume >= from_volume condition |
| to_volume | varies | return only orders that match the order.volume <= to_volume condition |
| from_timestamp | integer | Timestamp in UNIX format. Return only orders that match the order.created_at >= from_timestamp condition |
| to_timestamp | number | Timestamp in UNIX format. return only orders that match the order.created_at <= to_timestamp condition |
| was_taker | bool | return only GoodTillCancelled orders that got converted from taker to maker |
| status | string | return only orders that match the status; status can be:
|
| include_details | bool | whether to include complete order details in response; defaults to false |
| Structure | Type | Description |
|---|---|---|
| orders | array of order objects | Array of OrderSummaryData that match the selected filters. |
| details | array | array of complete order details for every order that matches the selected filters; returns [] if include_details is false or not included in the |
| details.type | string | type of the order; "Maker" or "Taker" |
| details.order | object | A standard OrderDataV1 objects containing outstanding asks |
| found_records | number | the number of returned orders |
| warnings | array | array containing warnings objects |
| warnings.uuid | string | uuid of the order that produced this warning |
| warnings.warning | string | warning message |
POST
orders_history_by_filter{
"userpass": "RPC_UserP@SSW0RD",
"method": "orders_history_by_filter",
"order_type": "Taker",
"initial_action": "Buy"
}
POST
orders_history_by_filter{
"userpass": "RPC_UserP@SSW0RD",
"method": "orders_history_by_filter",
"base": "DOC",
"rel": "MARTY"
}
POST
orders_history_by_filter{
"userpass": "RPC_UserP@SSW0RD",
"method": "orders_history_by_filter",
"base": "DOC",
"from_price": 1,
"to_volume": 1
}
POST
orders_history_by_filter{
"userpass": "RPC_UserP@SSW0RD",
"method": "orders_history_by_filter",
"was_taker": true,
"from_timestamp": 1611705600
}
POST
orders_history_by_filter{
"userpass": "RPC_UserP@SSW0RD",
"method": "orders_history_by_filter",
"status": "Timed Out",
"include_details": true
}