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

query: str
Search query.

is_symbol: bool
Default: False
Whether to search by ticker symbol.

query: str
Search query.

is_symbol: bool
Default: False
Whether to search by ticker symbol.

use_cache: bool
Default: True
When True, the Cboe Index directory will be cached for 24 hours. Set as False to bypass.

---

Returns

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

symbol: str
Symbol representing the entity requested in the data.

name: str
Name of the index.

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.