Skip to main content

Top Retail


Implementation details

Class names

Model nameParameters classData class
TopRetailTopRetailQueryParamsTopRetailData

Import Statement

from openbb_core.provider.standard_models.top_retail import (
TopRetailData,
TopRetailQueryParams,
)

Parameters

limit: int

The number of data entries to return.

Default: 5

Optional: True

Data

date: Union[date, str]

The date of the data.

symbol: str

Symbol representing the entity requested in the data.

activity: float

Activity of the symbol.

sentiment: float

Sentiment of the symbol. 1 is bullish, -1 is bearish.