Equity Gainers
Implementation details
Class names
Model name | Parameters class | Data class |
---|---|---|
EquityGainers | EquityGainersQueryParams | EquityGainersData |
Import Statement
from openbb_core.provider.standard_models. import (
EquityGainersData,
EquityGainersQueryParams,
)
Parameters
- standard
- tmx
- 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 |
category | Literal['dividend', 'energy', 'healthcare', 'industrials', 'price_performer', 'rising_stars', 'real_estate', 'tech', 'utilities', '52w_high', 'volume'] | The category of list to retrieve. Defaults to price_performer . | price_performer | True |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
sort | Literal['asc', 'desc'] | Sort order. Possible values: 'asc', 'desc'. Default: 'desc'. | desc | True |
Data
- standard
- tmx
- 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. |
thirty_day_price_change | float | 30 Day Price Change. |
ninety_day_price_change | float | 90 Day Price Change. |
dividend_yield | float | Dividend Yield. |
avg_volume_10d | float | 10 Day Avg. Volume. |
rank | int | The rank of the stock in the list. |
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. |
avg_volume_3_months | float | Average volume over the last 3 months in millions. |
market_cap | float | Market Cap. |
pe_ratio_ttm | float | PE Ratio (TTM). |