top_retail
Track over $30B USD/day of individual investors trades.
It gives a daily view into retail activity and sentiment for over 9,500 US traded stocks, ADRs, and ETPs.
Examples
from openbb import obb
obb.equity.discovery.top_retail(provider='nasdaq')
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 |
Returns
OBBject
results : List[TopRetail]
Serializable results.
provider : Optional[Literal['nasdaq']]
Provider name.
warnings : Optional[List[Warning_]]
List of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
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. |