Discovery Filings
Implementation details
Class names
Model name | Parameters class | Data class |
---|---|---|
DiscoveryFilings | DiscoveryFilingsQueryParams | DiscoveryFilingsData |
Import Statement
from openbb_core.provider.standard_models.discovery_filings import (
DiscoveryFilingsData,
DiscoveryFilingsQueryParams,
)
Parameters
- standard
- fmp
Name | Type | Description | Default | Optional |
---|---|---|---|---|
start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True |
end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. | None | True |
form_type | str | Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types. | None | True |
limit | int | The number of data entries to return. | 100 | True |
Name | Type | Description | Default | Optional |
---|---|---|---|---|
start_date | Union[date, str] | Start date of the data, in YYYY-MM-DD format. | None | True |
end_date | Union[date, str] | End date of the data, in YYYY-MM-DD format. | None | True |
form_type | str | Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types. | None | True |
limit | int | The number of data entries to return. | 100 | True |
is_done | bool | Flag for whether or not the filing is done. | None | True |
Data
- standard
- fmp
Name | Type | Description |
---|---|---|
symbol | str | Symbol representing the entity requested in the data. |
cik | str | Central Index Key (CIK) for the requested entity. |
title | str | Title of the filing. |
date | Union[datetime, str] | The date of the data. |
form_type | str | The form type of the filing |
link | str | URL to the filing page on the SEC site. |
Name | Type | Description |
---|---|---|
symbol | str | Symbol representing the entity requested in the data. |
cik | str | Central Index Key (CIK) for the requested entity. |
title | str | Title of the filing. |
date | Union[datetime, str] | The date of the data. |
form_type | str | The form type of the filing |
link | str | URL to the filing page on the SEC site. |