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
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 | |
limit | int | Limit the number of reports to parse, from most recent. Approximately 24 reports per year, going back to 2009. | 24 | True |
skip_reports | int | Skip N number of reports from current. A value of 1 will skip the most recent report. | 0 | 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. | True | True |
Data
- standard
- sec
Name | Type | Description |
---|---|---|
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. |
Name | Type | Description |
---|---|---|
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. |