short_volume
Get reported Fail-to-deliver (FTD) data.
Examples
from openbb import obb
obb.equity.shorts.short_volume(symbol='AAPL', provider='stockgrid')
Parameters
- standard
- stockgrid
Name | Type | Description | Default | Optional |
---|---|---|---|---|
symbol | str | Symbol to get data for. | False |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
symbol | str | Symbol to get data for. | False |
Returns
OBBject
results : List[ShortVolume]
Serializable results.
provider : Optional[Literal['stockgrid']]
Provider name.
warnings : Optional[List[Warning_]]
List of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
Data
- standard
- stockgrid
Name | Type | Description |
---|---|---|
date | Union[date, str] | 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 | Union[date, str] | 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. |