Short Interest
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
ShortInterest | ShortInterestQueryParams | ShortInterestData |
Import Statement
from openbb_core.provider.standard_models.equity_short_interest import (
ShortInterestData,
ShortInterestQueryParams,
)
Parameters
- standard
- tmx
symbol: str
Symbol to get data for.
use_cache: bool | None
Default: True
Whether to use the on-disk response cache. Set to False to bypass.
Data
- standard
- tmx
symbol: str
Symbol representing the entity requested in the data.
settlement_date: date | None
The settlement date of the reported position.
short_interest: int | None
Number of shares held short.
short_interest_percent: float | None
Short interest as a percent of the outstanding float.
days_to_cover_10d: float | None
Days to cover, against the ten-day average volume.
days_to_cover_30d: float | None
Days to cover, against the thirty-day average volume.
days_to_cover_90d: float | None
Days to cover, against the ninety-day average volume.