P2P Order List (p2p_order_list)

List active orders.

Auth Scope(s): payments

p2p_order_list(active: Optional[Union[int, float, Decimal]] = None, advert_id: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, subscribe: Optional[Union[bool, int]] = None, passthrough: Optional[Any] = None, req_id: Optional[int] = None) → int
Parameters:
  • active (Optional[Union[int, float, Decimal]]) – [Optional] Should be 1 to list active, 0 to list inactive (historical).
  • advert_id (Optional[str]) – [Optional] If present, lists orders applying to a specific advert.
  • limit (Optional[int]) – [Optional] Used for paging.
  • offset (Optional[int]) – [Optional] Used for paging.
  • subscribe (Optional[Union[bool, int]]) – [Optional] If set to 1, will send updates whenever there is a change to any order belonging to you.
  • passthrough (Optional[Any]) – [Optional] Used to pass data through the websocket, which may be retrieved via the echo_req output field.
  • req_id (Optional[int]) – [Optional] Used to map request to response.
Returns:

req_id
Return type:

int

Example

binary.api.p2p_order_list(
    advert_id='1234'
)

See also