Active Symbols (active_symbols)¶

Retrieve a list of all currently active symbols (underlying markets upon which contracts are available for trading).

active_symbols(active_symbols: str, landing_company: Optional[str] = None, product_type: Optional[str] = None, passthrough: Optional[Any] = None, req_id: Optional[int] = None) → int¶

Parameters:	active_symbols (str) – If you use brief, only a subset of fields will be returned. landing_company (Optional[str]) – [Optional] If you specify this field, only symbols available for trading by that landing company will be returned. If you are logged in, only symbols available for trading by your landing company will be returned regardless of what you specify in this field. product_type (Optional[str]) – [Optional] If you specify this field, only symbols that can be traded through that product type will be returned. 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.active_symbols(
    'brief'
    product_type='basic'
)