Forget (forget)

Immediately cancel the real-time stream of messages with a specific ID.

forget(forget: str, passthrough: Optional[Any] = None, req_id: Optional[int] = None) → int
Parameters:
  • forget (str) – ID of the real-time stream of messages to cancel.
  • 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.forget(
    'd1ee7d0d-3ca9-fbb4-720b-5312d487185b'
)

See also