okama.symbols_in_namespace

symbols_in_namespace(namespace='US', response_format='frame')

Return all symbols available in a namespace.

Parameters:

namespacestr, default settings.default_namespace

Namespace code such as "US", "XETR", or "INFL".

response_format{‘frame’, ‘json’}, default ‘frame’

Format of the returned namespace contents.

Returns:

pandas.DataFrame or list

Namespace contents.

• Returns a DataFrame when response_format='frame'.

• Returns the parsed API JSON payload as a list when response_format='json'.

Raises:

ValueError

If response_format is not 'frame' or 'json'.

Examples

>>> symbols = ok.symbols_in_namespace("US")
>>> symbols.empty
False
>>> {"symbol", "name", "currency"}.issubset(symbols.columns)
True