mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-06 09:22:26 +00:00
1.5 KiB
Vendored
1.5 KiB
Vendored
title, description
| title | description |
|---|---|
| search | OpenBB SDK Function |
search
Search selected query for tickers.
Source Code: [link]
openbb.stocks.search(query: str = "", country: str = "", sector: str = "", industry: str = "", exchange_country: str = "", limit: int = 0)
Parameters
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| query | str | The search term used to find company tickers | True | |
| country | str | Search by country to find stocks matching the criteria | True | |
| sector | str | Search by sector to find stocks matching the criteria | True | |
| industry | str | Search by industry to find stocks matching the criteria | True | |
| exchange_country | str | Search by exchange country to find stock matching | True | |
| limit | int | The limit of companies shown. | 0 | True |
Returns
| Type | Description |
|---|---|
| pd.DataFrame | Search results |
Examples
from openbb_terminal.sdk import openbb
openbb.stocks.search(country="united states", exchange_country="Germany")