gainers

Get the top ETF gainers.

Examples

from openbb import obb
# Get the top ETF gainers.
obb.etf.discovery.gainers(provider='wsj')

Parameters

• standard
• wsj

sort: Literal['asc', 'desc']
Default: desc
Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.

limit: int
Default: 10
The number of data entries to return.

sort: Literal['asc', 'desc']
Default: desc
Sort order. Possible values: 'asc', 'desc'. Default: 'desc'.

limit: int
Default: 10
The number of data entries to return.

---

Returns

results: list[ETFGainers]

Serializable results.

provider: Optional[Literal['wsj']]

Provider name.

warnings: Optional[list[Warning_]]

list of warnings.

chart: Optional[Chart]

Chart object.

extra: dict[str, Any]

Extra info.

---

Data

• standard
• wsj

symbol: str
Symbol representing the entity requested in the data.

name: str
Name of the entity.

last_price: float
Last price.

percent_change: float
Percent change.

net_change: float
Net change.

volume: float
The trading volume.

date: date | str
The date of the data.

symbol: str
Symbol representing the entity requested in the data.

name: str
Name of the entity.

last_price: float
Last price.

percent_change: float
Percent change.

net_change: float
Net change.

volume: float
The trading volume.

date: date | str
The date of the data.

bluegrass_channel: str
Bluegrass channel.

country: str
Country of the entity.

mantissa: int
Mantissa.

type: str
Type of the entity.

formatted_price: str
Formatted price.

formatted_volume: str
Formatted volume.

formatted_price_change: str
Formatted price change.

formatted_percent_change: str
Formatted percent change.

url: str
The source url.