Top Retail
Implementation details
Class names
Model name | Parameters class | Data class |
---|---|---|
TopRetail | TopRetailQueryParams | TopRetailData |
Import Statement
from openbb_core.provider.standard_models.top_retail import (
TopRetailData,
TopRetailQueryParams,
)
Parameters
- standard
- nasdaq
Name | Type | Description | Default | Optional |
---|---|---|---|---|
limit | int | The number of data entries to return. | 5 | True |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
limit | int | The number of data entries to return. | 5 | True |
Data
- standard
- nasdaq
Name | Type | Description |
---|---|---|
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. |
Name | Type | Description |
---|---|---|
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. |