Skip to main content
Version: v4

Short Volume


Implementation details​

Class names​

Model nameParameters classData class
ShortVolumeShortVolumeQueryParamsShortVolumeData

Import Statement​

from openbb_core.provider.standard_models.short_volume import (
ShortVolumeData,
ShortVolumeQueryParams,
)

Parameters​

symbol: str
Symbol to get data for.

Data​

date: date | None | str
The date of the data.

market: str | None
Reporting Facility ID. N=NYSE TRF, Q=NASDAQ TRF Carteret, B=NASDAQ TRY Chicago, D=FINRA ADF

short_volume: int | None
Aggregate reported share volume of executed short sale and short sale exempt trades during regular trading hours

short_exempt_volume: int | None
Aggregate reported share volume of executed short sale exempt trades during regular trading hours

total_volume: int | None
Aggregate reported share volume of executed trades during regular trading hours