Skip to main content

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.

Optional: False

Data

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