Equity FTD
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
EquityFTD | EquityFTDQueryParams | EquityFTDData |
Import Statement
from openbb_core.provider.standard_models. import (
EquityFTDData,
EquityFTDQueryParams,
)
Parameters
- standard
- sec
symbol: str
Symbol to get data for.
• Optional: False
symbol: str
Symbol to get data for.
• Optional: False
limit: int
Description
Limit the number of reports to parse, from most recent.
Approximately 24 reports per year, going back to 2009.
• Default: 24
• Optional: True
skip_reports: int
Skip N number of reports from current. A value of 1 will skip the most recent report.
• Default: 0
• Optional: True
use_cache: bool
Whether or not to use cache for the request, default is True. Each reporting period is a separate URL, new reports will be added to the cache.
• Default: True
• Optional: True
Data
- standard
- sec
settlement_date: date
The settlement date of the fail.
symbol: str
Symbol representing the entity requested in the data.
cusip: str
CUSIP of the Security.
quantity: int
The number of fails on that settlement date.
price: float
The price at the previous closing price from the settlement date.
description: str
The description of the Security.
settlement_date: date
The settlement date of the fail.
symbol: str
Symbol representing the entity requested in the data.
cusip: str
CUSIP of the Security.
quantity: int
The number of fails on that settlement date.
price: float
The price at the previous closing price from the settlement date.
description: str
The description of the Security.