active
Get the most actively traded stocks based on volume.
Examples
from openbb import obb
obb.equity.discovery.active(provider='yfinance')
obb.equity.discovery.active(sort='desc', provider='yfinance')
Parameters
- standard
- yfinance
Name | Type | Description | Default | Optional |
---|---|---|---|---|
sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True |
Returns
OBBject
results : List[EquityActive]
Serializable results.
provider : Optional[Literal['yfinance']]
Provider name.
warnings : Optional[List[Warning_]]
List of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
Data
- standard
- yfinance
Name | Type | Description |
---|---|---|
symbol | str | Symbol representing the entity requested in the data. |
name | str | Name of the entity. |
price | float | Last price. |
change | float | Change in price. |
percent_change | float | Percent change. |
volume | Union[int, float] | The trading volume. |
Name | Type | Description |
---|---|---|
symbol | str | Symbol representing the entity requested in the data. |
name | str | Name of the entity. |
price | float | Last price. |
change | float | Change in price. |
percent_change | float | Percent change. |
volume | Union[int, float] | The trading volume. |
market_cap | float | Market Cap displayed in billions. |
avg_volume_3_months | float | Average volume over the last 3 months in millions. |
pe_ratio_ttm | float | PE Ratio (TTM). |