Forget All (forget_all)¶

Immediately cancel the real-time streams of messages of given type.

forget_all(forget_all: Union[List], passthrough: Optional[Any] = None, req_id: Optional[int] = None) → int¶

Parameters:	forget_all (Union[List]) – Cancel all streams by type. The value can be either a single type e.g. “ticks”, or an array of multiple types e.g. [“candles”, “ticks”]. 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_all(
    'ticks'
)