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​

NameTypeDescriptionDefaultOptional
limitintThe number of data entries to return.5True
providerLiteral['nasdaq']The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'nasdaq' if there is no default.nasdaqTrue

Data​

NameTypeDescription
datedateThe date of the data.
symbolstrSymbol representing the entity requested in the data.
activityfloatActivity of the symbol.
sentimentfloatSentiment of the symbol. 1 is bullish, -1 is bearish.