search

Equity Search. Search for a company or stock ticker.

Example

from openbb import obb
obb.equity.search()

---

Parameters

• Standard
• sec

Name	Type	Description	Default	Optional
query	str	Search query.		True
is_symbol	bool	Whether to search by ticker symbol.	False	True
provider	Literal['cboe', 'sec']	The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default.	"cboe"	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', 'sec']	The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'cboe' if there is no default.	"cboe"	True
is_fund	bool	Whether to direct the search to the list of mutual funds and ETFs.	False	True
use_cache	bool	Whether to use the cache or not. Company names, tickers, and CIKs are cached for seven days.	True	True

---

Returns

OBBject
    results : List[EquitySearch]
        Serializable results.

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

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

    chart : Optional[Chart]
        Chart object.

    metadata: Optional[Metadata]
        Metadata info about the command execution.

---

Data

• Standard
• cboe
• sec

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

Name	Type	Description
symbol	str	Symbol representing the entity requested in the data.
name	str	Name of the company.
dpm_name	str	Name of the primary market maker.
post_station	str	Post and station location on the CBOE trading floor.

Name	Type	Description
symbol	str	Symbol representing the entity requested in the data.
name	str	Name of the company.
cik	str	Central Index Key