### Install sec-api Package Source: https://github.com/sec-api-io/sec-api-node/blob/master/README.md Install the sec-api package using npm. This is the first step to using the library. ```bash npm install sec-api ``` -------------------------------- ### Example Response for 13F Cover Pages Source: https://github.com/sec-api-io/sec-api-node/blob/master/README.md This JSON structure represents an example response for a 13F Cover Pages query, detailing filing information and manager details. ```json { "total": { "value": 13, "relation": "eq" }, "data": [ { "id": "1ef1c3fa0b53c72620f026f0ab47e7c6", "accessionNo": "0001350694-26-000001", "filedAt": "2026-02-13T16:03:50-05:00", "formType": "13F-HR", "cik": "1350694", "crdNumber": "105129", "secFileNumber": "801-35875", "form13FFileNumber": "028-11794", "periodOfReport": "2025-12-31", "isAmendment": false, "amendmentInfo": {}, "filingManager": { "name": "Bridgewater Associates, LP", "address": { "street": "One Nyala Farms Road", "city": "Westport", "stateOrCountry": "CT", "zipCode": 6880 } }, "reportType": "13F HOLDINGS REPORT", "otherManagersReportingForThisManager": [], "provideInfoForInstruction5": false, "signature": { "name": "Michael Kitson", "title": "Chief Compliance Officer and Counsel", "phone": "203-226-3030", "signature": "/s/Michael Kitson", "city": "Westport", "stateOrCountry": "CT", "signatureDate": "02-13-2026" }, "tableEntryTotal": 1040, "tableEntryTotalAsReported": 1040, "tableValueTotal": 27421613830, "tableValueTotalAsReported": 27421613830, "otherIncludedManagersCount": 0, "otherIncludedManagers": [] } ] } ``` -------------------------------- ### Example Response for 13F Holdings Source: https://github.com/sec-api-io/sec-api-node/blob/master/README.md This is an example of the JSON response structure for a 13F Holdings query, showing total results and a sample of the data array. ```json { "total": { "value": 209, "relation": "eq" }, "data": [ { "id": "289428b455d4eb55f298d84f544d3d61", "accessionNo": "0001193125-26-054580", "cik": "1067983", "ticker": "BRK.B", "companyName": "BERKSHIRE HATHAWAY INC", "companyNameLong": "BERKSHIRE HATHAWAY INC (Filer)", "formType": "13F-HR", "description": "Form 13F-HR - Quarterly report filed by institutional managers, Holdings", "filedAt": "2026-02-17T16:05:04-05:00", "linkToTxt": "https://www.sec.gov/Archives/edgar/data/1067983/000119312526054580/0001193125-26-054580.txt", "linkToHtml": "https://www.sec.gov/Archives/edgar/data/1067983/000119312526054580/0001193125-26-054580-index.htm", "linkToXbrl": "", "linkToFilingDetails": "https://www.sec.gov/Archives/edgar/data/1067983/000119312526054580/xslForm13F_X02/primary_doc.xml", "entities": [ { "companyName": "BERKSHIRE HATHAWAY INC (Filer)", "cik": "1067983", "irsNo": "470813844", "stateOfIncorporation": "DE", "fiscalYearEnd": "1231", "type": "13F-HR", "act": "34", "fileNo": "028-04545", "filmNo": "26640865", "sic": "6331 Fire, Marine & Casualty Insurance", "undefined": "02 Finance)" } ], "documentFormatFiles": [ { "sequence": "1", "documentUrl": "https://www.sec.gov/Archives/edgar/data/1067983/000119312526054580/xslForm13F_X02/primary_doc.xml", "type": "13F-HR", "size": " " } // ... more files ], "dataFiles": [], "seriesAndClassesContractsInformation": [], "periodOfReport": "2025-12-31", "effectivenessDate": "2026-02-17", "holdings": [ { "nameOfIssuer": "ALLY FINL INC", "cusip": "02005N100", "titleOfClass": "COM", "value": 576074081, "shrsOrPrnAmt": { "sshPrnamt": 12719675, "sshPrnamtType": "SH" }, "investmentDiscretion": "DFND", "votingAuthority": { "Sole": 12719675, "Shared": 0, "None": 0 }, "otherManager": "4", "ticker": "ALLY", "cik": "40729" } // ... more holdings ] } ] } ``` -------------------------------- ### Example N-PX Filing Metadata Response Source: https://github.com/sec-api-io/sec-api-node/blob/master/README.md This is an example JSON response structure for the N-PX filing metadata search, showing total results and a list of filings. ```json { "total": { "value": 2, "relation": "eq" }, "data": [ { "id": "723cc6d725f186bd4436136332d7fc98", "accessionNo": "0001021408-25-003152", "formType": "N-PX", "filedAt": "2025-08-25T14:01:44-04:00", "periodOfReport": "2025-06-30", "cik": "884546", "ticker": "", "companyName": "CHARLES SCHWAB INVESTMENT MANAGEMENT INC", "proxyVotingRecordsAttached": true, "headerData": { "submissionType": "N-PX", "filerInfo": { "registrantType": "IM", "filer": { "issuerCredentials": { "cik": "0000884546" } }, "flags": { "overrideInternetFlag": false, "confirmingCopyFlag": false }, "periodOfReport": "06/30/2025" } }, "formData": { "coverPage": { "yearOrQuarter": "YEAR", "reportCalendarYear": "2025", "reportingPerson": { "name": "Charles Schwab Investment Management Inc", "phoneNumber": "4156677000", "address": { "street1": "211 Main Street", "city": "San Francisco", "stateOrCountry": "CA", "zipCode": "94105" } }, "agentForService": {}, "reportInfo": { "reportType": "INSTITUTIONAL MANAGER VOTING REPORT", "confidentialTreatment": false }, "fileNumber": "028-03128", "explanatoryInformation": { "explanatoryChoice": false } }, "summaryPage": { "otherIncludedManagersCount": 0 }, "signaturePage": { "reportingPerson": "Charles Schwab Investment Management Inc", "txSignature": "Omar Aguilar", "txPrintedSignature": "Omar Aguilar", "txTitle": "Chief Executive Officer", "txAsOfDate": "08/20/2025" } } } ] } ``` -------------------------------- ### 8-K Filing Response Example (Item 2.02) Source: https://github.com/sec-api-io/sec-api-node/blob/master/README.md This JSON shows an example response for an 8-K filing, specifically highlighting Item 2.02. It includes details like accession number, CIK, company name, and links to HTML, filing details, and text versions of the filing. ```json { "total": { "value": 10000, "relation": "gte" }, "query": { "from": 0, "size": 1 }, "filings": [ { "id": "74c44f9aefc62f7788ffdccf30596225", "ticker": "FFAI", "formType": "8-K", "accessionNo": "0001213900-26-037931", "cik": "1805521", "companyNameLong": "FARADAY FUTURE INTELLIGENT ELECTRIC INC. (Filer)", "companyName": "FARADAY FUTURE INTELLIGENT ELECTRIC INC.", "description": "Form 8-K - Current report - Item 2.02 Item 8.01 Item 9.01", "filedAt": "2026-04-01T06:11:36-04:00", "periodOfReport": "2026-03-31", "linkToHtml": "https://www.sec.gov/Archives/edgar/data/1805521/000121390026037931/0001213900-26-037931-index.htm", "linkToFilingDetails": "https://www.sec.gov/Archives/edgar/data/1805521/000121390026037931/ea0284262-8k_faraday.htm", "linkToTxt": "https://www.sec.gov/Archives/edgar/data/1805521/000121390026037931/0001213900-26-037931.txt", "entities": [ { "fiscalYearEnd": "1231", "stateOfIncorporation": "DE", "act": "34", "cik": "1805521", "fileNo": "001-39395", "irsNo": "844720320", "companyName": "FARADAY FUTURE INTELLIGENT ELECTRIC INC. (Filer)", "type": "8-K", "sic": "3711 Motor Vehicles & Passenger Car Bodies" } ], "documentFormatFiles": [ { "sequence": "1", "size": "31779", "documentUrl": "https://www.sec.gov/ix?doc=/Archives/edgar/data/1805521/000121390026037931/ea0284262-8k_faraday.htm", "description": "CURRENT REPORT", "type": "8-K" }, { "sequence": "2", "size": "137883", "documentUrl": "https://www.sec.gov/Archives/edgar/data/1805521/000121390026037931/ea028426201ex99-1.htm", "description": "PRESS RELEASE", "type": "EX-99.1" } // ... more files ], "dataFiles": [] } ] } ``` -------------------------------- ### Example Form N-PORT API Response Source: https://github.com/sec-api-io/sec-api-node/blob/master/README.md This is an example of the JSON response structure when querying Form N-PORT data. It includes total filings count and details for each filing. ```json { "total": { "value": 10000, "relation": "gte" }, "filings": [ { "submissionType": "NPORT-P", "filerInfo": { "filer": { "issuerCredentials": { "cik": "0001552947", "ccc": "XXXXXXXX" } }, "seriesClassInfo": { "seriesId": "S000075330", "classId": ["C000234270", "C000234271", "C000234272"] } }, "genInfo": { "regName": "Two Roads Shared Trust", "regFileNumber": "811-22718", "regCik": "0001552947", "regLei": "549300REHU8QC2CK4V30", "regStreet1": "225 PICTORIA DRIVE", "regStreet2": "SUITE 450", "regCity": "CINCINNATI", "regStateConditional": { "regCountry": "US", "regState": "US-OH" }, "regZipOrPostalCode": "45246", "regPhone": "402-895-1600", "seriesName": "Holbrook Structured Credit Income Fund", "seriesId": "S000075330", "seriesLei": "549300VN9LSTDZVMEG10", "repPdEnd": "2026-04-30", "repPdDate": "2026-01-31", "isFinalFiling": "N" }, "fundInfo": { "totAssets": 589656494.57, "totLiabs": 26303874.88, "netAssets": 563352619.69, "assetsAttrMiscSec": 0, "assetsInvested": 0, "amtPayOneYrBanksBorr": 0, "amtPayOneYrCtrldComp": 0, "amtPayOneYrOthAffil": 0, "amtPayOneYrOther": 0, "amtPayAftOneYrBanksBorr": 0, "amtPayAftOneYrCtrldComp": 0, "amtPayAftOneYrOthAffil": 0, "amtPayAftOneYrOther": 0, "delayDeliv": 0, "standByCommit": 0, "liquidPref": 0, "cshNotRptdInCorD": 0, "curMetrics": { "curMetric": [ { "curCd": "USD", "intrstRtRiskdv01": { "period10Yr": 16013.864121, "period1Yr": 11247.59154, "period30Yr": 4288.904006, "period3Mon": 797.324692, "period5Yr": 73979.610662 }, "intrstRtRiskdv100": { "period10Yr": 1606509.028942, "period1Yr": 1101438.779831, "period30Yr": 435795.28333, "period3Mon": 82265.418559, "period5Yr": 7395155.726345 } } ] }, "creditSprdRiskInvstGrade": { "period10Yr": 19059.318464, "period1Yr": 10289.915308, "period30Yr": 4867.597881, "period3Mon": 130.272532, "period5Yr": 73099.636591 }, "creditSprdRiskNonInvstGrade": { "period10Yr": 1101.107886, "period1Yr": 11563.009059, "period30Yr": 815.163831, "period3Mon": 17920.825732, "period5Yr": 6039.88695 }, "isNonCashCollateral": "N", "returnInfo": { "monthlyTotReturns": { "monthlyTotReturn": [ { "classId": "C000234270", "rtn1": 0.47, "rtn2": 0.51, "rtn3": 0.55 } // ... more items ] }, "othMon1": { "netRealizedGain": 7903.87, "netUnrealizedAppr": 41040.49 }, "othMon2": { "netRealizedGain": 351039.84, "netUnrealizedAppr": -303753.72 }, "othMon3": { "netRealizedGain": 13348.82, "netUnrealizedAppr": 370504.63 } }, "mon1Flow": { "redemption": 20566862.72, "reinvestment": 2200048.38, "sales": 29009934.75 }, "mon2Flow": { "redemption": 28416519.67, "reinvestment": 2121607.35, "sales": 45362488.84 }, "mon3Flow": { "redemption": 15947059.37, "reinvestment": 2848443.49, "sales": 35033302.63 } }, "invstOrSecs": [ { "name": "A&D MORTGAGE TRUST 2023-NQM2", "lei": "N/A", "title": "ADMT 2023-NQM2 A1", "cusip": "00002DAA7", "identifiers": { "isin": { "value": "US00002DAA72" } }, "balance": 1287717.11, "units": "PA", "curCd": "USD", "valUSD": 1289380.97, "pctVal": 0.228876360015, "payoffProfile": "Long", "assetCat": "ABS-O", "issuerCat": "CORP", "invCountry": "US", "isRestrictedSec": "Y", "fairValLevel": "2", "debtSec": { "maturityDt": "2068-05-25", "couponKind": "Floating", "annualizedRt": 6.131999, "isDefault": "N", "areIntrstPmntsInArrs": "N", "isPaidKind": "N" }, "securityLending": { "isCashCollateral": "N", "isNonCashCollateral": "N", "isLoanByFund": "N" } } // ... more items ] } ] } ``` -------------------------------- ### Get Form D Filings with Minimum Offering Amount Source: https://github.com/sec-api-io/sec-api-node/blob/master/README.md Retrieve Form D filings where the total offering amount is at least $1,000,000. Sort results by filing date in descending order. Requires API key setup. ```javascript const { formDApi } = require('sec-api'); formDApi.setApiKey('YOUR_API_KEY'); const data = await formDApi.getData({ query: 'offeringData.offeringSalesAmounts.totalOfferingAmount:[1000000 TO *]', from: '0', size: '50', sort: [{ filedAt: { order: 'desc' } }], }); // response: { total, offerings } ``` -------------------------------- ### Example Response for Item 4.01 Source: https://github.com/sec-api-io/sec-api-node/blob/master/README.md Illustrates the structure of the JSON response when fetching data for Item 4.01, detailing auditor changes. ```json { "total": { "value": 10000, "relation": "gte" }, "data": [ { "id": "7ed33db091e32b437ff9c4571531869d", "accessionNo": "0001388658-26-000022", "formType": "8-K", "filedAt": "2026-03-31T19:49:16-04:00", "periodOfReport": "2026-03-30", "cik": "1388658", "ticker": "IRTC", "companyName": "iRhythm Holdings, Inc.", "items": [ "Item 4.01: Changes in Registrant's Certifying Accountant", "Item 9.01: Financial Statements and Exhibits" ], "item4_01": { "keyComponents": "iRhythm Holdings, Inc. dismissed PricewaterhouseCoopers LLP as its independent auditor on March 30, 2026, and subsequently engaged KPMG LLP as the new auditor for the fiscal year ending December 31, 2026.", "newAccountantDate": "2026-03-30", "engagedNewAccountant": true, "formerAccountantDate": "2026-03-30", "engagementEndReason": "dismissal", "formerAccountantName": "PricewaterhouseCoopers LLP", "newAccountantName": "KPMG LLP", "consultedNewAccountant": false, "reportedDisagreements": false, "reportableEventsExist": false, "attachments": ["Exhibit 16.1"], "reportedIcfrWeakness": false, "opinionType": "unqualified", "auditDisclaimer": false, "approvedChange": true } } ] } ``` -------------------------------- ### Example XBRL to JSON Response Structure Source: https://github.com/sec-api-io/sec-api-node/blob/master/README.md This is an example of the JSON structure returned after converting an XBRL filing. It includes sections like CoverPage, StatementsOfIncome, and BalanceSheets. ```json { "CoverPage": { "DocumentPeriodEndDate": "2020-09-26", "EntityRegistrantName": "Apple Inc.", "EntityIncorporationStateCountryCode": "CA", "EntityTaxIdentificationNumber": "94-2404110", "EntityAddressAddressLine1": "One Apple Park Way", "EntityAddressCityOrTown": "Cupertino", "EntityAddressStateOrProvince": "CA", "EntityAddressPostalZipCode": "95014", "CityAreaCode": "408", "LocalPhoneNumber": "996-1010", "TradingSymbol": "AAPL", "EntityPublicFloat": { "decimals": "-6", "unitRef": "usd", "period": { "instant": "2020-03-27" }, "value": "1070633000000" }, "EntityCommonStockSharesOutstanding": { "decimals": "-3", "unitRef": "shares", "period": { "instant": "2020-10-16" }, "value": "17001802000" }, "DocumentFiscalPeriodFocus": "FY", "CurrentFiscalYearEndDate": "--09-26" }, "StatementsOfIncome": { "RevenueFromContractWithCustomerExcludingAssessedTax": [ { "decimals": "-6", "unitRef": "usd", "period": { "startDate": "2019-09-29", "endDate": "2020-09-26" }, "segment": { "dimension": "srt:ProductOrServiceAxis", "value": "us-gaap:ProductMember" }, "value": "220747000000" }, { "decimals": "-6", "unitRef": "usd", "period": { "startDate": "2018-09-30", "endDate": "2019-09-28" }, "segment": { "dimension": "srt:ProductOrServiceAxis", "value": "us-gaap:ProductMember" }, "value": "213883000000" } ] }, "BalanceSheets": { "CashAndCashEquivalentsAtCarryingValue": [ { "decimals": "-6", "unitRef": "usd", "period": { "instant": "2020-09-26" }, "value": "38016000000" }, { "decimals": "-6", "unitRef": "usd", "period": { "instant": "2019-09-28" }, "value": "48844000000" }, { "decimals": "-6", "unitRef": "usd", "period": { "instant": "2020-09-26" }, "segment": { "dimension": "us-gaap:FinancialInstrumentAxis", "value": "us-gaap:CashMember" }, "value": "17773000000" } ] } } ``` -------------------------------- ### Example Form 13D/13G API Response Source: https://github.com/sec-api-io/sec-api-node/blob/master/README.md This is an example of the JSON response structure when querying for Form 13D/13G filings. It details the total number of filings and the structure of individual filing objects. ```json { "total": { "value": 10000, "relation": "gte" }, "filings": [ { "id": "a5d7c15340884b72fd2e95a5afde92e9", "accessionNo": "0001493152-26-014470", "formType": "SC 13D/A", "filedAt": "2026-04-01T06:20:43-04:00", "filers": [ { "cik": "1983324", "name": "Real Messenger Corp (Subject)" }, { "cik": "2099450", "name": "Ma Kwai Hoi (Filed by)" } ], "nameOfIssuer": "Real Messenger Corporation", "titleOfSecurities": "Ordinary Shares", "cusip": [], "eventDate": "2026-03-25", "amendmentNo": "1", "schedule13GFiledPreviously": false, "owners": [ { "name": ["Kwai Hoi MA"], "memberOfGroup": { "a": false, "b": false }, "sourceOfFunds": "OO", "legalProceedingsDisclosureRequired": false, "place": "X0", "soleVotingPower": 7217555, "sharedVotingPower": 0, "soleDispositivePower": 7217555, "sharedDispositivePower": 0, "aggregateAmountOwned": 7217555, "isAggregateExcludeShares": false, "amountAsPercent": 65.86, "typeOfReportingPerson": ["IN"] } // ... more items ], "item1": { "securityTitle": "Ordinary Shares", "issuerName": "Real Messenger Corporation", "issuerPrincipalAddress": { "street1": "695 Town Center Drive, Suite 1200", "street2": "", "city": "Costa Mesa", "stateOrCountry": "CA", "zipCode": "92626" }, "commentText": "The following constitutes Amendment No. 1 ("Amendment No. 1") to the Schedule 13D filed with the Securities and Exchange Commission ("SEC")..." }, "item2": { "filingPersonName": "", "principalBusinessAddress": "", "principalJob": "", "hasBeenConvicted": "", "convictionDescription": "", "citizenship": "" }, "item3": { "fundsSource": "..." }, "item4": { "transactionPurpose": "..." }, "item5": { "percentageOfClassSecurities": "...", "numberOfShares": "...", "transactionDescription": "...", "listOfShareholders": "...", "date5PercentOwnership": "Not applicable" }, "item6": { "contractDescription": "" }, "item7": { "filedExhibits": "..." } } ] } ``` -------------------------------- ### Example Form C API Response Structure Source: https://github.com/sec-api-io/sec-api-node/blob/master/README.md This is an example of the JSON response structure when querying the Form C API. It details the total number of results and the structure of individual campaign data, including issuer and offering information. ```json { "total": { "value": 10000, "relation": "gte" }, "data": [ { "id": "5ed83df80bfdn0dd611508c07e138867", "accessionNo": "0002103209-26-000005", "fileNo": "020-36757", "formType": "C/A", "filedAt": "2026-03-31T18:45:06-04:00", "cik": "2103209", "ticker": "", "companyName": "GigaWatt, Inc", "issuerInformation": { "isAmendment": false, "natureOfAmendment": "Campaign Page Updates", "issuerInfo": { "nameOfIssuer": "GigaWatt, Inc.", "legalStatus": { "legalStatusForm": "Corporation", "jurisdictionOrganization": "CA", "dateIncorporation": "09-17-2025" }, "issuerAddress": { "street1": "2386 E Walnut Ave", "city": "Fullerton", "stateOrCountry": "CA", "zipCode": "92831" }, "issuerWebsite": "https://www.gigawattinc.com/" }, "isCoIssuer": false, "companyName": "StartEngine Primary, LLC", "commissionCik": "0001725012", "commissionFileNumber": "008-70060" }, "offeringInformation": { "compensationAmount": "7 - 13 percent", "financialInterest": "One percent (1%) of securities of the total amount of investments raised in the offering, along the same terms as investors.", "securityOfferedType": "Other", "securityOfferedOtherDesc": "Class B Common Stock", "noOfSecurityOffered": 10000, "price": 2, "priceDeterminationMethod": "N/A", "offeringAmount": 20000, "overSubscriptionAccepted": true, "overSubscriptionAllocationType": "Other", "descOverSubscription": "At issuer's discretion, with priority given to StartEngine Owners", "maximumOfferingAmount": 1235000, "deadlineDate": "04-23-2026" }, "annualReportDisclosureRequirements": { "currentEmployees": 21, "totalAssetMostRecentFiscalYear": 2559852, "totalAssetPriorFiscalYear": 2169710, "cashEquiMostRecentFiscalYear": 521671, "cashEquiPriorFiscalYear": 575133, "actReceivedMostRecentFiscalYear": 11126, "actReceivedPriorFiscalYear": 2779, "shortTermDebtMostRecentFiscalYear": 2659535, "shortTermDebtPriorFiscalYear": 2311008, "longTermDebtMostRecentFiscalYear": 707533, "longTermDebtPriorFiscalYear": 748955, "revenueMostRecentFiscalYear": 7485272, "revenuePriorFiscalYear": 9788210, "costGoodsSoldMostRecentFiscalYear": 5091719, "costGoodsSoldPriorFiscalYear": 6836396, "taxPaidMostRecentFiscalYear": 537, "taxPaidPriorFiscalYear": 4631, "netIncomeMostRecentFiscalYear": 83037, "netIncomePriorFiscalYear": 45926, "issueJurisdictionSecuritiesOffering": [ "AL", "AK", "AZ" // ... more items ] }, "signatureInfo": { "issuerSignature": { "issuer": "GigaWatt, Inc.", "issuerSignature": "Deep G. Patel", "issuerTitle": "Founder, CEO, Board Member, Principal Accounting Officer" }, "signaturePersons": [ { "personSignature": "Deep G. Patel", "personTitle": "Founder, CEO, Board Member, Principal Accounting Officer", "signatureDate": "03-31-2026" } ] } } ] } ``` -------------------------------- ### AAER Database Example Response Source: https://github.com/sec-api-io/sec-api-node/blob/master/README.md Illustrates the structure of a successful response from the AAER Database API, including total count and a list of filings. ```json { "total": { "value": 427, "relation": "eq" }, "data": [ { "id": "b2dfd65355cdf4c4a629103a211882ce", "dateTime": "2024-12-31T12:19:45-05:00", "aaerNo": "AAER-4554", "releaseNo": ["34-102060"], "respondents": [ { "name": "Accell Audit & Compliance, PA", "type": "company" } ], "respondentsText": "Accell Audit & Compliance, PA", "urls": [ { "type": "primary", "url": "https://www.sec.gov/files/litigation/admin/2024/34-102060.pdf" } ], "summary": "The SEC has instituted public administrative proceedings against Accell Audit & Compliance, PA, resulting in a suspension and a $75,000 penalty for failing to exercise due professional care in auditing Ignite International Brands, Ltd.'s financial statements.", "tags": ["auditing misconduct", "fraudulent financial reporting"], "entities": [ { "name": "Accell Audit & Compliance, PA", "type": "company", "role": "respondent" }, { "name": "Ignite International Brands, Ltd.", "type": "company", "role": "entity audited" } ], "complaints": [ "Accell failed to exercise due professional care or skepticism, or to obtain sufficient appropriate audit evidence..." // ... more items ], "parallelActionsTakenBy": [], "hasAgreedToSettlement": true, "hasAgreedToPayPenalty": true, "penaltyAmounts": [ { "penaltyAmount": "75000", "penaltyAmountText": "$75,000", "imposedOn": "Accell Audit & Compliance, PA" } ], "requestedRelief": ["suspension from appearing or practicing before the Commission"], "violatedSections": ["Section 10(b) of the Exchange Act", "Rule 10b-5"], "otherAgenciesInvolved": [] } ] } ``` -------------------------------- ### Example Mapping API Response Source: https://github.com/sec-api-io/sec-api-node/blob/master/README.md This is a sample JSON response when resolving entities using the Mapping API. It contains detailed information about a company. ```json [ { "name": "TESLA INC", "ticker": "TSLA", "cik": "1318605", "cusip": "88160R101", "exchange": "NASDAQ", "isDelisted": false, "category": "Domestic Common Stock", "sector": "Consumer Cyclical", "industry": "Auto Manufacturers", "sic": "3711", "sicSector": "Manufacturing", "sicIndustry": "Motor Vehicles & Passenger Car Bodies", "famaSector": "", "famaIndustry": "Automobiles and Trucks", "currency": "USD", "location": "California; U.S.A", "id": "eaeafc4ffc04a49da153adebf1f6960a" } ] ``` -------------------------------- ### Get Executive Compensation Data by Ticker Source: https://github.com/sec-api-io/sec-api-node/blob/master/README.md Retrieves executive compensation records for a specific company ticker. Requires API key setup. Returns an array of compensation records. ```javascript const { execCompApi } = require('sec-api'); execCompApi.setApiKey('YOUR_API_KEY'); // Simple lookup by ticker const compByTicker = await execCompApi.getData('TSLA'); // response: [...] array of compensation records ``` -------------------------------- ### Get Directors & Board Members Data Source: https://github.com/sec-api-io/sec-api-node/blob/master/README.md Fetches structured data on directors and board members. Requires API key setup. Use 'query' for filtering and 'from'/'size' for pagination. ```javascript const { directorsBoardMembersApi } = require('sec-api'); directorsBoardMembersApi.setApiKey('YOUR_API_KEY'); const data = await directorsBoardMembersApi.getData({ query: 'ticker:AAPL', from: '0', size: '50', sort: [{ filedAt: { order: 'desc' } }], }); // response: { total, data } ``` -------------------------------- ### Display All Available Datasets in Terminal Source: https://github.com/sec-api-io/sec-api-node/blob/master/README.md Use `datasetsApi.showAll()` to display a formatted list of all available datasets directly in the terminal. This provides a quick overview of dataset names, formats, and sizes. ```javascript await datasetsApi.showAll(); ``` -------------------------------- ### Example Regulation A Search Response Source: https://github.com/sec-api-io/sec-api-node/blob/master/README.md This is an example of the JSON response structure you can expect when searching for Regulation A filings. It includes total count and a list of filing data. ```json { "total": { "value": 1419, "relation": "eq" }, "data": [ { "id": "af09549e0cb0775585c3481d61f8e471", "accessionNo": "0001829126-24-008673", "fileNo": "24R-00889", "formType": "1-Z", "filedAt": "2024-12-31T17:27:40-05:00", "cik": "1973742", "ticker": "", "companyName": "Worldwide Stages, Inc.", "item1": { "issuerName": "Worldwide Stages, Inc.", "street1": "5000 Northfield Lane", "city": "Spring Hill", "stateOrCountry": "TN", "zipCode": "37174", "phone": "615-341-5900", "commissionFileNumber": ["024-12301"] }, "summaryInfoOffering": [ { "offeringQualificationDate": "08-10-2023", "offeringCommenceDate": "08-10-2023", "offeringSecuritiesQualifiedSold": 7500000, "offeringSecuritiesSold": 3870, "pricePerSecurity": 10, "portionSecuritiesSoldIssuer": 30960, "portionSecuritiesSoldSecurityholders": 7740, "underwrittenSpName": ["-"], "underwriterFees": 0, "salesCommissionsSpName": ["Dalmore Group, LLC"], "salesCommissionsFee": 387, "findersSpName": ["-"], "findersFees": 0, "auditorSpName": ["Fruci & Associates II, PLLC"], "auditorFees": 40000, "legalSpName": ["Nelson Mullins Riley & Scarborough"], "legalFees": 132500, "promoterSpName": ["-"], "promotersFees": 0, "blueSkySpName": ["Guarrd, Inc."], "blueSkyFees": 4750, "crdNumberBrokerDealer": "000154559", "issuerNetProceeds": 25900.4, "clarificationResponses": "Net proceeds represents amount received by issuer ($30,960) after subtracting its share of commissions ($309.60) and blue sky compliance costs ($4,750)." } ], "certificationSuspension": [ { "securitiesClassTitle": "Class B Common Stock", "certificationFileNumber": ["024-12301"], "approxRecordHolders": 15 } ], "signatureTab": [ { "cik": "0001973742", "regulationIssuerName1": "Worldwide Stages, Inc.", "regulationIssuerName2": "Worldwide Stages, Inc.", "signatureBy": "/s/ Kelly Frey, Sr.", "date": "12-31-2024", "title": "Chief Executive Officer" } ] } ] } ``` -------------------------------- ### Example Response for Item 4.02 Source: https://github.com/sec-api-io/sec-api-node/blob/master/README.md Illustrates the structure of the JSON response when fetching data for Item 4.02, detailing non-reliance on prior financial statements. ```json { "total": { "value": 8546, "relation": "eq" }, "data": [ { "id": "1153464e0d82cd42a5773bede05220a8", "accessionNo": "0001765048-26-000002", "formType": "8-K", "filedAt": "2026-03-26T09:53:26-04:00", "periodOfReport": "2026-03-26", "cik": "1765048", "ticker": "GCGJ", "companyName": "GUOCHUN INTERNATIONAL INC.", "items": [ "Item 4.02: Non-Reliance on Previously Issued Financial Statements or a Related Audit Report or Completed Interim Review" ], "item4_02": { "keyComponents": "The Company determined that action should be taken to preclude reliance on previously issued unaudited condensed financial statements for the period ended September 30, 2025, due to an erroneously recorded amount in other general and administrative expenses.", "identifiedIssues": [ "Erroneously recorded amount in other general and administrative expenses" ], "affectedReportingPeriods": ["Q3 2025"], "identifiedBy": ["Company"], "restatementIsNecessary": true, "reasonsForRestatement": [ "Erroneous recording of other general and administrative expenses" ], "impactYetToBeDetermined": true, "impactOfError": "Decrease in other general and administrative expenses of $8,250, with a corresponding increase in prepayments of $8,250.", "impactIsMaterial": false, "materialWeaknessIdentified": false, "affectedLineItems": [ "Other General and Administrative Expenses", "Prepayments" ], "netIncomeDecreased": false, "netIncomeIncreased": false, "revenueDecreased": false, "revenueIncreased": false, "eventClassification": "Financial Restatement Due to Erroneous Recording in General and Administrative Expenses" } } ] } ``` -------------------------------- ### Download SEC Dataset as ZIP Source: https://github.com/sec-api-io/sec-api-node/blob/master/README.md Download an entire SEC dataset as a single ZIP file using the datasetsApi with the 'zip' strategy. ```javascript await datasetsApi.download({ name: 'form-10k-content', strategy: 'zip' }); ``` -------------------------------- ### List All Available Datasets Source: https://github.com/sec-api-io/sec-api-node/blob/master/README.md Use `datasetsApi.getAll()` to retrieve a raw JSON list of all available datasets. No API key is required for this operation. ```javascript const { datasetsApi } = require('sec-api'); // no API key required — returns raw JSON list const allDatasets = await datasetsApi.getAll(); ``` -------------------------------- ### Import sec-api Library Source: https://github.com/sec-api-io/sec-api-node/blob/master/README.md Import the sec-api library. Both CommonJS and ESM import syntaxes are supported. ```javascript import { downloadApi } from 'sec-api'; // ESM ``` ```javascript const { downloadApi } = require('sec-api'); // CommonJS ```