diff options
author | Danglewood <85772166+deeleeramone@users.noreply.github.com> | 2024-05-17 18:24:08 -0700 |
---|---|---|
committer | Danglewood <85772166+deeleeramone@users.noreply.github.com> | 2024-05-17 18:24:08 -0700 |
commit | 68d43cceaf3fde7f8cb2a026919a8406db41322b (patch) | |
tree | df8ff693095b66ebde04122dd32fe1637e07481a | |
parent | d7c73f3d827657f5d737008498254124b7e65458 (diff) |
sec form types with spaces
3 files changed, 68 insertions, 68 deletions
diff --git a/openbb_platform/openbb/assets/reference.json b/openbb_platform/openbb/assets/reference.json index b5b7e6b4529..80ae29f6fd9 100644 --- a/openbb_platform/openbb/assets/reference.json +++ b/openbb_platform/openbb/assets/reference.json @@ -18380,7 +18380,7 @@ }, { "name": "form_type", - "type": "Literal['1', '1-A', '1-A POS', '1-A-W', '1-E', '1-E AD', '1-K', '1-SA', '1-U', '1-Z', '1-Z-W', '10-12B', '10-12G', '10-D', '10-K', '10-KT', '10-Q', '10-QT', '11-K', '11-KT', '13F-HR', '13F-NT', '13FCONP', '144', '15-12B', '15-12G', '15-15D', '15F-12B', '15F-12G', '15F-15D', '18-12B', '18-K', '19B-4E', '2-A', '2-AF', '2-E', '20-F', '20FR12B', '20FR12G', '24F-2NT', '25', '25-NSE', '253G1', '253G2', '253G3', '253G4', '3', '305B2', '34-12H', '4', '40-17F1', '40-17F2', '40-17G', '40-17GCS', '40-202A', '40-203A', '40-206A', '40-24B2', '40-33', '40-6B', '40-8B25', '40-8F-2', '40-APP', '40-F', '40-OIP', '40FR12B', '40FR12G', '424A', '424B1', '424B2', '424B3', '424B4', '424B5', '424B7', '424B8', '424H', '425', '485APOS', '485BPOS', '485BXT', '486APOS', '486BPOS', '486BXT', '487', '497', '497AD', '497H2', '497J', '497K', '497VPI', '497VPU', '5', '6-K', '6B NTC', '6B ORDR', '8-A12B', '8-A12G', '8-K', '8-K12B', '8-K12G3', '8-K15D5', '8-M', '8F-2 NTC', '8F-2 ORDR', '9-M', 'ABS-15G', 'ABS-EE', 'ADN-MTL', 'ADV-E', 'ADV-H-C', 'ADV-H-T', 'ADV-NR', 'ANNLRPT', 'APP NTC', 'APP ORDR', 'APP WD', 'APP WDG', 'ARS', 'ATS-N', 'ATS-N-C', 'ATS-N/UA', 'AW', 'AW WD', 'C', 'C-AR', 'C-AR-W', 'C-TR', 'C-TR-W', 'C-U', 'C-U-W', 'C-W', 'CB', 'CERT', 'CERTARCA', 'CERTBATS', 'CERTCBO', 'CERTNAS', 'CERTNYS', 'CERTPAC', 'CFPORTAL', 'CFPORTAL-W', 'CORRESP', 'CT ORDER', 'D', 'DEF 14A', 'DEF 14C', 'DEFA14A', 'DEFA14C', 'DEFC14A', 'DEFC14C', 'DEFM14A', 'DEFM14C', 'DEFN14A', 'DEFR14A', 'DEFR14C', 'DEL AM', 'DFAN14A', 'DFRN14A', 'DOS', 'DOSLTR', 'DRS', 'DRSLTR', 'DSTRBRPT', 'EFFECT', 'F-1', 'F-10', 'F-10EF', 'F-10POS', 'F-1MEF', 'F-3', 'F-3ASR', 'F-3D', 'F-3DPOS', 'F-3MEF', 'F-4', 'F-4 POS', 'F-4MEF', 'F-6', 'F-6 POS', 'F-6EF', 'F-7', 'F-7 POS', 'F-8', 'F-8 POS', 'F-80', 'F-80POS', 'F-9', 'F-9 POS', 'F-N', 'F-X', 'FOCUSN', 'FWP', 'G-405', 'G-405N', 'G-FIN', 'G-FINW', 'IRANNOTICE', 'MA', 'MA-A', 'MA-I', 'MA-W', 'MSD', 'MSDCO', 'MSDW', 'N-1', 'N-14', 'N-14 8C', 'N-14MEF', 'N-18F1', 'N-1A', 'N-2', 'N-2 POSASR', 'N-23C-2', 'N-23C3A', 'N-23C3B', 'N-23C3C', 'N-2ASR', 'N-2MEF', 'N-30B-2', 'N-30D', 'N-4', 'N-5', 'N-54A', 'N-54C', 'N-6', 'N-6F', 'N-8A', 'N-8B-2', 'N-8F', 'N-8F NTC', 'N-8F ORDR', 'N-CEN', 'N-CR', 'N-CSR', 'N-CSRS', 'N-MFP', 'N-MFP1', 'N-MFP2', 'N-PX', 'N-Q', 'N-VP', 'N-VPFS', 'NO ACT', 'NPORT-EX', 'NPORT-NP', 'NPORT-P', 'NRSRO-CE', 'NRSRO-UPD', 'NSAR-A', 'NSAR-AT', 'NSAR-B', 'NSAR-BT', 'NSAR-U', 'NT 10-D', 'NT 10-K', 'NT 10-Q', 'NT 11-K', 'NT 20-F', 'NT N-CEN', 'NT N-MFP', 'NT N-MFP1', 'NT N-MFP2', 'NT NPORT-EX', 'NT NPORT-P', 'NT-NCEN', 'NT-NCSR', 'NT-NSAR', 'NTFNCEN', 'NTFNCSR', 'NTFNSAR', 'NTN 10D', 'NTN 10K', 'NTN 10Q', 'NTN 20F', 'OIP NTC', 'OIP ORDR', 'POS 8C', 'POS AM', 'POS AMI', 'POS EX', 'POS462B', 'POS462C', 'POSASR', 'PRE 14A', 'PRE 14C', 'PREC14A', 'PREC14C', 'PREM14A', 'PREM14C', 'PREN14A', 'PRER14A', 'PRER14C', 'PRRN14A', 'PX14A6G', 'PX14A6N', 'QRTLYRPT', 'QUALIF', 'REG-NR', 'REVOKED', 'RW', 'RW WD', 'S-1', 'S-11', 'S-11MEF', 'S-1MEF', 'S-20', 'S-3', 'S-3ASR', 'S-3D', 'S-3DPOS', 'S-3MEF', 'S-4', 'S-4 POS', 'S-4EF', 'S-4MEF', 'S-6', 'S-8', 'S-8 POS', 'S-B', 'S-BMEF', 'SBSE', 'SBSE-A', 'SBSE-BD', 'SBSE-C', 'SBSE-W', 'SC 13D', 'SC 13E1', 'SC 13E3', 'SC 13G', 'SC 14D9', 'SC 14F1', 'SC 14N', 'SC TO-C', 'SC TO-I', 'SC TO-T', 'SC13E4F', 'SC14D1F', 'SC14D9C', 'SC14D9F', 'SD', 'SDR', 'SE', 'SEC ACTION', 'SEC STAFF ACTION', 'SEC STAFF LETTER', 'SF-1', 'SF-3', 'SL', 'SP 15D2', 'STOP ORDER', 'SUPPL', 'T-3', 'TA-1', 'TA-2', 'TA-W', 'TACO', 'TH', 'TTW', 'UNDER', 'UPLOAD', 'WDL-REQ', 'X-17A-5']", + "type": "Literal['1', '1-A', '1-A_POS', '1-A-W', '1-E', '1-E_AD', '1-K', '1-SA', '1-U', '1-Z', '1-Z-W', '10-12B', '10-12G', '10-D', '10-K', '10-KT', '10-Q', '10-QT', '11-K', '11-KT', '13F-HR', '13F-NT', '13FCONP', '144', '15-12B', '15-12G', '15-15D', '15F-12B', '15F-12G', '15F-15D', '18-12B', '18-K', '19B-4E', '2-A', '2-AF', '2-E', '20-F', '20FR12B', '20FR12G', '24F-2NT', '25', '25-NSE', '253G1', '253G2', '253G3', '253G4', '3', '305B2', '34-12H', '4', '40-17F1', '40-17F2', '40-17G', '40-17GCS', '40-202A', '40-203A', '40-206A', '40-24B2', '40-33', '40-6B', '40-8B25', '40-8F-2', '40-APP', '40-F', '40-OIP', '40FR12B', '40FR12G', '424A', '424B1', '424B2', '424B3', '424B4', '424B5', '424B7', '424B8', '424H', '425', '485APOS', '485BPOS', '485BXT', '486APOS', '486BPOS', '486BXT', '487', '497', '497AD', '497H2', '497J', '497K', '497VPI', '497VPU', '5', '6-K', '6B_NTC', '6B_ORDR', '8-A12B', '8-A12G', '8-K', '8-K12B', '8-K12G3', '8-K15D5', '8-M', '8F-2_NTC', '8F-2_ORDR', '9-M', 'ABS-15G', 'ABS-EE', 'ADN-MTL', 'ADV-E', 'ADV-H-C', 'ADV-H-T', 'ADV-NR', 'ANNLRPT', 'APP_NTC', 'APP_ORDR', 'APP_WD', 'APP_WDG', 'ARS', 'ATS-N', 'ATS-N-C', 'ATS-N/UA', 'AW', 'AW_WD', 'C', 'C-AR', 'C-AR-W', 'C-TR', 'C-TR-W', 'C-U', 'C-U-W', 'C-W', 'CB', 'CERT', 'CERTARCA', 'CERTBATS', 'CERTCBO', 'CERTNAS', 'CERTNYS', 'CERTPAC', 'CFPORTAL', 'CFPORTAL-W', 'CORRESP', 'CT ORDER', 'D', 'DEF_14A', 'DEF_14C', 'DEFA14A', 'DEFA14C', 'DEFC14A', 'DEFC14C', 'DEFM14A', 'DEFM14C', 'DEFN14A', 'DEFR14A', 'DEFR14C', 'DEL_AM', 'DFAN14A', 'DFRN14A', 'DOS', 'DOSLTR', 'DRS', 'DRSLTR', 'DSTRBRPT', 'EFFECT', 'F-1', 'F-10', 'F-10EF', 'F-10POS', 'F-1MEF', 'F-3', 'F-3ASR', 'F-3D', 'F-3DPOS', 'F-3MEF', 'F-4', 'F-4_POS', 'F-4MEF', 'F-6', 'F-6_POS', 'F-6EF', 'F-7', 'F-7_POS', 'F-8', 'F-8_POS', 'F-80', 'F-80POS', 'F-9', 'F-9_POS', 'F-N', 'F-X', 'FOCUSN', 'FWP', 'G-405', 'G-405N', 'G-FIN', 'G-FINW', 'IRANNOTICE', 'MA', 'MA-A', 'MA-I', 'MA-W', 'MSD', 'MSDCO', 'MSDW', 'N-1', 'N-14', 'N-14_8C', 'N-14MEF', 'N-18F1', 'N-1A', 'N-2', 'N-2_POSASR', 'N-23C-2', 'N-23C3A', 'N-23C3B', 'N-23C3C', 'N-2ASR', 'N-2MEF', 'N-30B-2', 'N-30D', 'N-4', 'N-5', 'N-54A', 'N-54C', 'N-6', 'N-6F', 'N-8A', 'N-8B-2', 'N-8F', 'N-8F_NTC', 'N-8F_ORDR', 'N-CEN', 'N-CR', 'N-CSR', 'N-CSRS', 'N-MFP', 'N-MFP1', 'N-MFP2', 'N-PX', 'N-Q', 'N-VP', 'N-VPFS', 'NO_ACT', 'NPORT-EX', 'NPORT-NP', 'NPORT-P', 'NRSRO-CE', 'NRSRO-UPD', 'NSAR-A', 'NSAR-AT', 'NSAR-B', 'NSAR-BT', 'NSAR-U', 'NT_10-D', 'NT_10-K', 'NT_10-Q', 'NT_11-K', 'NT_20-F', 'NT_N-CEN', 'NT_N-MFP', 'NT_N-MFP1', 'NT_N-MFP2', 'NT_NPORT-EX', 'NT_NPORT-P', 'NT-NCEN', 'NT-NCSR', 'NT-NSAR', 'NTFNCEN', 'NTFNCSR', 'NTFNSAR', 'NTN_10D', 'NTN_10K', 'NTN_10Q', 'NTN_20F', 'OIP_NTC', 'OIP_ORDR', 'POS_8C', 'POS_AM', 'POS_AMI', 'POS_EX', 'POS462B', 'POS462C', 'POSASR', 'PRE_14A', 'PRE_14C', 'PREC14A', 'PREC14C', 'PREM14A', 'PREM14C', 'PREN14A', 'PRER14A', 'PRER14C', 'PRRN14A', 'PX14A6G', 'PX14A6N', 'QRTLYRPT', 'QUALIF', 'REG-NR', 'REVOKED', 'RW', 'RW_WD', 'S-1', 'S-11', 'S-11MEF', 'S-1MEF', 'S-20', 'S-3', 'S-3ASR', 'S-3D', 'S-3DPOS', 'S-3MEF', 'S-4', 'S-4_POS', 'S-4EF', 'S-4MEF', 'S-6', 'S-8', 'S-8_POS', 'S-B', 'S-BMEF', 'SBSE', 'SBSE-A', 'SBSE-BD', 'SBSE-C', 'SBSE-W', 'SC_13D', 'SC_13E1', 'SC_13E3', 'SC_13G', 'SC_14D9', 'SC_14F1', 'SC_14N', 'SC_TO-C', 'SC_TO-I', 'SC_TO-T', 'SC13E4F', 'SC14D1F', 'SC14D9C', 'SC14D9F', 'SD', 'SDR', 'SE', 'SEC_ACTION', 'SEC_STAFF_ACTION', 'SEC_STAFF_LETTER', 'SF-1', 'SF-3', 'SL', 'SP_15D2', 'STOP_ORDER', 'SUPPL', 'T-3', 'TA-1', 'TA-2', 'TA-W', 'TACO', 'TH', 'TTW', 'UNDER', 'UPLOAD', 'WDL-REQ', 'X-17A-5']", "description": "Type of the SEC filing form.", "default": null, "optional": true, diff --git a/openbb_platform/providers/sec/openbb_sec/models/company_filings.py b/openbb_platform/providers/sec/openbb_sec/models/company_filings.py index e210a5a0c72..9a8b4b8f090 100644 --- a/openbb_platform/providers/sec/openbb_sec/models/company_filings.py +++ b/openbb_platform/providers/sec/openbb_sec/models/company_filings.py @@ -39,7 +39,7 @@ class SecCompanyFilingsQueryParams(CompanyFilingsQueryParams): description="Lookup filings by Central Index Key (CIK) instead of by symbol.", default=None, ) - form_type: Union[None, FORM_TYPES] = Field( + form_type: Optional[FORM_TYPES] = Field( description="Type of the SEC filing form.", default=None, ) @@ -276,7 +276,7 @@ class SecCompanyFilingsFetcher( base_url + filings["accessionNumber"] + "-index.htm" ) if query.form_type: - filings = filings[filings["form"] == query.form_type] + filings = filings[filings["form"] == query.form_type.replace("_", " ")] if query.limit: filings = filings.head(query.limit) if query.limit != 0 else filings diff --git a/openbb_platform/providers/sec/openbb_sec/utils/definitions.py b/openbb_platform/providers/sec/openbb_sec/utils/definitions.py index 8a36a5a4c77..b790b7b5770 100644 --- a/openbb_platform/providers/sec/openbb_sec/utils/definitions.py +++ b/openbb_platform/providers/sec/openbb_sec/utils/definitions.py @@ -21,10 +21,10 @@ HEADERS: Dict[str, str] = { FORM_TYPES = Literal[ "1", "1-A", - "1-A POS", + "1-A_POS", "1-A-W", "1-E", - "1-E AD", + "1-E_AD", "1-K", "1-SA", "1-U", @@ -112,8 +112,8 @@ FORM_TYPES = Literal[ "497VPU", "5", "6-K", - "6B NTC", - "6B ORDR", + "6B_NTC", + "6B_ORDR", "8-A12B", "8-A12G", "8-K", @@ -121,8 +121,8 @@ FORM_TYPES = Literal[ "8-K12G3", "8-K15D5", "8-M", - "8F-2 NTC", - "8F-2 ORDR", + "8F-2_NTC", + "8F-2_ORDR", "9-M", "ABS-15G", "ABS-EE", @@ -132,16 +132,16 @@ FORM_TYPES = Literal[ "ADV-H-T", "ADV-NR", "ANNLRPT", - "APP NTC", - "APP ORDR", - "APP WD", - "APP WDG", + "APP_NTC", + "APP_ORDR", + "APP_WD", + "APP_WDG", "ARS", "ATS-N", "ATS-N-C", "ATS-N/UA", "AW", - "AW WD", + "AW_WD", "C", "C-AR", "C-AR-W", @@ -163,8 +163,8 @@ FORM_TYPES = Literal[ "CORRESP", "CT ORDER", "D", - "DEF 14A", - "DEF 14C", + "DEF_14A", + "DEF_14C", "DEFA14A", "DEFA14C", "DEFC14A", @@ -174,7 +174,7 @@ FORM_TYPES = Literal[ "DEFN14A", "DEFR14A", "DEFR14C", - "DEL AM", + "DEL_AM", "DFAN14A", "DFRN14A", "DOS", @@ -194,19 +194,19 @@ FORM_TYPES = Literal[ "F-3DPOS", "F-3MEF", "F-4", - "F-4 POS", + "F-4_POS", "F-4MEF", "F-6", - "F-6 POS", + "F-6_POS", "F-6EF", "F-7", - "F-7 POS", + "F-7_POS", "F-8", - "F-8 POS", + "F-8_POS", "F-80", "F-80POS", "F-9", - "F-9 POS", + "F-9_POS", "F-N", "F-X", "FOCUSN", @@ -225,12 +225,12 @@ FORM_TYPES = Literal[ "MSDW", "N-1", "N-14", - "N-14 8C", + "N-14_8C", "N-14MEF", "N-18F1", "N-1A", "N-2", - "N-2 POSASR", + "N-2_POSASR", "N-23C-2", "N-23C3A", "N-23C3B", @@ -248,8 +248,8 @@ FORM_TYPES = Literal[ "N-8A", "N-8B-2", "N-8F", - "N-8F NTC", - "N-8F ORDR", + "N-8F_NTC", + "N-8F_ORDR", "N-CEN", "N-CR", "N-CSR", @@ -261,7 +261,7 @@ FORM_TYPES = Literal[ "N-Q", "N-VP", "N-VPFS", - "NO ACT", + "NO_ACT", "NPORT-EX", "NPORT-NP", "NPORT-P", @@ -272,38 +272,38 @@ FORM_TYPES = Literal[ "NSAR-B", "NSAR-BT", "NSAR-U", - "NT 10-D", - "NT 10-K", - "NT 10-Q", - "NT 11-K", - "NT 20-F", - "NT N-CEN", - "NT N-MFP", - "NT N-MFP1", - "NT N-MFP2", - "NT NPORT-EX", - "NT NPORT-P", + "NT_10-D", + "NT_10-K", + "NT_10-Q", + "NT_11-K", + "NT_20-F", + "NT_N-CEN", + "NT_N-MFP", + "NT_N-MFP1", + "NT_N-MFP2", + "NT_NPORT-EX", + "NT_NPORT-P", "NT-NCEN", "NT-NCSR", "NT-NSAR", "NTFNCEN", "NTFNCSR", "NTFNSAR", - "NTN 10D", - "NTN 10K", - "NTN 10Q", - "NTN 20F", - "OIP NTC", - "OIP ORDR", - "POS 8C", - "POS AM", - "POS AMI", - "POS EX", + "NTN_10D", + "NTN_10K", + "NTN_10Q", + "NTN_20F", + "OIP_NTC", + "OIP_ORDR", + "POS_8C", + "POS_AM", + "POS_AMI", + "POS_EX", "POS462B", "POS462C", "POSASR", - "PRE 14A", - "PRE 14C", + "PRE_14A", + "PRE_14C", "PREC14A", "PREC14C", "PREM14A", @@ -319,7 +319,7 @@ FORM_TYPES = Literal[ "REG-NR", "REVOKED", "RW", - "RW WD", + "RW_WD", "S-1", "S-11", "S-11MEF", @@ -331,12 +331,12 @@ FORM_TYPES = Literal[ "S-3DPOS", "S-3MEF", "S-4", - "S-4 POS", + "S-4_POS", "S-4EF", "S-4MEF", "S-6", "S-8", - "S-8 POS", + "S-8_POS", "S-B", "S-BMEF", "SBSE", @@ -344,16 +344,16 @@ FORM_TYPES = Literal[ "SBSE-BD", "SBSE-C", "SBSE-W", - "SC 13D", - "SC 13E1", - "SC 13E3", - "SC 13G", - "SC 14D9", - "SC 14F1", - "SC 14N", - "SC TO-C", - "SC TO-I", - "SC TO-T", + "SC_13D", + "SC_13E1", + "SC_13E3", + "SC_13G", + "SC_14D9", + "SC_14F1", + "SC_14N", + "SC_TO-C", + "SC_TO-I", + "SC_TO-T", "SC13E4F", "SC14D1F", "SC14D9C", @@ -361,14 +361,14 @@ FORM_TYPES = Literal[ "SD", "SDR", "SE", - "SEC ACTION", - "SEC STAFF ACTION", - "SEC STAFF LETTER", + "SEC_ACTION", + "SEC_STAFF_ACTION", + "SEC_STAFF_LETTER", "SF-1", "SF-3", "SL", - "SP 15D2", - "STOP ORDER", + "SP_15D2", + "STOP_ORDER", "SUPPL", "T-3", "TA-1", |