search

Filter indices for rows containing the query.

Examples

from openbb import obb
obb.index.search(provider='cboe')
obb.index.search(query='SPX', provider='cboe')

---

Parameters

• standard
• cboe

Name	Type	Description	Default	Optional
query	str	Search query.		True
is_symbol	bool	Whether to search by ticker symbol.	False	True
provider	Literal['cboe']	The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: cboe.	None	True

Name	Type	Description	Default	Optional
query	str	Search query.		True
is_symbol	bool	Whether to search by ticker symbol.	False	True
provider	Literal['cboe']	The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: cboe.	None	True
use_cache	bool	When True, the Cboe Index directory will be cached for 24 hours. Set as False to bypass.	True	True

---

Returns

OBBject
    results : List[IndexSearch]
        Serializable results.

    provider : Optional[Literal['cboe']]
        Provider name.

    warnings : Optional[List[Warning_]]
        List of warnings.

    chart : Optional[Chart]
        Chart object.

    extra : Dict[str, Any]
        Extra info.

---

Data

• standard
• cboe

Name	Type	Description
symbol	str	Symbol representing the entity requested in the data.
name	str	Name of the index.

Name	Type	Description
symbol	str	Symbol representing the entity requested in the data.
name	str	Name of the index.
description	str	Description for the index.
data_delay	int	Data delay for the index. Valid only for US indices.
currency	str	Currency for the index.
time_zone	str	Time zone for the index. Valid only for US indices.
open_time	datetime.time	Opening time for the index. Valid only for US indices.
close_time	datetime.time	Closing time for the index. Valid only for US indices.
tick_days	str	The trading days for the index. Valid only for US indices.
tick_frequency	str	Tick frequency for the index. Valid only for US indices.
tick_period	str	Tick period for the index. Valid only for US indices.