search

Search the Cboe US company directory for listed options symbols.

Examples

from openbb import obb
# Search the Cboe company directory by company name.
obb.cboe.equity.search(query='ETF', provider='cboe')
# Search by ticker symbol instead of name.
obb.cboe.equity.search(query='SPY', 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 company directory will be cached for 24 hours. Set as False to bypass.

---

Returns

results: CboeEquitySearch

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 | None
Symbol representing the entity requested in the data.

name: str | None
Name of the company.

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

name: str | None
Name of the company.

dpm_name: str | None
Name of the primary market maker.

post_station: str | None
Post and station location on the Cboe trading floor.