search

Filter the Cboe index directory for rows containing the query.

Examples

from openbb import obb
# Search the Cboe index directory.
obb.cboe.index.search(query='uk', provider='cboe')
# Restrict the search to ticker symbols.
obb.cboe.index.search(query='BUK', is_symbol=True, provider='cboe')

Parameters

• standard
• cboe

query: str | None
Search query.

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

query: str | None
Search query.

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

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

---

Returns

results: CboeIndexSearch

Serializable results.

provider: str | None

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 | None
Description for the index.

data_delay: int | None
Data delay for the index. Valid only for US indices.

currency: str | None
Currency for the index.

time_zone: str | None
Time zone for the index. Valid only for US indices.

open_time: time | None
Opening time for the index. Valid only for US indices.

close_time: time | None
Closing time for the index. Valid only for US indices.

tick_days: str | None
The trading days for the index. Valid only for US indices.

tick_frequency: str | None
Tick frequency for the index. Valid only for US indices.

tick_period: str | None
Tick period for the index. Valid only for US indices.