Transactions Stream (transaction)

Subscribe to transaction notifications

Auth Scope(s): read, trading_information

transaction(subscribe: Optional[Union[bool, int]], passthrough: Optional[Any] = None, req_id: Optional[int] = None) → int
Parameters:
  • subscribe (Optional[Union[bool, int]]) – If set to 1, will send updates whenever there is an update to transactions. If not to 1 then it will not return any records.
  • 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.transaction(
    subscribe=1
)

See also