Skip to main content

search

Search selected query for tickers.

Source Code: [link]

openbb.stocks.search(query: str = "", country: str = "", sector: str = "", industry_group: str = "", industry: str = "", exchange: str = "", exchange_country: str = "", all_exchanges: bool = False)

Parameters

NameTypeDescriptionDefaultOptional
querystrThe search term used to find company tickersTrue
countrystrSearch by country to find stocks matching the criteriaTrue
sectorstrSearch by sector to find stocks matching the criteriaTrue
industry_groupstrSearch by industry group to find stocks matching the criteriaTrue
industrystrSearch by industry to find stocks matching the criteriaTrue
exchangestrSearch by exchange to find stock matching the criteriaTrue
exchange_countrystrSearch by exchange country to find stock matching the criteriaTrue
all_exchangesboolWhether to search all exchanges, without this option only the United States market is searchedFalseTrue

Returns

TypeDescription
pd.DataFrameDataframe of search results.
Empty Dataframe if none are found.

Examples

from openbb_terminal.sdk import openbb
openbb.stocks.search(country="United States", exchange_country="Germany")