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 |
| provider | Literal['nasdaq'] | The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: nasdaq. | None | True |
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| limit | int | The number of data entries to return. | 5 | True |
| provider | Literal['nasdaq'] | The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: nasdaq. | None | True |
Data
- standard
- nasdaq
| Name | Type | Description |
|---|---|---|
| date | date | 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 | date | 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. |