Short Volume
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
ShortVolume | ShortVolumeQueryParams | ShortVolumeData |
Import Statement
from openbb_core.provider.standard_models.short_volume import (
ShortVolumeData,
ShortVolumeQueryParams,
)
Parameters
- standard
- stockgrid
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | str | Symbol to get data for. | False | |
| provider | Literal['stockgrid'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'stockgrid' if there is no default. | stockgrid | True |
| Name | Type | Description | Default | Optional |
|---|---|---|---|---|
| symbol | str | Symbol to get data for. | False | |
| provider | Literal['stockgrid'] | The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'stockgrid' if there is no default. | stockgrid | True |
Data
- standard
- stockgrid
| Name | Type | Description |
|---|---|---|
| date | date | The date of the data. |
| market | str | Reporting Facility ID. N=NYSE TRF, Q=NASDAQ TRF Carteret, B=NASDAQ TRY Chicago, D=FINRA ADF |
| short_volume | int | Aggregate reported share volume of executed short sale and short sale exempt trades during regular trading hours |
| short_exempt_volume | int | Aggregate reported share volume of executed short sale exempt trades during regular trading hours |
| total_volume | int | Aggregate reported share volume of executed trades during regular trading hours |
| Name | Type | Description |
|---|---|---|
| date | date | The date of the data. |
| market | str | Reporting Facility ID. N=NYSE TRF, Q=NASDAQ TRF Carteret, B=NASDAQ TRY Chicago, D=FINRA ADF |
| short_volume | int | Aggregate reported share volume of executed short sale and short sale exempt trades during regular trading hours |
| short_exempt_volume | int | Aggregate reported share volume of executed short sale exempt trades during regular trading hours |
| total_volume | int | Aggregate reported share volume of executed trades during regular trading hours |
| close | float | Closing price of the stock on the date. |
| short_volume_percent | float | Percentage of the total volume that was short volume. |