Company Filings
Implementation details
Class names
| Model name | Parameters class | Data class |
|---|---|---|
CompanyFilings | CompanyFilingsQueryParams | CompanyFilingsData |
Import Statement
from openbb_core.provider.standard_models.company_filings import (
CompanyFilingsData,
CompanyFilingsQueryParams,
)
Parameters
- standard
- fmp
- intrinio
- sec
- tmx
symbol: str
Symbol to get data for.
• Optional: True
symbol: str
Symbol to get data for.
• Optional: True
form_type: str
SEC form type to filter by.
• Optional: True
limit: int
Number of results to return.
• Default: 1000
• Optional: True
symbol: str
Symbol to get data for.
• Optional: True
form_type: str
SEC form type to filter by.
• Optional: True
start_date: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: True
limit: int
The number of data entries to return.
• Optional: True
thea_enabled: bool
Return filings that have been read by Intrinio's Thea NLP.
• Optional: True
symbol: str
Symbol to get data for.
• Optional: True
cik: Union[str, int]
Lookup filings by Central Index Key (CIK) instead of by symbol.
• Optional: True
start_date: Union[date, str]
Start date of the data, in YYYY-MM-DD format.
• Optional: True
end_date: Union[date, str]
End date of the data, in YYYY-MM-DD format.
• Optional: True
form_type: Union[str, list[str]]
SEC form type to filter by. Multiple items allowed for provider(s): sec.
Choices
11-A1-A_POS1-A-W1-E1-E_AD1-K1-SA1-U1-Z1-Z-W10-12B10-12G10-D10-K10-KT10-Q10-QT11-K11-KT13F-HR13F-NT13FCONP14415-12B15-12G15-15D15F-12B15F-12G15F-15D18-12B18-K19B-4E2-A2-AF2-E20-F20FR12B20FR12G24F-2NT2525-NSE253G1253G2253G3253G43305B234-12H440-17F140-17F240-17G40-17GCS40-202A40-203A40-206A40-24B240-3340-6B40-8B2540-8F-240-APP40-F40-OIP40FR12B40FR12G424A424B1424B2424B3424B4424B5424B7424B8424H425485APOS485BPOS485BXT486APOS486BPOS486BXT487497497AD497H2497J497K497VPI497VPU56-K6B_NTC6B_ORDR8-A12B8-A12G8-K8-K12B8-K12G38-K15D58-M8F-2_NTC8F-2_ORDR9-MABS-15GABS-EEADN-MTLADV-EADV-H-CADV-H-TADV-NRANNLRPTAPP_NTCAPP_ORDRAPP_WDAPP_WDGARSATS-NATS-N-CATS-N/UAAWAW_WDCC-ARC-AR-WC-TRC-TR-WC-UC-U-WC-WCBCERTCERTARCACERTBATSCERTCBOCERTNASCERTNYSCERTPACCFPORTALCFPORTAL-WCORRESPCT_ORDERDDEF_14ADEF_14CDEFA14ADEFA14CDEFC14ADEFC14CDEFM14ADEFM14CDEFN14ADEFR14ADEFR14CDEL_AMDFAN14ADFRN14ADOSDOSLTRDRSDRSLTRDSTRBRPTEFFECTF-1F-10F-10EFF-10POSF-1MEFF-3F-3ASRF-3DF-3DPOSF-3MEFF-4F-4_POSF-4MEFF-6F-6_POSF-6EFF-7F-7_POSF-8F-8_POSF-80F-80POSF-9F-9_POSF-NF-XFOCUSNFWPG-405G-405NG-FING-FINWIRANNOTICEMAMA-AMA-IMA-WMSDMSDCOMSDWN-1N-14N-14_8CN-14MEFN-18F1N-1AN-2N-2_POSASRN-23C-2N-23C3AN-23C3BN-23C3CN-2ASRN-2MEFN-30B-2N-30DN-4N-5N-54AN-54CN-6N-6FN-8AN-8B-2N-8FN-8F_NTCN-8F_ORDRN-CENN-CRN-CSRN-CSRSN-MFPN-MFP1N-MFP2N-PXN-QN-VPN-VPFSNO_ACTNPORT-EXNPORT-NPNPORT-PNRSRO-CENRSRO-UPDNSAR-ANSAR-ATNSAR-BNSAR-BTNSAR-UNT_10-DNT_10-KNT_10-QNT_11-KNT_20-FNT_N-CENNT_N-MFPNT_N-MFP1NT_N-MFP2NT_NPORT-EXNT_NPORT-PNT-NCENNT-NCSRNT-NSARNTFNCENNTFNCSRNTFNSARNTN_10DNTN_10KNTN_10QNTN_20FOIP_NTCOIP_ORDRPOS_8CPOS_AMPOS_AMIPOS_EXPOS462BPOS462CPOSASRPRE_14APRE_14CPREC14APREC14CPREM14APREM14CPREN14APRER14APRER14CPRRN14APX14A6GPX14A6NQRTLYRPTQUALIFREG-NRREVOKEDRWRW_WDS-1S-11S-11MEFS-1MEFS-20S-3S-3ASRS-3DS-3DPOSS-3MEFS-4S-4_POSS-4EFS-4MEFS-6S-8S-8_POSS-BS-BMEFSBSESBSE-ASBSE-BDSBSE-CSBSE-WSC_13DSC_13E1SC_13E3SC_13GSC_14D9SC_14F1SC_14NSC_TO-CSC_TO-ISC_TO-TSC13E4FSC14D1FSC14D9CSC14D9FSDSDRSESEC_ACTIONSEC_STAFF_ACTIONSEC_STAFF_LETTERSF-1SF-3SLSP_15D2STOP_ORDERSUPPLT-3TA-1TA-2TA-WTACOTHTTWUNDERUPLOADWDL-REQX-17A-5
• Optional: True
limit: int
The number of data entries to return.
• Optional: True
use_cache: bool
Whether or not to use cache. If True, cache will store for one day.
• Default: True
• Optional: True
symbol: str
Symbol to get data for.
• Optional: True
start_date: Union[date, str]
The start date to fetch.
• Optional: True
end_date: Union[date, str]
The end date to fetch.
• Optional: True
Data
- standard
- fmp
- intrinio
- sec
- tmx
filing_date: date
The date of the filing.
report_type: str
Type of filing.
report_url: str
URL to the actual report.
filing_date: date
The date of the filing.
report_type: str
Type of filing.
report_url: str
URL to the actual report.
filing_url: str
URL to the filing page.
symbol: str
Symbol representing the entity requested in the data.
cik: str
Central Index Key (CIK) for the requested entity.
accepted_date: datetime
Accepted date of the filing.
filing_date: date
The date of the filing.
report_type: str
Type of filing.
report_url: str
URL to the actual report.
id: str
Intrinio ID of the filing.
period_end_date: date
Ending date of the fiscal period for the filing.
accepted_date: datetime
Accepted date of the filing.
sec_unique_id: str
SEC unique ID of the filing.
filing_url: str
URL to the filing page.
instance_url: str
URL for the XBRL filing for the report.
industry_group: str
Industry group of the company.
industry_category: str
Industry category of the company.
word_count: int
Number of words in the filing, if available.
filing_date: date
The date of the filing.
report_type: str
Type of filing.
report_url: str
URL to the actual report.
report_date: date
The date of the filing.
act: Union[str, int]
The SEC Act number.
items: Union[str, float]
The SEC Item numbers.
primary_doc_description: str
The description of the primary document.
primary_doc: str
The filename of the primary document.
accession_number: Union[str, int]
The accession number.
file_number: Union[str, int]
The file number.
film_number: Union[str, int]
The film number.
is_inline_xbrl: Union[str, int]
Whether the filing is an inline XBRL filing.
is_xbrl: Union[str, int]
Whether the filing is an XBRL filing.
size: Union[str, int]
The size of the filing.
complete_submission_url: str
The URL to the complete filing submission.
filing_detail_url: str
The URL to the filing details.
filing_date: date
The date of the filing.
report_type: str
Type of filing.
report_url: str
URL to the actual report.
description: str
The description of the filing.
size: str
The file size of the PDF document.