Skip to main content

Equity Search


Implementation details​

Class names​

Model nameParameters classData class
EquitySearchEquitySearchQueryParamsEquitySearchData

Import Statement​

from openbb_core.provider.standard_models.equity_search import (
EquitySearchData,
EquitySearchQueryParams,
)

Parameters​

NameTypeDescriptionDefaultOptional
querystrSearch query.True
is_symbolboolWhether to search by ticker symbol.FalseTrue
use_cacheboolWhether to use the cache or not.TrueTrue
providerLiteral['intrinio', 'sec']The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'intrinio' if there is no default.intrinioTrue

Data​

NameTypeDescription
symbolstrSymbol representing the entity requested in the data.
namestrName of the company.