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
- fmp
- tmx
- yfinance
sort: Literal['asc', 'desc']
Default: desc
Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.
sort: Literal['asc', 'desc']
Default: desc
Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.
sort: Literal['asc', 'desc']
Default: desc
Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.
category: Literal['dividend', 'energy', 'healthcare', 'industrials', 'price_performer', 'rising_stars', 'real_estate', 'tech', 'utilities', '52w_high', 'volume']
Default: price_performer
The category of list to retrieve. Defaults to price_performer.
sort: Literal['asc', 'desc']
Default: desc
Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.
limit: int
Default: 200
Limit the number of results.
Data
- standard
- fmp
- tmx
- yfinance
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[float, int]
The trading volume.
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[float, int]
The trading volume.
exchange: str
Stock exchange where the security is listed.
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[float, int]
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.
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[float, int]
The trading volume.
open: float
Open price for the day.
high: float
High price for the day.
low: float
Low price for the day.
previous_close: float
Previous close price.
ma50: float
50-day moving average.
ma200: float
200-day moving average.
year_high: float
52-week high.
year_low: float
52-week low.
market_cap: float
Market Cap.
shares_outstanding: float
Shares outstanding.
book_value: float
Book value per share.
price_to_book: float
Price to book ratio.
eps_ttm: float
Earnings per share over the trailing twelve months.
eps_forward: float
Forward earnings per share.
pe_forward: float
Forward price-to-earnings ratio.
dividend_yield: float
Trailing twelve month dividend yield.
exchange: str
Exchange where the stock is listed.
exchange_timezone: str
Timezone of the exchange.
earnings_date: datetime
Most recent earnings date.
currency: str
Currency of the price data.