@invinite-org/data-api-client 0.10.1 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +74 -20
- package/README.md +32 -2
- package/dist/apis/EarningsCallsApi.d.ts +24 -2
- package/dist/apis/EarningsCallsApi.js +27 -3
- package/dist/apis/IPOsApi.d.ts +11 -2
- package/dist/apis/IPOsApi.js +13 -3
- package/dist/apis/SECApi.d.ts +840 -0
- package/dist/apis/SECApi.js +1959 -0
- package/dist/apis/index.d.ts +1 -1
- package/dist/apis/index.js +1 -1
- package/dist/esm/apis/EarningsCallsApi.d.ts +24 -2
- package/dist/esm/apis/EarningsCallsApi.js +26 -2
- package/dist/esm/apis/IPOsApi.d.ts +11 -2
- package/dist/esm/apis/IPOsApi.js +12 -2
- package/dist/esm/apis/SECApi.d.ts +840 -0
- package/dist/esm/apis/SECApi.js +1955 -0
- package/dist/esm/apis/index.d.ts +1 -1
- package/dist/esm/apis/index.js +1 -1
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInner.d.ts +7 -0
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInner.js +3 -0
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendar.d.ts +95 -0
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendar.js +95 -0
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCall.d.ts +102 -0
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCall.js +100 -0
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.d.ts +56 -0
- package/dist/esm/models/{SecFilingsSearch200ResponseSourcesInner.js → EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.js} +23 -27
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.d.ts +69 -0
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.js +72 -0
- package/{src/models/SecFilingsAvailableFormTypes200Response.ts → dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.d.ts} +26 -48
- package/dist/esm/models/{SecFilingsSections200ResponseCompaniesInner.js → EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.js} +17 -18
- package/dist/esm/models/EarningsCallsTranscript200Response.d.ts +3 -3
- package/dist/esm/models/EarningsCallsTranscript200Response.js +3 -3
- package/dist/esm/models/EarningsCallsTranscript200ResponseEvent.d.ts +233 -0
- package/dist/esm/models/{SecFilingsSections200ResponseCompaniesInnerSectionsInner.js → EarningsCallsTranscript200ResponseEvent.js} +136 -47
- package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInner.d.ts +7 -0
- package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInner.js +3 -0
- package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPending.d.ts +89 -0
- package/dist/esm/models/{SecFilingsList200ResponseCompaniesInnerFilingsInner.js → IposRegistrationsList200ResponseRegistrationsInnerIpoPending.js} +43 -44
- package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.d.ts +74 -0
- package/dist/esm/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.js +55 -0
- package/dist/{models/SecFilingsSearch200Response.d.ts → esm/models/SecDatasets200Response.d.ts} +26 -17
- package/dist/esm/models/{SecFilingsSearch200Response.js → SecDatasets200Response.js} +13 -19
- package/dist/esm/models/SecDocument200Response.d.ts +104 -0
- package/dist/esm/models/SecDocument200Response.js +42 -0
- package/dist/esm/models/SecDocumentFactPlaces200Response.d.ts +88 -0
- package/dist/esm/models/SecDocumentFactPlaces200Response.js +42 -0
- package/dist/esm/models/SecDocumentFigure200Response.d.ts +70 -0
- package/dist/esm/models/SecDocumentFigure200Response.js +42 -0
- package/dist/esm/models/SecDocumentSections200Response.d.ts +71 -0
- package/dist/esm/models/SecDocumentSections200Response.js +43 -0
- package/dist/esm/models/SecDocumentSections200ResponseSectionsInner.d.ts +85 -0
- package/dist/esm/models/SecDocumentSections200ResponseSectionsInner.js +44 -0
- package/dist/esm/models/SecFiler200Response.d.ts +80 -0
- package/dist/esm/models/{SecFilingsList200ResponseCompaniesInner.js → SecFiler200Response.js} +13 -25
- package/dist/esm/models/SecFilerCoverage200Response.d.ts +82 -0
- package/dist/esm/models/SecFilerCoverage200Response.js +42 -0
- package/dist/{models/SecFilingsList200ResponseCompaniesInnerFilingsInner.d.ts → esm/models/SecFilerLifecycle200Response.d.ts} +106 -53
- package/dist/esm/models/SecFilerLifecycle200Response.js +42 -0
- package/dist/esm/models/SecFilers200Response.d.ts +53 -0
- package/dist/esm/models/SecFilers200Response.js +43 -0
- package/dist/esm/models/{SecFilingsSearch200ResponseSourcesInner.d.ts → SecFilers200ResponseMatchesInner.d.ts} +31 -28
- package/dist/esm/models/SecFilers200ResponseMatchesInner.js +37 -0
- package/dist/esm/models/SecFiling200Response.d.ts +88 -0
- package/dist/{models/SecFilingsSearch200Response.js → esm/models/SecFiling200Response.js} +13 -26
- package/dist/esm/models/{SecFilingsList200Response.d.ts → SecFilingFacts200Response.d.ts} +43 -14
- package/dist/esm/models/SecFilingFacts200Response.js +42 -0
- package/dist/esm/models/SecFilingHoldings200Response.d.ts +74 -0
- package/dist/esm/models/SecFilingHoldings200Response.js +42 -0
- package/dist/esm/models/SecFilingReviewChain200Response.d.ts +92 -0
- package/dist/esm/models/SecFilingReviewChain200Response.js +42 -0
- package/dist/esm/models/SecFilingReviewRelations200Response.d.ts +88 -0
- package/dist/esm/models/SecFilingReviewRelations200Response.js +42 -0
- package/dist/esm/models/SecFilings200Response.d.ts +88 -0
- package/dist/esm/models/SecFilings200Response.js +44 -0
- package/dist/esm/models/SecFilings200ResponseFilingsInner.d.ts +81 -0
- package/dist/esm/models/SecFilings200ResponseFilingsInner.js +37 -0
- package/dist/esm/models/{SecFilingsAvailableFormTypes200Response.d.ts → SecFilings200ResponseFormFacetInner.d.ts} +25 -12
- package/dist/esm/models/{SecFilingsList200Response.js → SecFilings200ResponseFormFacetInner.js} +10 -17
- package/dist/esm/models/SecFinancialsCatalog200Response.d.ts +48 -0
- package/dist/esm/models/SecFinancialsCatalog200Response.js +42 -0
- package/dist/{models/SecFilingsSections200ResponseCompaniesInnerSectionsInner.d.ts → esm/models/SecHoldingsHolders200Response.d.ts} +88 -64
- package/dist/esm/models/SecHoldingsHolders200Response.js +42 -0
- package/dist/esm/models/{SecFilingsList200ResponseCompaniesInner.d.ts → SecIssuers200Response.d.ts} +45 -22
- package/dist/esm/models/SecIssuers200Response.js +42 -0
- package/dist/esm/models/{SecFilingsSections200ResponseCompaniesInner.d.ts → SecReadiness.d.ts} +34 -21
- package/dist/esm/models/SecReadiness.js +55 -0
- package/dist/esm/models/SecSearch200Response.d.ts +88 -0
- package/dist/esm/models/SecSearch200Response.js +51 -0
- package/dist/esm/models/SecSearch200ResponseHitsInner.d.ts +92 -0
- package/dist/esm/models/SecSearch200ResponseHitsInner.js +38 -0
- package/dist/esm/models/SecSearchCoverage.d.ts +61 -0
- package/dist/esm/models/SecSearchCoverage.js +52 -0
- package/dist/esm/models/SecSearchCoverageLexical.d.ts +51 -0
- package/dist/esm/models/{SecFilingsAvailableFormTypes200Response.js → SecSearchCoverageLexical.js} +10 -16
- package/dist/esm/models/SecStoreError.d.ts +52 -0
- package/dist/esm/models/{SecFilingsSections200Response.js → SecStoreError.js} +14 -16
- package/dist/esm/models/WebSocketFiling.d.ts +1 -1
- package/dist/esm/models/index.d.ts +36 -9
- package/dist/esm/models/index.js +36 -9
- package/dist/models/EarningsCallsCalendar200ResponseEventsInner.d.ts +7 -0
- package/dist/models/EarningsCallsCalendar200ResponseEventsInner.js +3 -0
- package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendar.d.ts +95 -0
- package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendar.js +103 -0
- package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCall.d.ts +102 -0
- package/dist/models/{SecFilingsSections200ResponseCompaniesInnerSectionsInner.js → EarningsCallsCalendar200ResponseEventsInnerCalendarCall.js} +69 -67
- package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.d.ts +56 -0
- package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.js +66 -0
- package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.d.ts +69 -0
- package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.js +80 -0
- package/dist/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.d.ts +44 -0
- package/dist/models/{SecFilingsList200ResponseCompaniesInner.js → EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.js} +22 -25
- package/dist/models/EarningsCallsTranscript200Response.d.ts +3 -3
- package/dist/models/EarningsCallsTranscript200Response.js +3 -3
- package/dist/models/EarningsCallsTranscript200ResponseEvent.d.ts +233 -0
- package/dist/models/EarningsCallsTranscript200ResponseEvent.js +196 -0
- package/dist/models/IposRegistrationsList200ResponseRegistrationsInner.d.ts +7 -0
- package/dist/models/IposRegistrationsList200ResponseRegistrationsInner.js +3 -0
- package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPending.d.ts +89 -0
- package/dist/models/{SecFilingsList200ResponseCompaniesInnerFilingsInner.js → IposRegistrationsList200ResponseRegistrationsInnerIpoPending.js} +49 -49
- package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.d.ts +74 -0
- package/dist/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.js +62 -0
- package/dist/{esm/models/SecFilingsSearch200Response.d.ts → models/SecDatasets200Response.d.ts} +26 -17
- package/dist/models/{SecFilingsSections200Response.js → SecDatasets200Response.js} +19 -21
- package/dist/models/SecDocument200Response.d.ts +104 -0
- package/dist/models/{SecFilingsSections200ResponseCompaniesInner.js → SecDocument200Response.js} +18 -28
- package/dist/models/SecDocumentFactPlaces200Response.d.ts +88 -0
- package/dist/models/SecDocumentFactPlaces200Response.js +49 -0
- package/dist/models/SecDocumentFigure200Response.d.ts +70 -0
- package/dist/models/SecDocumentFigure200Response.js +49 -0
- package/dist/models/SecDocumentSections200Response.d.ts +71 -0
- package/dist/models/SecDocumentSections200Response.js +50 -0
- package/dist/models/SecDocumentSections200ResponseSectionsInner.d.ts +85 -0
- package/dist/models/SecDocumentSections200ResponseSectionsInner.js +52 -0
- package/dist/models/SecFiler200Response.d.ts +80 -0
- package/dist/models/SecFiler200Response.js +49 -0
- package/dist/models/SecFilerCoverage200Response.d.ts +82 -0
- package/dist/models/{SecFilingsSearch200ResponseSourcesInner.js → SecFilerCoverage200Response.js} +18 -39
- package/dist/{esm/models/SecFilingsList200ResponseCompaniesInnerFilingsInner.d.ts → models/SecFilerLifecycle200Response.d.ts} +106 -53
- package/dist/models/SecFilerLifecycle200Response.js +49 -0
- package/dist/models/SecFilers200Response.d.ts +53 -0
- package/dist/models/SecFilers200Response.js +50 -0
- package/dist/models/{SecFilingsSearch200ResponseSourcesInner.d.ts → SecFilers200ResponseMatchesInner.d.ts} +31 -28
- package/dist/models/SecFilers200ResponseMatchesInner.js +44 -0
- package/dist/models/SecFiling200Response.d.ts +88 -0
- package/dist/models/SecFiling200Response.js +49 -0
- package/dist/models/{SecFilingsList200Response.d.ts → SecFilingFacts200Response.d.ts} +43 -14
- package/dist/models/SecFilingFacts200Response.js +49 -0
- package/dist/models/SecFilingHoldings200Response.d.ts +74 -0
- package/dist/models/SecFilingHoldings200Response.js +49 -0
- package/dist/models/SecFilingReviewChain200Response.d.ts +92 -0
- package/dist/models/SecFilingReviewChain200Response.js +49 -0
- package/dist/models/SecFilingReviewRelations200Response.d.ts +88 -0
- package/dist/models/SecFilingReviewRelations200Response.js +49 -0
- package/dist/models/SecFilings200Response.d.ts +88 -0
- package/dist/models/SecFilings200Response.js +51 -0
- package/dist/models/SecFilings200ResponseFilingsInner.d.ts +81 -0
- package/dist/models/SecFilings200ResponseFilingsInner.js +44 -0
- package/dist/{esm/models/SecFilingsSections200Response.d.ts → models/SecFilings200ResponseFormFacetInner.d.ts} +25 -13
- package/dist/models/SecFilings200ResponseFormFacetInner.js +44 -0
- package/dist/models/SecFinancialsCatalog200Response.d.ts +48 -0
- package/dist/models/SecFinancialsCatalog200Response.js +49 -0
- package/dist/{esm/models/SecFilingsSections200ResponseCompaniesInnerSectionsInner.d.ts → models/SecHoldingsHolders200Response.d.ts} +88 -64
- package/dist/models/SecHoldingsHolders200Response.js +49 -0
- package/dist/models/{SecFilingsList200ResponseCompaniesInner.d.ts → SecIssuers200Response.d.ts} +45 -22
- package/dist/models/SecIssuers200Response.js +49 -0
- package/dist/models/{SecFilingsSections200ResponseCompaniesInner.d.ts → SecReadiness.d.ts} +34 -21
- package/dist/models/SecReadiness.js +63 -0
- package/dist/models/SecSearch200Response.d.ts +88 -0
- package/dist/models/SecSearch200Response.js +59 -0
- package/dist/models/SecSearch200ResponseHitsInner.d.ts +92 -0
- package/dist/models/SecSearch200ResponseHitsInner.js +45 -0
- package/dist/models/SecSearchCoverage.d.ts +61 -0
- package/dist/models/SecSearchCoverage.js +60 -0
- package/dist/models/SecSearchCoverageLexical.d.ts +51 -0
- package/dist/models/{SecFilingsList200Response.js → SecSearchCoverageLexical.js} +15 -22
- package/dist/models/SecStoreError.d.ts +52 -0
- package/dist/models/{SecFilingsAvailableFormTypes200Response.js → SecStoreError.js} +19 -20
- package/dist/models/WebSocketFiling.d.ts +1 -1
- package/dist/models/index.d.ts +36 -9
- package/dist/models/index.js +36 -9
- package/docs/EarningsCallsApi.md +8 -2
- package/docs/EarningsCallsCalendar200ResponseEventsInner.md +2 -0
- package/docs/EarningsCallsCalendar200ResponseEventsInnerCalendar.md +43 -0
- package/docs/EarningsCallsCalendar200ResponseEventsInnerCalendarCall.md +45 -0
- package/docs/EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.md +43 -0
- package/docs/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.md +41 -0
- package/docs/EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.md +39 -0
- package/docs/EarningsCallsTranscript200Response.md +1 -1
- package/docs/EarningsCallsTranscript200ResponseEvent.md +88 -0
- package/docs/IPOsApi.md +5 -2
- package/docs/IposRegistrationsList200ResponseRegistrationsInner.md +2 -0
- package/docs/IposRegistrationsList200ResponseRegistrationsInnerIpoPending.md +51 -0
- package/docs/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.md +49 -0
- package/docs/SECApi.md +2646 -0
- package/docs/{SecFilingsList200Response.md → SecDatasets200Response.md} +11 -6
- package/docs/SecDocument200Response.md +53 -0
- package/docs/SecDocumentFactPlaces200Response.md +51 -0
- package/docs/SecDocumentFigure200Response.md +45 -0
- package/docs/SecDocumentSections200Response.md +47 -0
- package/docs/SecDocumentSections200ResponseSectionsInner.md +48 -0
- package/docs/SecFiler200Response.md +47 -0
- package/docs/SecFilerCoverage200Response.md +49 -0
- package/docs/SecFilerLifecycle200Response.md +65 -0
- package/docs/SecFilers200Response.md +41 -0
- package/docs/{SecFilingsSearch200ResponseSourcesInner.md → SecFilers200ResponseMatchesInner.md} +14 -14
- package/docs/SecFiling200Response.md +49 -0
- package/docs/SecFilingFacts200Response.md +43 -0
- package/docs/SecFilingHoldings200Response.md +47 -0
- package/docs/SecFilingReviewChain200Response.md +51 -0
- package/docs/SecFilingReviewRelations200Response.md +51 -0
- package/docs/SecFilings200Response.md +51 -0
- package/docs/SecFilings200ResponseFilingsInner.md +50 -0
- package/docs/{SecFilingsAvailableFormTypes200Response.md → SecFilings200ResponseFormFacetInner.md} +10 -6
- package/docs/{SecFilingsSections200Response.md → SecFinancialsCatalog200Response.md} +11 -6
- package/docs/SecHoldingsHolders200Response.md +67 -0
- package/docs/{SecFilingsList200ResponseCompaniesInner.md → SecIssuers200Response.md} +17 -10
- package/docs/SecReadiness.md +39 -0
- package/docs/SecSearch200Response.md +49 -0
- package/docs/SecSearch200ResponseHitsInner.md +52 -0
- package/docs/SecSearchCoverage.md +41 -0
- package/docs/{SecFilingsSearch200Response.md → SecSearchCoverageLexical.md} +13 -8
- package/docs/SecStoreError.md +41 -0
- package/docs/WebSocketFiling.md +1 -1
- package/package.json +1 -1
- package/src/apis/EarningsCallsApi.ts +32 -2
- package/src/apis/IPOsApi.ts +15 -2
- package/src/apis/SECApi.ts +2596 -0
- package/src/apis/index.ts +1 -1
- package/src/models/EarningsCallsCalendar200ResponseEventsInner.ts +15 -0
- package/src/models/EarningsCallsCalendar200ResponseEventsInnerCalendar.ts +159 -0
- package/src/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCall.ts +163 -0
- package/src/models/EarningsCallsCalendar200ResponseEventsInnerCalendarCallSource.ts +102 -0
- package/src/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReport.ts +123 -0
- package/src/models/EarningsCallsCalendar200ResponseEventsInnerCalendarReportSource.ts +84 -0
- package/src/models/EarningsCallsTranscript200Response.ts +10 -10
- package/src/models/EarningsCallsTranscript200ResponseEvent.ts +363 -0
- package/src/models/IposRegistrationsList200ResponseRegistrationsInner.ts +15 -0
- package/src/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPending.ts +157 -0
- package/src/models/IposRegistrationsList200ResponseRegistrationsInnerIpoPendingProfile.ts +121 -0
- package/src/models/{SecFilingsSearch200Response.ts → SecDatasets200Response.ts} +41 -30
- package/src/models/SecDocument200Response.ts +150 -0
- package/src/models/SecDocumentFactPlaces200Response.ts +142 -0
- package/src/models/{SecFilingsSections200ResponseCompaniesInner.ts → SecDocumentFigure200Response.ts} +63 -37
- package/src/models/SecDocumentSections200Response.ts +133 -0
- package/src/models/SecDocumentSections200ResponseSectionsInner.ts +135 -0
- package/src/models/{SecFilingsSearch200ResponseSourcesInner.ts → SecFiler200Response.ts} +67 -52
- package/src/models/SecFilerCoverage200Response.ts +134 -0
- package/src/models/{SecFilingsList200ResponseCompaniesInnerFilingsInner.ts → SecFilerLifecycle200Response.ts} +126 -92
- package/src/models/SecFilers200Response.ts +109 -0
- package/src/models/SecFilers200ResponseMatchesInner.ts +108 -0
- package/src/models/SecFiling200Response.ts +134 -0
- package/src/models/SecFilingFacts200Response.ts +110 -0
- package/src/models/SecFilingHoldings200Response.ts +126 -0
- package/src/models/SecFilingReviewChain200Response.ts +142 -0
- package/src/models/SecFilingReviewRelations200Response.ts +142 -0
- package/src/models/SecFilings200Response.ts +156 -0
- package/src/models/SecFilings200ResponseFilingsInner.ts +132 -0
- package/src/models/{SecFilingsSections200Response.ts → SecFilings200ResponseFormFacetInner.ts} +35 -25
- package/src/models/SecFinancialsCatalog200Response.ts +94 -0
- package/src/models/{SecFilingsSections200ResponseCompaniesInnerSectionsInner.ts → SecHoldingsHolders200Response.ts} +125 -111
- package/src/models/{SecFilingsList200ResponseCompaniesInner.ts → SecIssuers200Response.ts} +64 -38
- package/src/models/SecReadiness.ts +103 -0
- package/src/models/SecSearch200Response.ts +159 -0
- package/src/models/SecSearch200ResponseHitsInner.ts +148 -0
- package/src/models/SecSearchCoverage.ts +115 -0
- package/src/models/{SecFilingsList200Response.ts → SecSearchCoverageLexical.ts} +44 -26
- package/src/models/SecStoreError.ts +102 -0
- package/src/models/WebSocketFiling.ts +1 -1
- package/src/models/index.ts +36 -9
- package/dist/apis/SECFilingsApi.d.ts +0 -117
- package/dist/apis/SECFilingsApi.js +0 -284
- package/dist/esm/apis/SECFilingsApi.d.ts +0 -117
- package/dist/esm/apis/SECFilingsApi.js +0 -280
- package/dist/models/SecFilingsAvailableFormTypes200Response.d.ts +0 -32
- package/dist/models/SecFilingsSections200Response.d.ts +0 -33
- package/docs/SECFilingsApi.md +0 -344
- package/docs/SecFilingsList200ResponseCompaniesInnerFilingsInner.md +0 -54
- package/docs/SecFilingsSections200ResponseCompaniesInner.md +0 -38
- package/docs/SecFilingsSections200ResponseCompaniesInnerSectionsInner.md +0 -62
- package/src/apis/SECFilingsApi.ts +0 -368
package/docs/SECApi.md
ADDED
|
@@ -0,0 +1,2646 @@
|
|
|
1
|
+
# SECApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.data.invinite.com*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
| [**secDatasets**](SECApi.md#secdatasets) | **GET** /v1/sec/datasets | SEC dataset releases |
|
|
8
|
+
| [**secDocument**](SECApi.md#secdocument) | **GET** /v1/sec/documents/{accession}/{filename} | SEC document (current version) |
|
|
9
|
+
| [**secDocumentFactPlaces**](SECApi.md#secdocumentfactplaces) | **GET** /v1/sec/versions/{version_id}/fact-places | XBRL fact places in a document version |
|
|
10
|
+
| [**secDocumentFigure**](SECApi.md#secdocumentfigure) | **GET** /v1/sec/versions/{version_id}/figures/{block_id} | SEC document figure |
|
|
11
|
+
| [**secDocumentSections**](SECApi.md#secdocumentsections) | **GET** /v1/sec/versions/{version_id}/sections | Sections of an SEC document version |
|
|
12
|
+
| [**secDocumentVersion**](SECApi.md#secdocumentversion) | **GET** /v1/sec/versions/{version_id} | SEC document version |
|
|
13
|
+
| [**secExport**](SECApi.md#secexport) | **GET** /v1/sec/exports/{export_id} | Metric export manifest |
|
|
14
|
+
| [**secExportFile**](SECApi.md#secexportfile) | **GET** /v1/sec/exports/{export_id}/file | Download a metric export |
|
|
15
|
+
| [**secExportsFinancialMetrics**](SECApi.md#secexportsfinancialmetrics) | **GET** /v1/sec/exports/financial-metrics | Request an annual metric export |
|
|
16
|
+
| [**secFiler**](SECApi.md#secfiler) | **GET** /v1/sec/filers/{cik} | SEC filer |
|
|
17
|
+
| [**secFilerCoverage**](SECApi.md#secfilercoverage) | **GET** /v1/sec/filers/{cik}/coverage | SEC filer document coverage |
|
|
18
|
+
| [**secFilerLifecycle**](SECApi.md#secfilerlifecycle) | **GET** /v1/sec/filers/{cik}/lifecycle | SEC issuer lifecycle |
|
|
19
|
+
| [**secFilers**](SECApi.md#secfilers) | **GET** /v1/sec/filers | Find SEC filers |
|
|
20
|
+
| [**secFiling**](SECApi.md#secfiling) | **GET** /v1/sec/filings/{accession} | SEC filing and its documents |
|
|
21
|
+
| [**secFilingFacts**](SECApi.md#secfilingfacts) | **GET** /v1/sec/filings/{accession}/facts | SEC dataset facts of a filing |
|
|
22
|
+
| [**secFilingHoldings**](SECApi.md#secfilingholdings) | **GET** /v1/sec/filings/{accession}/holdings | Holdings of a 13F filing |
|
|
23
|
+
| [**secFilingNotes**](SECApi.md#secfilingnotes) | **GET** /v1/sec/filings/{accession}/notes | SEC dataset text notes of a filing |
|
|
24
|
+
| [**secFilingReviewChain**](SECApi.md#secfilingreviewchain) | **GET** /v1/sec/filings/{accession}/review-chain | SEC review chain of a filing |
|
|
25
|
+
| [**secFilingReviewRelations**](SECApi.md#secfilingreviewrelations) | **GET** /v1/sec/filings/{accession}/review-relations | SEC review relations of a filing |
|
|
26
|
+
| [**secFilings**](SECApi.md#secfilings) | **GET** /v1/sec/filings | SEC filings of a filer |
|
|
27
|
+
| [**secFinancialsCatalog**](SECApi.md#secfinancialscatalog) | **GET** /v1/sec/financials/catalog | Standardization rule catalog |
|
|
28
|
+
| [**secFinancialsFact**](SECApi.md#secfinancialsfact) | **GET** /v1/sec/financials/facts | Explain a standardized fact |
|
|
29
|
+
| [**secFinancialsStatement**](SECApi.md#secfinancialsstatement) | **GET** /v1/sec/financials/{cik}/statements/{statement} | Standardized statement with provenance |
|
|
30
|
+
| [**secHoldingsDeltas**](SECApi.md#secholdingsdeltas) | **GET** /v1/sec/holdings/deltas | Position changes in a security (13F) |
|
|
31
|
+
| [**secHoldingsFormFilers**](SECApi.md#secholdingsformfilers) | **GET** /v1/sec/holdings/form-filers | Filers of an SEC form |
|
|
32
|
+
| [**secHoldingsHolders**](SECApi.md#secholdingsholders) | **GET** /v1/sec/holdings/holders | Institutional holders of a security (13F) |
|
|
33
|
+
| [**secHoldingsManagerPortfolio**](SECApi.md#secholdingsmanagerportfolio) | **GET** /v1/sec/holdings/managers/{cik}/portfolio | Portfolio of a 13F manager |
|
|
34
|
+
| [**secIssuers**](SECApi.md#secissuers) | **GET** /v1/sec/issuers | List SEC issuers |
|
|
35
|
+
| [**secSearch**](SECApi.md#secsearch) | **GET** /v1/sec/search | Search SEC documents |
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
## secDatasets
|
|
40
|
+
|
|
41
|
+
> SecDatasets200Response secDatasets()
|
|
42
|
+
|
|
43
|
+
SEC dataset releases
|
|
44
|
+
|
|
45
|
+
The active release of each SEC dataset the store loads (Financial Statement and Notes, 13F, company facts): period, release hash, publication and load times — the identity every dataset row cites. Separate from document coverage (`held_through`). Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
|
|
46
|
+
|
|
47
|
+
### Example
|
|
48
|
+
|
|
49
|
+
```ts
|
|
50
|
+
import {
|
|
51
|
+
Configuration,
|
|
52
|
+
SECApi,
|
|
53
|
+
} from '@invinite-org/data-api-client';
|
|
54
|
+
import type { SecDatasetsRequest } from '@invinite-org/data-api-client';
|
|
55
|
+
|
|
56
|
+
async function example() {
|
|
57
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
58
|
+
const config = new Configuration({
|
|
59
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
60
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
61
|
+
});
|
|
62
|
+
const api = new SECApi(config);
|
|
63
|
+
|
|
64
|
+
try {
|
|
65
|
+
const data = await api.secDatasets();
|
|
66
|
+
console.log(data);
|
|
67
|
+
} catch (error) {
|
|
68
|
+
console.error(error);
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
// Run the test
|
|
73
|
+
example().catch(console.error);
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
### Parameters
|
|
77
|
+
|
|
78
|
+
This endpoint does not need any parameter.
|
|
79
|
+
|
|
80
|
+
### Return type
|
|
81
|
+
|
|
82
|
+
[**SecDatasets200Response**](SecDatasets200Response.md)
|
|
83
|
+
|
|
84
|
+
### Authorization
|
|
85
|
+
|
|
86
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
87
|
+
|
|
88
|
+
### HTTP request headers
|
|
89
|
+
|
|
90
|
+
- **Content-Type**: Not defined
|
|
91
|
+
- **Accept**: `application/json`
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
### HTTP response details
|
|
95
|
+
| Status code | Description | Response headers |
|
|
96
|
+
|-------------|-------------|------------------|
|
|
97
|
+
| **200** | The active dataset releases | - |
|
|
98
|
+
| **202** | The active dataset releases | - |
|
|
99
|
+
| **400** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
100
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
101
|
+
| **403** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
102
|
+
| **404** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
103
|
+
| **424** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
104
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
105
|
+
| **503** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
106
|
+
|
|
107
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
## secDocument
|
|
111
|
+
|
|
112
|
+
> SecDocument200Response secDocument(accession, filename, blocks, pages, printed, printedOccurrence, neighbors, footnotes, limit)
|
|
113
|
+
|
|
114
|
+
SEC document (current version)
|
|
115
|
+
|
|
116
|
+
One document of a filing as canonical text: the current version is resolved ONCE and every block, neighbor, footnote and figure comes from that version (`version.version_id`; cite it, or reread it with `GET /v1/sec/versions/{version_id}`). Select by `blocks`, physical `pages` or an exact `printed` label (a repeated label is `ambiguous` with every candidate until `printed_occurrence` picks one). Blocks carry `citation` (version, block, physical page, printed label), section paths, tables with composed headers / unit / scale, footnote links. `source.url` is the original\'s permanent public URL. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for rag: STANDARD.
|
|
117
|
+
|
|
118
|
+
### Example
|
|
119
|
+
|
|
120
|
+
```ts
|
|
121
|
+
import {
|
|
122
|
+
Configuration,
|
|
123
|
+
SECApi,
|
|
124
|
+
} from '@invinite-org/data-api-client';
|
|
125
|
+
import type { SecDocumentRequest } from '@invinite-org/data-api-client';
|
|
126
|
+
|
|
127
|
+
async function example() {
|
|
128
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
129
|
+
const config = new Configuration({
|
|
130
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
131
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
132
|
+
});
|
|
133
|
+
const api = new SECApi(config);
|
|
134
|
+
|
|
135
|
+
const body = {
|
|
136
|
+
// string | Accession number, dashed (0000320193-26-000026) or 18 digits
|
|
137
|
+
accession: 0000320193-26-000026,
|
|
138
|
+
// string | The document\'s file name in the filing (a manifest\'s `filename`)
|
|
139
|
+
filename: aapl-20260926.htm,
|
|
140
|
+
// string | A block id or range (`b00107` or `b00107-b00244`; a section\'s `blocks` selector) (optional)
|
|
141
|
+
blocks: b00107-b00244,
|
|
142
|
+
// string | Physical page ordinals (`3` or `3-5`) (optional)
|
|
143
|
+
pages: 1-3,
|
|
144
|
+
// string | An exact printed page label (`F-7`, `iv`, `12`): compared as the string printed, never as a number (optional)
|
|
145
|
+
printed: 17,
|
|
146
|
+
// number | Which page carrying a repeated printed label (1-based, page order) (optional)
|
|
147
|
+
printedOccurrence: 1,
|
|
148
|
+
// number | Widen the selection by this many blocks on each side (same version) (optional)
|
|
149
|
+
neighbors: 1,
|
|
150
|
+
// 'true' | 'false' | Add the footnote blocks the selection links to (same version) (`true` or `false`) (optional)
|
|
151
|
+
footnotes: true,
|
|
152
|
+
// number | At most this many blocks (1-1000); the answer names the next block when cut (optional)
|
|
153
|
+
limit: 5,
|
|
154
|
+
} satisfies SecDocumentRequest;
|
|
155
|
+
|
|
156
|
+
try {
|
|
157
|
+
const data = await api.secDocument(body);
|
|
158
|
+
console.log(data);
|
|
159
|
+
} catch (error) {
|
|
160
|
+
console.error(error);
|
|
161
|
+
}
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
// Run the test
|
|
165
|
+
example().catch(console.error);
|
|
166
|
+
```
|
|
167
|
+
|
|
168
|
+
### Parameters
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
| Name | Type | Description | Notes |
|
|
172
|
+
|------------- | ------------- | ------------- | -------------|
|
|
173
|
+
| **accession** | `string` | Accession number, dashed (0000320193-26-000026) or 18 digits | [Defaults to `undefined`] |
|
|
174
|
+
| **filename** | `string` | The document\'s file name in the filing (a manifest\'s `filename`) | [Defaults to `undefined`] |
|
|
175
|
+
| **blocks** | `string` | A block id or range (`b00107` or `b00107-b00244`; a section\'s `blocks` selector) | [Optional] [Defaults to `undefined`] |
|
|
176
|
+
| **pages** | `string` | Physical page ordinals (`3` or `3-5`) | [Optional] [Defaults to `undefined`] |
|
|
177
|
+
| **printed** | `string` | An exact printed page label (`F-7`, `iv`, `12`): compared as the string printed, never as a number | [Optional] [Defaults to `undefined`] |
|
|
178
|
+
| **printedOccurrence** | `number` | Which page carrying a repeated printed label (1-based, page order) | [Optional] [Defaults to `undefined`] |
|
|
179
|
+
| **neighbors** | `number` | Widen the selection by this many blocks on each side (same version) | [Optional] [Defaults to `undefined`] |
|
|
180
|
+
| **footnotes** | `true`, `false` | Add the footnote blocks the selection links to (same version) (`true` or `false`) | [Optional] [Defaults to `undefined`] [Enum: true, false] |
|
|
181
|
+
| **limit** | `number` | At most this many blocks (1-1000); the answer names the next block when cut | [Optional] [Defaults to `undefined`] |
|
|
182
|
+
|
|
183
|
+
### Return type
|
|
184
|
+
|
|
185
|
+
[**SecDocument200Response**](SecDocument200Response.md)
|
|
186
|
+
|
|
187
|
+
### Authorization
|
|
188
|
+
|
|
189
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
190
|
+
|
|
191
|
+
### HTTP request headers
|
|
192
|
+
|
|
193
|
+
- **Content-Type**: Not defined
|
|
194
|
+
- **Accept**: `application/json`
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
### HTTP response details
|
|
198
|
+
| Status code | Description | Response headers |
|
|
199
|
+
|-------------|-------------|------------------|
|
|
200
|
+
| **200** | One pinned document version (selected blocks) | - |
|
|
201
|
+
| **202** | One pinned document version (selected blocks) | - |
|
|
202
|
+
| **400** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
203
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
204
|
+
| **403** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
205
|
+
| **404** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
206
|
+
| **413** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
207
|
+
| **424** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
208
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
209
|
+
| **503** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
210
|
+
|
|
211
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
## secDocumentFactPlaces
|
|
215
|
+
|
|
216
|
+
> SecDocumentFactPlaces200Response secDocumentFactPlaces(versionId, factId, status, cursor, limit)
|
|
217
|
+
|
|
218
|
+
XBRL fact places in a document version
|
|
219
|
+
|
|
220
|
+
Where each XBRL fact of a pinned version sits: the original place (native id, block / table row / column), the annotated-rendition anchors and the PDF box as separate fields; a fact without a place keeps its typed status (`hidden`, `not_in_document`, `derived` with its operands, `unmatched`, `ambiguous`). Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
|
|
221
|
+
|
|
222
|
+
### Example
|
|
223
|
+
|
|
224
|
+
```ts
|
|
225
|
+
import {
|
|
226
|
+
Configuration,
|
|
227
|
+
SECApi,
|
|
228
|
+
} from '@invinite-org/data-api-client';
|
|
229
|
+
import type { SecDocumentFactPlacesRequest } from '@invinite-org/data-api-client';
|
|
230
|
+
|
|
231
|
+
async function example() {
|
|
232
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
233
|
+
const config = new Configuration({
|
|
234
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
235
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
236
|
+
});
|
|
237
|
+
const api = new SECApi(config);
|
|
238
|
+
|
|
239
|
+
const body = {
|
|
240
|
+
// string | An immutable document version (`version.version_id` of a document read, a search hit\'s citation)
|
|
241
|
+
versionId: 8be0b759-1a9d-5f89-8308-bd86185f5e1f,
|
|
242
|
+
// string | One fact id (optional)
|
|
243
|
+
factId: 320193|is_total_revenue|annual|2026|4,
|
|
244
|
+
// 'exact' | 'ambiguous' | 'hidden' | 'not_in_document' | 'derived' | 'unmatched' | Places of this status only (optional)
|
|
245
|
+
status: exact,
|
|
246
|
+
// string | Opaque cursor of the previous page (`next_cursor`; follow `next_url`). Bound to the other filters. (optional)
|
|
247
|
+
cursor: MTIz,
|
|
248
|
+
// number | Places per page (1-500, default 100) (optional)
|
|
249
|
+
limit: 5,
|
|
250
|
+
} satisfies SecDocumentFactPlacesRequest;
|
|
251
|
+
|
|
252
|
+
try {
|
|
253
|
+
const data = await api.secDocumentFactPlaces(body);
|
|
254
|
+
console.log(data);
|
|
255
|
+
} catch (error) {
|
|
256
|
+
console.error(error);
|
|
257
|
+
}
|
|
258
|
+
}
|
|
259
|
+
|
|
260
|
+
// Run the test
|
|
261
|
+
example().catch(console.error);
|
|
262
|
+
```
|
|
263
|
+
|
|
264
|
+
### Parameters
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
| Name | Type | Description | Notes |
|
|
268
|
+
|------------- | ------------- | ------------- | -------------|
|
|
269
|
+
| **versionId** | `string` | An immutable document version (`version.version_id` of a document read, a search hit\'s citation) | [Defaults to `undefined`] |
|
|
270
|
+
| **factId** | `string` | One fact id | [Optional] [Defaults to `undefined`] |
|
|
271
|
+
| **status** | `exact`, `ambiguous`, `hidden`, `not_in_document`, `derived`, `unmatched` | Places of this status only | [Optional] [Defaults to `undefined`] [Enum: exact, ambiguous, hidden, not_in_document, derived, unmatched] |
|
|
272
|
+
| **cursor** | `string` | Opaque cursor of the previous page (`next_cursor`; follow `next_url`). Bound to the other filters. | [Optional] [Defaults to `undefined`] |
|
|
273
|
+
| **limit** | `number` | Places per page (1-500, default 100) | [Optional] [Defaults to `100`] |
|
|
274
|
+
|
|
275
|
+
### Return type
|
|
276
|
+
|
|
277
|
+
[**SecDocumentFactPlaces200Response**](SecDocumentFactPlaces200Response.md)
|
|
278
|
+
|
|
279
|
+
### Authorization
|
|
280
|
+
|
|
281
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
282
|
+
|
|
283
|
+
### HTTP request headers
|
|
284
|
+
|
|
285
|
+
- **Content-Type**: Not defined
|
|
286
|
+
- **Accept**: `application/json`
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
### HTTP response details
|
|
290
|
+
| Status code | Description | Response headers |
|
|
291
|
+
|-------------|-------------|------------------|
|
|
292
|
+
| **200** | One page of fact places | - |
|
|
293
|
+
| **202** | One page of fact places | - |
|
|
294
|
+
| **400** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
295
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
296
|
+
| **403** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
297
|
+
| **404** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
298
|
+
| **409** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
299
|
+
| **424** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
300
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
301
|
+
| **503** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
302
|
+
|
|
303
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
## secDocumentFigure
|
|
307
|
+
|
|
308
|
+
> SecDocumentFigure200Response secDocumentFigure(versionId, blockId)
|
|
309
|
+
|
|
310
|
+
SEC document figure
|
|
311
|
+
|
|
312
|
+
One figure of a pinned version: its caption / alt text, citation and the permanent public URL of the image (`image.url`). Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
|
|
313
|
+
|
|
314
|
+
### Example
|
|
315
|
+
|
|
316
|
+
```ts
|
|
317
|
+
import {
|
|
318
|
+
Configuration,
|
|
319
|
+
SECApi,
|
|
320
|
+
} from '@invinite-org/data-api-client';
|
|
321
|
+
import type { SecDocumentFigureRequest } from '@invinite-org/data-api-client';
|
|
322
|
+
|
|
323
|
+
async function example() {
|
|
324
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
325
|
+
const config = new Configuration({
|
|
326
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
327
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
328
|
+
});
|
|
329
|
+
const api = new SECApi(config);
|
|
330
|
+
|
|
331
|
+
const body = {
|
|
332
|
+
// string | An immutable document version (`version.version_id` of a document read, a search hit\'s citation)
|
|
333
|
+
versionId: 8be0b759-1a9d-5f89-8308-bd86185f5e1f,
|
|
334
|
+
// string | The figure\'s block id (`b00042`)
|
|
335
|
+
blockId: b00107,
|
|
336
|
+
} satisfies SecDocumentFigureRequest;
|
|
337
|
+
|
|
338
|
+
try {
|
|
339
|
+
const data = await api.secDocumentFigure(body);
|
|
340
|
+
console.log(data);
|
|
341
|
+
} catch (error) {
|
|
342
|
+
console.error(error);
|
|
343
|
+
}
|
|
344
|
+
}
|
|
345
|
+
|
|
346
|
+
// Run the test
|
|
347
|
+
example().catch(console.error);
|
|
348
|
+
```
|
|
349
|
+
|
|
350
|
+
### Parameters
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
| Name | Type | Description | Notes |
|
|
354
|
+
|------------- | ------------- | ------------- | -------------|
|
|
355
|
+
| **versionId** | `string` | An immutable document version (`version.version_id` of a document read, a search hit\'s citation) | [Defaults to `undefined`] |
|
|
356
|
+
| **blockId** | `string` | The figure\'s block id (`b00042`) | [Defaults to `undefined`] |
|
|
357
|
+
|
|
358
|
+
### Return type
|
|
359
|
+
|
|
360
|
+
[**SecDocumentFigure200Response**](SecDocumentFigure200Response.md)
|
|
361
|
+
|
|
362
|
+
### Authorization
|
|
363
|
+
|
|
364
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
365
|
+
|
|
366
|
+
### HTTP request headers
|
|
367
|
+
|
|
368
|
+
- **Content-Type**: Not defined
|
|
369
|
+
- **Accept**: `application/json`
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
### HTTP response details
|
|
373
|
+
| Status code | Description | Response headers |
|
|
374
|
+
|-------------|-------------|------------------|
|
|
375
|
+
| **200** | One figure | - |
|
|
376
|
+
| **202** | One figure | - |
|
|
377
|
+
| **400** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
378
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
379
|
+
| **403** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
380
|
+
| **404** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
381
|
+
| **424** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
382
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
383
|
+
| **503** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
384
|
+
|
|
385
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
## secDocumentSections
|
|
389
|
+
|
|
390
|
+
> SecDocumentSections200Response secDocumentSections(versionId, outline)
|
|
391
|
+
|
|
392
|
+
Sections of an SEC document version
|
|
393
|
+
|
|
394
|
+
The section outline of a pinned version: `legacy` sections keep the legacy section ids (`legacy_section_key`, listed by `GET /v1/metadata/list-available-section-ids`, e.g. `part_i-item_1a`) where a proven correspondence exists, `generic` sections cover every other heading. Each section lists its block spans and `blocks` selectors: read a section with `GET /v1/sec/versions/{version_id}?blocks=<selector>`. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for rag: STANDARD.
|
|
395
|
+
|
|
396
|
+
### Example
|
|
397
|
+
|
|
398
|
+
```ts
|
|
399
|
+
import {
|
|
400
|
+
Configuration,
|
|
401
|
+
SECApi,
|
|
402
|
+
} from '@invinite-org/data-api-client';
|
|
403
|
+
import type { SecDocumentSectionsRequest } from '@invinite-org/data-api-client';
|
|
404
|
+
|
|
405
|
+
async function example() {
|
|
406
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
407
|
+
const config = new Configuration({
|
|
408
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
409
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
410
|
+
});
|
|
411
|
+
const api = new SECApi(config);
|
|
412
|
+
|
|
413
|
+
const body = {
|
|
414
|
+
// string | An immutable document version (`version.version_id` of a document read, a search hit\'s citation)
|
|
415
|
+
versionId: 8be0b759-1a9d-5f89-8308-bd86185f5e1f,
|
|
416
|
+
// 'legacy' | 'generic' | One outline only (optional)
|
|
417
|
+
outline: legacy,
|
|
418
|
+
} satisfies SecDocumentSectionsRequest;
|
|
419
|
+
|
|
420
|
+
try {
|
|
421
|
+
const data = await api.secDocumentSections(body);
|
|
422
|
+
console.log(data);
|
|
423
|
+
} catch (error) {
|
|
424
|
+
console.error(error);
|
|
425
|
+
}
|
|
426
|
+
}
|
|
427
|
+
|
|
428
|
+
// Run the test
|
|
429
|
+
example().catch(console.error);
|
|
430
|
+
```
|
|
431
|
+
|
|
432
|
+
### Parameters
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
| Name | Type | Description | Notes |
|
|
436
|
+
|------------- | ------------- | ------------- | -------------|
|
|
437
|
+
| **versionId** | `string` | An immutable document version (`version.version_id` of a document read, a search hit\'s citation) | [Defaults to `undefined`] |
|
|
438
|
+
| **outline** | `legacy`, `generic` | One outline only | [Optional] [Defaults to `undefined`] [Enum: legacy, generic] |
|
|
439
|
+
|
|
440
|
+
### Return type
|
|
441
|
+
|
|
442
|
+
[**SecDocumentSections200Response**](SecDocumentSections200Response.md)
|
|
443
|
+
|
|
444
|
+
### Authorization
|
|
445
|
+
|
|
446
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
447
|
+
|
|
448
|
+
### HTTP request headers
|
|
449
|
+
|
|
450
|
+
- **Content-Type**: Not defined
|
|
451
|
+
- **Accept**: `application/json`
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
### HTTP response details
|
|
455
|
+
| Status code | Description | Response headers |
|
|
456
|
+
|-------------|-------------|------------------|
|
|
457
|
+
| **200** | One version\'s section outline | - |
|
|
458
|
+
| **202** | One version\'s section outline | - |
|
|
459
|
+
| **400** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
460
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
461
|
+
| **403** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
462
|
+
| **404** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
463
|
+
| **424** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
464
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
465
|
+
| **503** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
466
|
+
|
|
467
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
## secDocumentVersion
|
|
471
|
+
|
|
472
|
+
> SecDocument200Response secDocumentVersion(versionId, blocks, pages, printed, printedOccurrence, neighbors, footnotes, limit)
|
|
473
|
+
|
|
474
|
+
SEC document version
|
|
475
|
+
|
|
476
|
+
One immutable document version by id (an old cited version stays readable): the same selectors and blocks as `GET /v1/sec/documents/{accession}/{filename}`, never mixed with a newer version. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for rag: STANDARD.
|
|
477
|
+
|
|
478
|
+
### Example
|
|
479
|
+
|
|
480
|
+
```ts
|
|
481
|
+
import {
|
|
482
|
+
Configuration,
|
|
483
|
+
SECApi,
|
|
484
|
+
} from '@invinite-org/data-api-client';
|
|
485
|
+
import type { SecDocumentVersionRequest } from '@invinite-org/data-api-client';
|
|
486
|
+
|
|
487
|
+
async function example() {
|
|
488
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
489
|
+
const config = new Configuration({
|
|
490
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
491
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
492
|
+
});
|
|
493
|
+
const api = new SECApi(config);
|
|
494
|
+
|
|
495
|
+
const body = {
|
|
496
|
+
// string | An immutable document version (`version.version_id` of a document read, a search hit\'s citation)
|
|
497
|
+
versionId: 8be0b759-1a9d-5f89-8308-bd86185f5e1f,
|
|
498
|
+
// string | A block id or range (`b00107` or `b00107-b00244`; a section\'s `blocks` selector) (optional)
|
|
499
|
+
blocks: b00107-b00244,
|
|
500
|
+
// string | Physical page ordinals (`3` or `3-5`) (optional)
|
|
501
|
+
pages: 1-3,
|
|
502
|
+
// string | An exact printed page label (`F-7`, `iv`, `12`): compared as the string printed, never as a number (optional)
|
|
503
|
+
printed: 17,
|
|
504
|
+
// number | Which page carrying a repeated printed label (1-based, page order) (optional)
|
|
505
|
+
printedOccurrence: 1,
|
|
506
|
+
// number | Widen the selection by this many blocks on each side (same version) (optional)
|
|
507
|
+
neighbors: 1,
|
|
508
|
+
// 'true' | 'false' | Add the footnote blocks the selection links to (same version) (`true` or `false`) (optional)
|
|
509
|
+
footnotes: true,
|
|
510
|
+
// number | At most this many blocks (1-1000); the answer names the next block when cut (optional)
|
|
511
|
+
limit: 5,
|
|
512
|
+
} satisfies SecDocumentVersionRequest;
|
|
513
|
+
|
|
514
|
+
try {
|
|
515
|
+
const data = await api.secDocumentVersion(body);
|
|
516
|
+
console.log(data);
|
|
517
|
+
} catch (error) {
|
|
518
|
+
console.error(error);
|
|
519
|
+
}
|
|
520
|
+
}
|
|
521
|
+
|
|
522
|
+
// Run the test
|
|
523
|
+
example().catch(console.error);
|
|
524
|
+
```
|
|
525
|
+
|
|
526
|
+
### Parameters
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
| Name | Type | Description | Notes |
|
|
530
|
+
|------------- | ------------- | ------------- | -------------|
|
|
531
|
+
| **versionId** | `string` | An immutable document version (`version.version_id` of a document read, a search hit\'s citation) | [Defaults to `undefined`] |
|
|
532
|
+
| **blocks** | `string` | A block id or range (`b00107` or `b00107-b00244`; a section\'s `blocks` selector) | [Optional] [Defaults to `undefined`] |
|
|
533
|
+
| **pages** | `string` | Physical page ordinals (`3` or `3-5`) | [Optional] [Defaults to `undefined`] |
|
|
534
|
+
| **printed** | `string` | An exact printed page label (`F-7`, `iv`, `12`): compared as the string printed, never as a number | [Optional] [Defaults to `undefined`] |
|
|
535
|
+
| **printedOccurrence** | `number` | Which page carrying a repeated printed label (1-based, page order) | [Optional] [Defaults to `undefined`] |
|
|
536
|
+
| **neighbors** | `number` | Widen the selection by this many blocks on each side (same version) | [Optional] [Defaults to `undefined`] |
|
|
537
|
+
| **footnotes** | `true`, `false` | Add the footnote blocks the selection links to (same version) (`true` or `false`) | [Optional] [Defaults to `undefined`] [Enum: true, false] |
|
|
538
|
+
| **limit** | `number` | At most this many blocks (1-1000); the answer names the next block when cut | [Optional] [Defaults to `undefined`] |
|
|
539
|
+
|
|
540
|
+
### Return type
|
|
541
|
+
|
|
542
|
+
[**SecDocument200Response**](SecDocument200Response.md)
|
|
543
|
+
|
|
544
|
+
### Authorization
|
|
545
|
+
|
|
546
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
547
|
+
|
|
548
|
+
### HTTP request headers
|
|
549
|
+
|
|
550
|
+
- **Content-Type**: Not defined
|
|
551
|
+
- **Accept**: `application/json`
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
### HTTP response details
|
|
555
|
+
| Status code | Description | Response headers |
|
|
556
|
+
|-------------|-------------|------------------|
|
|
557
|
+
| **200** | One pinned document version (selected blocks) | - |
|
|
558
|
+
| **202** | One pinned document version (selected blocks) | - |
|
|
559
|
+
| **400** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
560
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
561
|
+
| **403** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
562
|
+
| **404** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
563
|
+
| **413** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
564
|
+
| **424** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
565
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
566
|
+
| **503** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
567
|
+
|
|
568
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
## secExport
|
|
572
|
+
|
|
573
|
+
> SecFinancialsCatalog200Response secExport(exportId)
|
|
574
|
+
|
|
575
|
+
Metric export manifest
|
|
576
|
+
|
|
577
|
+
One export\'s manifest (immutable): rows, bytes, SHA-256, schema, coverage, rule lineage and the `download` route. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
|
|
578
|
+
|
|
579
|
+
### Example
|
|
580
|
+
|
|
581
|
+
```ts
|
|
582
|
+
import {
|
|
583
|
+
Configuration,
|
|
584
|
+
SECApi,
|
|
585
|
+
} from '@invinite-org/data-api-client';
|
|
586
|
+
import type { SecExportRequest } from '@invinite-org/data-api-client';
|
|
587
|
+
|
|
588
|
+
async function example() {
|
|
589
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
590
|
+
const config = new Configuration({
|
|
591
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
592
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
593
|
+
});
|
|
594
|
+
const api = new SECApi(config);
|
|
595
|
+
|
|
596
|
+
const body = {
|
|
597
|
+
// string | Export id
|
|
598
|
+
exportId: 6a7350b9-df18-517b-b553-96601b1e0508,
|
|
599
|
+
} satisfies SecExportRequest;
|
|
600
|
+
|
|
601
|
+
try {
|
|
602
|
+
const data = await api.secExport(body);
|
|
603
|
+
console.log(data);
|
|
604
|
+
} catch (error) {
|
|
605
|
+
console.error(error);
|
|
606
|
+
}
|
|
607
|
+
}
|
|
608
|
+
|
|
609
|
+
// Run the test
|
|
610
|
+
example().catch(console.error);
|
|
611
|
+
```
|
|
612
|
+
|
|
613
|
+
### Parameters
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
| Name | Type | Description | Notes |
|
|
617
|
+
|------------- | ------------- | ------------- | -------------|
|
|
618
|
+
| **exportId** | `string` | Export id | [Defaults to `undefined`] |
|
|
619
|
+
|
|
620
|
+
### Return type
|
|
621
|
+
|
|
622
|
+
[**SecFinancialsCatalog200Response**](SecFinancialsCatalog200Response.md)
|
|
623
|
+
|
|
624
|
+
### Authorization
|
|
625
|
+
|
|
626
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
627
|
+
|
|
628
|
+
### HTTP request headers
|
|
629
|
+
|
|
630
|
+
- **Content-Type**: Not defined
|
|
631
|
+
- **Accept**: `application/json`
|
|
632
|
+
|
|
633
|
+
|
|
634
|
+
### HTTP response details
|
|
635
|
+
| Status code | Description | Response headers |
|
|
636
|
+
|-------------|-------------|------------------|
|
|
637
|
+
| **200** | One export\'s manifest | - |
|
|
638
|
+
| **202** | One export\'s manifest | - |
|
|
639
|
+
| **400** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
640
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
641
|
+
| **403** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
642
|
+
| **404** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
643
|
+
| **424** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
644
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
645
|
+
| **503** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
646
|
+
|
|
647
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
## secExportFile
|
|
651
|
+
|
|
652
|
+
> Blob secExportFile(exportId)
|
|
653
|
+
|
|
654
|
+
Download a metric export
|
|
655
|
+
|
|
656
|
+
The export file itself: gzip-compressed CSV, verified against its SHA-256 before the first byte (`X-Content-SHA256`), `Content-Disposition` names the file. The one byte stream of the family (exports live in a private bucket); billed once per download. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
|
|
657
|
+
|
|
658
|
+
### Example
|
|
659
|
+
|
|
660
|
+
```ts
|
|
661
|
+
import {
|
|
662
|
+
Configuration,
|
|
663
|
+
SECApi,
|
|
664
|
+
} from '@invinite-org/data-api-client';
|
|
665
|
+
import type { SecExportFileRequest } from '@invinite-org/data-api-client';
|
|
666
|
+
|
|
667
|
+
async function example() {
|
|
668
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
669
|
+
const config = new Configuration({
|
|
670
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
671
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
672
|
+
});
|
|
673
|
+
const api = new SECApi(config);
|
|
674
|
+
|
|
675
|
+
const body = {
|
|
676
|
+
// string | Export id
|
|
677
|
+
exportId: 6a7350b9-df18-517b-b553-96601b1e0508,
|
|
678
|
+
} satisfies SecExportFileRequest;
|
|
679
|
+
|
|
680
|
+
try {
|
|
681
|
+
const data = await api.secExportFile(body);
|
|
682
|
+
console.log(data);
|
|
683
|
+
} catch (error) {
|
|
684
|
+
console.error(error);
|
|
685
|
+
}
|
|
686
|
+
}
|
|
687
|
+
|
|
688
|
+
// Run the test
|
|
689
|
+
example().catch(console.error);
|
|
690
|
+
```
|
|
691
|
+
|
|
692
|
+
### Parameters
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
| Name | Type | Description | Notes |
|
|
696
|
+
|------------- | ------------- | ------------- | -------------|
|
|
697
|
+
| **exportId** | `string` | Export id | [Defaults to `undefined`] |
|
|
698
|
+
|
|
699
|
+
### Return type
|
|
700
|
+
|
|
701
|
+
**Blob**
|
|
702
|
+
|
|
703
|
+
### Authorization
|
|
704
|
+
|
|
705
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
706
|
+
|
|
707
|
+
### HTTP request headers
|
|
708
|
+
|
|
709
|
+
- **Content-Type**: Not defined
|
|
710
|
+
- **Accept**: `application/gzip`, `application/json`
|
|
711
|
+
|
|
712
|
+
|
|
713
|
+
### HTTP response details
|
|
714
|
+
| Status code | Description | Response headers |
|
|
715
|
+
|-------------|-------------|------------------|
|
|
716
|
+
| **200** | The export file (application/gzip) | - |
|
|
717
|
+
| **400** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
718
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
719
|
+
| **403** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
720
|
+
| **404** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
721
|
+
| **413** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
722
|
+
| **424** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
723
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
724
|
+
| **503** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
725
|
+
|
|
726
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
727
|
+
|
|
728
|
+
|
|
729
|
+
## secExportsFinancialMetrics
|
|
730
|
+
|
|
731
|
+
> SecFinancialsCatalog200Response secExportsFinancialMetrics(metricId, fiscalYear, periodType, mode, generation)
|
|
732
|
+
|
|
733
|
+
Request an annual metric export
|
|
734
|
+
|
|
735
|
+
The universe-wide export of one standardized metric for one fiscal year (every covered company), as an immutable versioned file: `ready` with its manifest (rows, bytes, SHA-256, schema, coverage, source boundary, rule lineage) and the `download` route, else its state (`pending` while the current set has not published it). No forward-fill: a company without the value has no row. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
|
|
736
|
+
|
|
737
|
+
### Example
|
|
738
|
+
|
|
739
|
+
```ts
|
|
740
|
+
import {
|
|
741
|
+
Configuration,
|
|
742
|
+
SECApi,
|
|
743
|
+
} from '@invinite-org/data-api-client';
|
|
744
|
+
import type { SecExportsFinancialMetricsRequest } from '@invinite-org/data-api-client';
|
|
745
|
+
|
|
746
|
+
async function example() {
|
|
747
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
748
|
+
const config = new Configuration({
|
|
749
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
750
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
751
|
+
});
|
|
752
|
+
const api = new SECApi(config);
|
|
753
|
+
|
|
754
|
+
const body = {
|
|
755
|
+
// string | Standardized metric
|
|
756
|
+
metricId: is_total_revenue,
|
|
757
|
+
// number | Fiscal year
|
|
758
|
+
fiscalYear: 2025,
|
|
759
|
+
// 'quarterly' | 'annual' | 'ytd' | 'ttm' | Period type (default annual) (optional)
|
|
760
|
+
periodType: annual,
|
|
761
|
+
// 'standardized' | 'raw' | standardized (default) or raw values (optional)
|
|
762
|
+
mode: standardized,
|
|
763
|
+
// string | A past export generation (point in time) (optional)
|
|
764
|
+
generation: g20261104T031000Z-1a2b3c4d,
|
|
765
|
+
} satisfies SecExportsFinancialMetricsRequest;
|
|
766
|
+
|
|
767
|
+
try {
|
|
768
|
+
const data = await api.secExportsFinancialMetrics(body);
|
|
769
|
+
console.log(data);
|
|
770
|
+
} catch (error) {
|
|
771
|
+
console.error(error);
|
|
772
|
+
}
|
|
773
|
+
}
|
|
774
|
+
|
|
775
|
+
// Run the test
|
|
776
|
+
example().catch(console.error);
|
|
777
|
+
```
|
|
778
|
+
|
|
779
|
+
### Parameters
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
| Name | Type | Description | Notes |
|
|
783
|
+
|------------- | ------------- | ------------- | -------------|
|
|
784
|
+
| **metricId** | `string` | Standardized metric | [Defaults to `undefined`] |
|
|
785
|
+
| **fiscalYear** | `number` | Fiscal year | [Defaults to `undefined`] |
|
|
786
|
+
| **periodType** | `quarterly`, `annual`, `ytd`, `ttm` | Period type (default annual) | [Optional] [Defaults to `undefined`] [Enum: quarterly, annual, ytd, ttm] |
|
|
787
|
+
| **mode** | `standardized`, `raw` | standardized (default) or raw values | [Optional] [Defaults to `undefined`] [Enum: standardized, raw] |
|
|
788
|
+
| **generation** | `string` | A past export generation (point in time) | [Optional] [Defaults to `undefined`] |
|
|
789
|
+
|
|
790
|
+
### Return type
|
|
791
|
+
|
|
792
|
+
[**SecFinancialsCatalog200Response**](SecFinancialsCatalog200Response.md)
|
|
793
|
+
|
|
794
|
+
### Authorization
|
|
795
|
+
|
|
796
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
797
|
+
|
|
798
|
+
### HTTP request headers
|
|
799
|
+
|
|
800
|
+
- **Content-Type**: Not defined
|
|
801
|
+
- **Accept**: `application/json`
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
### HTTP response details
|
|
805
|
+
| Status code | Description | Response headers |
|
|
806
|
+
|-------------|-------------|------------------|
|
|
807
|
+
| **200** | The export\'s state and manifest | - |
|
|
808
|
+
| **202** | The export\'s state and manifest | - |
|
|
809
|
+
| **400** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
810
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
811
|
+
| **403** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
812
|
+
| **404** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
813
|
+
| **424** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
814
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
815
|
+
| **503** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
816
|
+
|
|
817
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
818
|
+
|
|
819
|
+
|
|
820
|
+
## secFiler
|
|
821
|
+
|
|
822
|
+
> SecFiler200Response secFiler(cik)
|
|
823
|
+
|
|
824
|
+
SEC filer
|
|
825
|
+
|
|
826
|
+
One filer: names (with former names and their dates), stated tickers / exchanges as SEC evidence, reviewed successors and what the store serves for it (`scope.permissions`). A pre-IPO issuer or SPAC has no stated ticker; its proposed symbols are on `GET /v1/sec/filers/{cik}/lifecycle`. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
|
|
827
|
+
|
|
828
|
+
### Example
|
|
829
|
+
|
|
830
|
+
```ts
|
|
831
|
+
import {
|
|
832
|
+
Configuration,
|
|
833
|
+
SECApi,
|
|
834
|
+
} from '@invinite-org/data-api-client';
|
|
835
|
+
import type { SecFilerRequest } from '@invinite-org/data-api-client';
|
|
836
|
+
|
|
837
|
+
async function example() {
|
|
838
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
839
|
+
const config = new Configuration({
|
|
840
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
841
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
842
|
+
});
|
|
843
|
+
const api = new SECApi(config);
|
|
844
|
+
|
|
845
|
+
const body = {
|
|
846
|
+
// string | SEC CIK of the filer (any zero padding)
|
|
847
|
+
cik: 320193,
|
|
848
|
+
} satisfies SecFilerRequest;
|
|
849
|
+
|
|
850
|
+
try {
|
|
851
|
+
const data = await api.secFiler(body);
|
|
852
|
+
console.log(data);
|
|
853
|
+
} catch (error) {
|
|
854
|
+
console.error(error);
|
|
855
|
+
}
|
|
856
|
+
}
|
|
857
|
+
|
|
858
|
+
// Run the test
|
|
859
|
+
example().catch(console.error);
|
|
860
|
+
```
|
|
861
|
+
|
|
862
|
+
### Parameters
|
|
863
|
+
|
|
864
|
+
|
|
865
|
+
| Name | Type | Description | Notes |
|
|
866
|
+
|------------- | ------------- | ------------- | -------------|
|
|
867
|
+
| **cik** | `string` | SEC CIK of the filer (any zero padding) | [Defaults to `undefined`] |
|
|
868
|
+
|
|
869
|
+
### Return type
|
|
870
|
+
|
|
871
|
+
[**SecFiler200Response**](SecFiler200Response.md)
|
|
872
|
+
|
|
873
|
+
### Authorization
|
|
874
|
+
|
|
875
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
876
|
+
|
|
877
|
+
### HTTP request headers
|
|
878
|
+
|
|
879
|
+
- **Content-Type**: Not defined
|
|
880
|
+
- **Accept**: `application/json`
|
|
881
|
+
|
|
882
|
+
|
|
883
|
+
### HTTP response details
|
|
884
|
+
| Status code | Description | Response headers |
|
|
885
|
+
|-------------|-------------|------------------|
|
|
886
|
+
| **200** | One filer | - |
|
|
887
|
+
| **202** | One filer | - |
|
|
888
|
+
| **400** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
889
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
890
|
+
| **403** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
891
|
+
| **404** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
892
|
+
| **424** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
893
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
894
|
+
| **503** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
895
|
+
|
|
896
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
897
|
+
|
|
898
|
+
|
|
899
|
+
## secFilerCoverage
|
|
900
|
+
|
|
901
|
+
> SecFilerCoverage200Response secFilerCoverage(cik, since)
|
|
902
|
+
|
|
903
|
+
SEC filer document coverage
|
|
904
|
+
|
|
905
|
+
How much of one filer\'s document history the store holds: `held_through` (the contiguous bound — the day before the oldest required document not yet held), required / held / pending counts and the holes, for a window back from `since` (default 365 days, at most 3 years). Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
|
|
906
|
+
|
|
907
|
+
### Example
|
|
908
|
+
|
|
909
|
+
```ts
|
|
910
|
+
import {
|
|
911
|
+
Configuration,
|
|
912
|
+
SECApi,
|
|
913
|
+
} from '@invinite-org/data-api-client';
|
|
914
|
+
import type { SecFilerCoverageRequest } from '@invinite-org/data-api-client';
|
|
915
|
+
|
|
916
|
+
async function example() {
|
|
917
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
918
|
+
const config = new Configuration({
|
|
919
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
920
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
921
|
+
});
|
|
922
|
+
const api = new SECApi(config);
|
|
923
|
+
|
|
924
|
+
const body = {
|
|
925
|
+
// string | SEC CIK of the filer (any zero padding)
|
|
926
|
+
cik: 320193,
|
|
927
|
+
// Date | First filing day of the window (YYYY-MM-DD, at most 3 years back) (optional)
|
|
928
|
+
since: 2025-11-01,
|
|
929
|
+
} satisfies SecFilerCoverageRequest;
|
|
930
|
+
|
|
931
|
+
try {
|
|
932
|
+
const data = await api.secFilerCoverage(body);
|
|
933
|
+
console.log(data);
|
|
934
|
+
} catch (error) {
|
|
935
|
+
console.error(error);
|
|
936
|
+
}
|
|
937
|
+
}
|
|
938
|
+
|
|
939
|
+
// Run the test
|
|
940
|
+
example().catch(console.error);
|
|
941
|
+
```
|
|
942
|
+
|
|
943
|
+
### Parameters
|
|
944
|
+
|
|
945
|
+
|
|
946
|
+
| Name | Type | Description | Notes |
|
|
947
|
+
|------------- | ------------- | ------------- | -------------|
|
|
948
|
+
| **cik** | `string` | SEC CIK of the filer (any zero padding) | [Defaults to `undefined`] |
|
|
949
|
+
| **since** | `Date` | First filing day of the window (YYYY-MM-DD, at most 3 years back) | [Optional] [Defaults to `undefined`] |
|
|
950
|
+
|
|
951
|
+
### Return type
|
|
952
|
+
|
|
953
|
+
[**SecFilerCoverage200Response**](SecFilerCoverage200Response.md)
|
|
954
|
+
|
|
955
|
+
### Authorization
|
|
956
|
+
|
|
957
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
958
|
+
|
|
959
|
+
### HTTP request headers
|
|
960
|
+
|
|
961
|
+
- **Content-Type**: Not defined
|
|
962
|
+
- **Accept**: `application/json`
|
|
963
|
+
|
|
964
|
+
|
|
965
|
+
### HTTP response details
|
|
966
|
+
| Status code | Description | Response headers |
|
|
967
|
+
|-------------|-------------|------------------|
|
|
968
|
+
| **200** | One filer\'s document coverage | - |
|
|
969
|
+
| **202** | One filer\'s document coverage | - |
|
|
970
|
+
| **400** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
971
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
972
|
+
| **403** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
973
|
+
| **404** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
974
|
+
| **424** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
975
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
976
|
+
| **503** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
977
|
+
|
|
978
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
979
|
+
|
|
980
|
+
|
|
981
|
+
## secFilerLifecycle
|
|
982
|
+
|
|
983
|
+
> SecFilerLifecycle200Response secFilerLifecycle(cik, traverse, maxHops)
|
|
984
|
+
|
|
985
|
+
SEC issuer lifecycle
|
|
986
|
+
|
|
987
|
+
One issuer\'s lifecycle: phase (pre-IPO, listed SPAC, listed operating, former listed), registration tracks with their proposed symbols (`symbol_authority: proposed_only`), the verified listing, successions (followed only on request, `traverse`) and separate readiness per family (identity, lifecycle, listing, documents, financials, coverage). Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
|
|
988
|
+
|
|
989
|
+
### Example
|
|
990
|
+
|
|
991
|
+
```ts
|
|
992
|
+
import {
|
|
993
|
+
Configuration,
|
|
994
|
+
SECApi,
|
|
995
|
+
} from '@invinite-org/data-api-client';
|
|
996
|
+
import type { SecFilerLifecycleRequest } from '@invinite-org/data-api-client';
|
|
997
|
+
|
|
998
|
+
async function example() {
|
|
999
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
1000
|
+
const config = new Configuration({
|
|
1001
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1002
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1003
|
+
});
|
|
1004
|
+
const api = new SECApi(config);
|
|
1005
|
+
|
|
1006
|
+
const body = {
|
|
1007
|
+
// string | SEC CIK of the issuer (any zero padding)
|
|
1008
|
+
cik: 320193,
|
|
1009
|
+
// 'successors' | 'predecessors' | Follow verified legal successions in this direction (optional)
|
|
1010
|
+
traverse: successors,
|
|
1011
|
+
// number | At most this many successions (1-5, default 3) (optional)
|
|
1012
|
+
maxHops: 3,
|
|
1013
|
+
} satisfies SecFilerLifecycleRequest;
|
|
1014
|
+
|
|
1015
|
+
try {
|
|
1016
|
+
const data = await api.secFilerLifecycle(body);
|
|
1017
|
+
console.log(data);
|
|
1018
|
+
} catch (error) {
|
|
1019
|
+
console.error(error);
|
|
1020
|
+
}
|
|
1021
|
+
}
|
|
1022
|
+
|
|
1023
|
+
// Run the test
|
|
1024
|
+
example().catch(console.error);
|
|
1025
|
+
```
|
|
1026
|
+
|
|
1027
|
+
### Parameters
|
|
1028
|
+
|
|
1029
|
+
|
|
1030
|
+
| Name | Type | Description | Notes |
|
|
1031
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1032
|
+
| **cik** | `string` | SEC CIK of the issuer (any zero padding) | [Defaults to `undefined`] |
|
|
1033
|
+
| **traverse** | `successors`, `predecessors` | Follow verified legal successions in this direction | [Optional] [Defaults to `undefined`] [Enum: successors, predecessors] |
|
|
1034
|
+
| **maxHops** | `number` | At most this many successions (1-5, default 3) | [Optional] [Defaults to `undefined`] |
|
|
1035
|
+
|
|
1036
|
+
### Return type
|
|
1037
|
+
|
|
1038
|
+
[**SecFilerLifecycle200Response**](SecFilerLifecycle200Response.md)
|
|
1039
|
+
|
|
1040
|
+
### Authorization
|
|
1041
|
+
|
|
1042
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1043
|
+
|
|
1044
|
+
### HTTP request headers
|
|
1045
|
+
|
|
1046
|
+
- **Content-Type**: Not defined
|
|
1047
|
+
- **Accept**: `application/json`
|
|
1048
|
+
|
|
1049
|
+
|
|
1050
|
+
### HTTP response details
|
|
1051
|
+
| Status code | Description | Response headers |
|
|
1052
|
+
|-------------|-------------|------------------|
|
|
1053
|
+
| **200** | One issuer\'s lifecycle | - |
|
|
1054
|
+
| **202** | One issuer\'s lifecycle | - |
|
|
1055
|
+
| **400** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1056
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
1057
|
+
| **403** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1058
|
+
| **404** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1059
|
+
| **424** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1060
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
1061
|
+
| **503** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1062
|
+
|
|
1063
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1064
|
+
|
|
1065
|
+
|
|
1066
|
+
## secFilers
|
|
1067
|
+
|
|
1068
|
+
> SecFilers200Response secFilers(name, ticker, form, limit)
|
|
1069
|
+
|
|
1070
|
+
Find SEC filers
|
|
1071
|
+
|
|
1072
|
+
Find SEC filers by (former) name, stated ticker or a form they filed. A filer is any SEC party: an operating company, a pre-IPO issuer without a ticker, a fund manager filing 13F without an exchange. Tickers and exchanges are the SEC filing\'s statements (`ticker_authority: sec_statement_only`), never a listing. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
|
|
1073
|
+
|
|
1074
|
+
### Example
|
|
1075
|
+
|
|
1076
|
+
```ts
|
|
1077
|
+
import {
|
|
1078
|
+
Configuration,
|
|
1079
|
+
SECApi,
|
|
1080
|
+
} from '@invinite-org/data-api-client';
|
|
1081
|
+
import type { SecFilersRequest } from '@invinite-org/data-api-client';
|
|
1082
|
+
|
|
1083
|
+
async function example() {
|
|
1084
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
1085
|
+
const config = new Configuration({
|
|
1086
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1087
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1088
|
+
});
|
|
1089
|
+
const api = new SECApi(config);
|
|
1090
|
+
|
|
1091
|
+
const body = {
|
|
1092
|
+
// string | Name or former name (substring) (optional)
|
|
1093
|
+
name: Apple,
|
|
1094
|
+
// string | A ticker the filer stated to the SEC (optional)
|
|
1095
|
+
ticker: AAPL,
|
|
1096
|
+
// string | A form type the filer filed (exact, e.g. 13F-HR) (optional)
|
|
1097
|
+
form: 13F-HR,
|
|
1098
|
+
// number | Matches (1-50, default 20) (optional)
|
|
1099
|
+
limit: 5,
|
|
1100
|
+
} satisfies SecFilersRequest;
|
|
1101
|
+
|
|
1102
|
+
try {
|
|
1103
|
+
const data = await api.secFilers(body);
|
|
1104
|
+
console.log(data);
|
|
1105
|
+
} catch (error) {
|
|
1106
|
+
console.error(error);
|
|
1107
|
+
}
|
|
1108
|
+
}
|
|
1109
|
+
|
|
1110
|
+
// Run the test
|
|
1111
|
+
example().catch(console.error);
|
|
1112
|
+
```
|
|
1113
|
+
|
|
1114
|
+
### Parameters
|
|
1115
|
+
|
|
1116
|
+
|
|
1117
|
+
| Name | Type | Description | Notes |
|
|
1118
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1119
|
+
| **name** | `string` | Name or former name (substring) | [Optional] [Defaults to `undefined`] |
|
|
1120
|
+
| **ticker** | `string` | A ticker the filer stated to the SEC | [Optional] [Defaults to `undefined`] |
|
|
1121
|
+
| **form** | `string` | A form type the filer filed (exact, e.g. 13F-HR) | [Optional] [Defaults to `undefined`] |
|
|
1122
|
+
| **limit** | `number` | Matches (1-50, default 20) | [Optional] [Defaults to `20`] |
|
|
1123
|
+
|
|
1124
|
+
### Return type
|
|
1125
|
+
|
|
1126
|
+
[**SecFilers200Response**](SecFilers200Response.md)
|
|
1127
|
+
|
|
1128
|
+
### Authorization
|
|
1129
|
+
|
|
1130
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1131
|
+
|
|
1132
|
+
### HTTP request headers
|
|
1133
|
+
|
|
1134
|
+
- **Content-Type**: Not defined
|
|
1135
|
+
- **Accept**: `application/json`
|
|
1136
|
+
|
|
1137
|
+
|
|
1138
|
+
### HTTP response details
|
|
1139
|
+
| Status code | Description | Response headers |
|
|
1140
|
+
|-------------|-------------|------------------|
|
|
1141
|
+
| **200** | Filers matching the filters, name order | - |
|
|
1142
|
+
| **202** | Filers matching the filters, name order | - |
|
|
1143
|
+
| **400** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1144
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
1145
|
+
| **403** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1146
|
+
| **404** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1147
|
+
| **424** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1148
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
1149
|
+
| **503** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1150
|
+
|
|
1151
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1152
|
+
|
|
1153
|
+
|
|
1154
|
+
## secFiling
|
|
1155
|
+
|
|
1156
|
+
> SecFiling200Response secFiling(accession)
|
|
1157
|
+
|
|
1158
|
+
SEC filing and its documents
|
|
1159
|
+
|
|
1160
|
+
One filing with its document manifest: every document with its role, MIME type, true (uncompressed) size, stored size, readiness and the permanent public URL of the original (`source.url`), the current canonical version id per document, the parties and typed relations. A 13F information table names its structured route (`/holdings`) instead of a body URL. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
|
|
1161
|
+
|
|
1162
|
+
### Example
|
|
1163
|
+
|
|
1164
|
+
```ts
|
|
1165
|
+
import {
|
|
1166
|
+
Configuration,
|
|
1167
|
+
SECApi,
|
|
1168
|
+
} from '@invinite-org/data-api-client';
|
|
1169
|
+
import type { SecFilingRequest } from '@invinite-org/data-api-client';
|
|
1170
|
+
|
|
1171
|
+
async function example() {
|
|
1172
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
1173
|
+
const config = new Configuration({
|
|
1174
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1175
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1176
|
+
});
|
|
1177
|
+
const api = new SECApi(config);
|
|
1178
|
+
|
|
1179
|
+
const body = {
|
|
1180
|
+
// string | Accession number, dashed (0000320193-26-000026) or 18 digits
|
|
1181
|
+
accession: 0000320193-26-000026,
|
|
1182
|
+
} satisfies SecFilingRequest;
|
|
1183
|
+
|
|
1184
|
+
try {
|
|
1185
|
+
const data = await api.secFiling(body);
|
|
1186
|
+
console.log(data);
|
|
1187
|
+
} catch (error) {
|
|
1188
|
+
console.error(error);
|
|
1189
|
+
}
|
|
1190
|
+
}
|
|
1191
|
+
|
|
1192
|
+
// Run the test
|
|
1193
|
+
example().catch(console.error);
|
|
1194
|
+
```
|
|
1195
|
+
|
|
1196
|
+
### Parameters
|
|
1197
|
+
|
|
1198
|
+
|
|
1199
|
+
| Name | Type | Description | Notes |
|
|
1200
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1201
|
+
| **accession** | `string` | Accession number, dashed (0000320193-26-000026) or 18 digits | [Defaults to `undefined`] |
|
|
1202
|
+
|
|
1203
|
+
### Return type
|
|
1204
|
+
|
|
1205
|
+
[**SecFiling200Response**](SecFiling200Response.md)
|
|
1206
|
+
|
|
1207
|
+
### Authorization
|
|
1208
|
+
|
|
1209
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1210
|
+
|
|
1211
|
+
### HTTP request headers
|
|
1212
|
+
|
|
1213
|
+
- **Content-Type**: Not defined
|
|
1214
|
+
- **Accept**: `application/json`
|
|
1215
|
+
|
|
1216
|
+
|
|
1217
|
+
### HTTP response details
|
|
1218
|
+
| Status code | Description | Response headers |
|
|
1219
|
+
|-------------|-------------|------------------|
|
|
1220
|
+
| **200** | One filing\'s document manifest | - |
|
|
1221
|
+
| **202** | One filing\'s document manifest | - |
|
|
1222
|
+
| **400** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1223
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
1224
|
+
| **403** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1225
|
+
| **404** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1226
|
+
| **424** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1227
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
1228
|
+
| **503** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1229
|
+
|
|
1230
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1231
|
+
|
|
1232
|
+
|
|
1233
|
+
## secFilingFacts
|
|
1234
|
+
|
|
1235
|
+
> SecFilingFacts200Response secFilingFacts(accession, tag)
|
|
1236
|
+
|
|
1237
|
+
SEC dataset facts of a filing
|
|
1238
|
+
|
|
1239
|
+
The XBRL facts SEC\'s own datasets (Financial Statement and Notes) publish for one filing, as released (`release`: dataset, period, hash), exact decimal strings. Raw source rows — the standardized statements are `GET /v1/sec/financials/{cik}/statements/{statement}`. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
|
|
1240
|
+
|
|
1241
|
+
### Example
|
|
1242
|
+
|
|
1243
|
+
```ts
|
|
1244
|
+
import {
|
|
1245
|
+
Configuration,
|
|
1246
|
+
SECApi,
|
|
1247
|
+
} from '@invinite-org/data-api-client';
|
|
1248
|
+
import type { SecFilingFactsRequest } from '@invinite-org/data-api-client';
|
|
1249
|
+
|
|
1250
|
+
async function example() {
|
|
1251
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
1252
|
+
const config = new Configuration({
|
|
1253
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1254
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1255
|
+
});
|
|
1256
|
+
const api = new SECApi(config);
|
|
1257
|
+
|
|
1258
|
+
const body = {
|
|
1259
|
+
// string | Accession number, dashed (0000320193-26-000026) or 18 digits
|
|
1260
|
+
accession: 0000320193-26-000026,
|
|
1261
|
+
// string | One XBRL tag (e.g. Revenues) (optional)
|
|
1262
|
+
tag: Revenues,
|
|
1263
|
+
} satisfies SecFilingFactsRequest;
|
|
1264
|
+
|
|
1265
|
+
try {
|
|
1266
|
+
const data = await api.secFilingFacts(body);
|
|
1267
|
+
console.log(data);
|
|
1268
|
+
} catch (error) {
|
|
1269
|
+
console.error(error);
|
|
1270
|
+
}
|
|
1271
|
+
}
|
|
1272
|
+
|
|
1273
|
+
// Run the test
|
|
1274
|
+
example().catch(console.error);
|
|
1275
|
+
```
|
|
1276
|
+
|
|
1277
|
+
### Parameters
|
|
1278
|
+
|
|
1279
|
+
|
|
1280
|
+
| Name | Type | Description | Notes |
|
|
1281
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1282
|
+
| **accession** | `string` | Accession number, dashed (0000320193-26-000026) or 18 digits | [Defaults to `undefined`] |
|
|
1283
|
+
| **tag** | `string` | One XBRL tag (e.g. Revenues) | [Optional] [Defaults to `undefined`] |
|
|
1284
|
+
|
|
1285
|
+
### Return type
|
|
1286
|
+
|
|
1287
|
+
[**SecFilingFacts200Response**](SecFilingFacts200Response.md)
|
|
1288
|
+
|
|
1289
|
+
### Authorization
|
|
1290
|
+
|
|
1291
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1292
|
+
|
|
1293
|
+
### HTTP request headers
|
|
1294
|
+
|
|
1295
|
+
- **Content-Type**: Not defined
|
|
1296
|
+
- **Accept**: `application/json`
|
|
1297
|
+
|
|
1298
|
+
|
|
1299
|
+
### HTTP response details
|
|
1300
|
+
| Status code | Description | Response headers |
|
|
1301
|
+
|-------------|-------------|------------------|
|
|
1302
|
+
| **200** | Dataset facts of one filing | - |
|
|
1303
|
+
| **202** | Dataset facts of one filing | - |
|
|
1304
|
+
| **400** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1305
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
1306
|
+
| **403** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1307
|
+
| **404** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1308
|
+
| **424** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1309
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
1310
|
+
| **503** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1311
|
+
|
|
1312
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1313
|
+
|
|
1314
|
+
|
|
1315
|
+
## secFilingHoldings
|
|
1316
|
+
|
|
1317
|
+
> SecFilingHoldings200Response secFilingHoldings(accession, after, limit)
|
|
1318
|
+
|
|
1319
|
+
Holdings of a 13F filing
|
|
1320
|
+
|
|
1321
|
+
The information table of one 13F filing as SEC\'s 13F dataset released it, in pages (`summary` first: row count and value). Values are the manager-reported values (the 2023-01-03 dollar rule applied). Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
|
|
1322
|
+
|
|
1323
|
+
### Example
|
|
1324
|
+
|
|
1325
|
+
```ts
|
|
1326
|
+
import {
|
|
1327
|
+
Configuration,
|
|
1328
|
+
SECApi,
|
|
1329
|
+
} from '@invinite-org/data-api-client';
|
|
1330
|
+
import type { SecFilingHoldingsRequest } from '@invinite-org/data-api-client';
|
|
1331
|
+
|
|
1332
|
+
async function example() {
|
|
1333
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
1334
|
+
const config = new Configuration({
|
|
1335
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1336
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1337
|
+
});
|
|
1338
|
+
const api = new SECApi(config);
|
|
1339
|
+
|
|
1340
|
+
const body = {
|
|
1341
|
+
// string | Accession number, dashed (0000320193-26-000026) or 18 digits
|
|
1342
|
+
accession: 0000320193-26-000026,
|
|
1343
|
+
// number | Row key of the previous page (`next_after`; follow `next_url`) (optional)
|
|
1344
|
+
after: 0,
|
|
1345
|
+
// number | Positions per page (1-1000, default 500) (optional)
|
|
1346
|
+
limit: 5,
|
|
1347
|
+
} satisfies SecFilingHoldingsRequest;
|
|
1348
|
+
|
|
1349
|
+
try {
|
|
1350
|
+
const data = await api.secFilingHoldings(body);
|
|
1351
|
+
console.log(data);
|
|
1352
|
+
} catch (error) {
|
|
1353
|
+
console.error(error);
|
|
1354
|
+
}
|
|
1355
|
+
}
|
|
1356
|
+
|
|
1357
|
+
// Run the test
|
|
1358
|
+
example().catch(console.error);
|
|
1359
|
+
```
|
|
1360
|
+
|
|
1361
|
+
### Parameters
|
|
1362
|
+
|
|
1363
|
+
|
|
1364
|
+
| Name | Type | Description | Notes |
|
|
1365
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1366
|
+
| **accession** | `string` | Accession number, dashed (0000320193-26-000026) or 18 digits | [Defaults to `undefined`] |
|
|
1367
|
+
| **after** | `number` | Row key of the previous page (`next_after`; follow `next_url`) | [Optional] [Defaults to `undefined`] |
|
|
1368
|
+
| **limit** | `number` | Positions per page (1-1000, default 500) | [Optional] [Defaults to `500`] |
|
|
1369
|
+
|
|
1370
|
+
### Return type
|
|
1371
|
+
|
|
1372
|
+
[**SecFilingHoldings200Response**](SecFilingHoldings200Response.md)
|
|
1373
|
+
|
|
1374
|
+
### Authorization
|
|
1375
|
+
|
|
1376
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1377
|
+
|
|
1378
|
+
### HTTP request headers
|
|
1379
|
+
|
|
1380
|
+
- **Content-Type**: Not defined
|
|
1381
|
+
- **Accept**: `application/json`
|
|
1382
|
+
|
|
1383
|
+
|
|
1384
|
+
### HTTP response details
|
|
1385
|
+
| Status code | Description | Response headers |
|
|
1386
|
+
|-------------|-------------|------------------|
|
|
1387
|
+
| **200** | One page of a 13F information table | - |
|
|
1388
|
+
| **202** | One page of a 13F information table | - |
|
|
1389
|
+
| **400** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1390
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
1391
|
+
| **403** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1392
|
+
| **404** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1393
|
+
| **424** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1394
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
1395
|
+
| **503** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1396
|
+
|
|
1397
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1398
|
+
|
|
1399
|
+
|
|
1400
|
+
## secFilingNotes
|
|
1401
|
+
|
|
1402
|
+
> SecFilingFacts200Response secFilingNotes(accession, tag)
|
|
1403
|
+
|
|
1404
|
+
SEC dataset text notes of a filing
|
|
1405
|
+
|
|
1406
|
+
The text facts (notes, policies) SEC\'s Financial Statement and Notes dataset publishes for one filing, as released. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
|
|
1407
|
+
|
|
1408
|
+
### Example
|
|
1409
|
+
|
|
1410
|
+
```ts
|
|
1411
|
+
import {
|
|
1412
|
+
Configuration,
|
|
1413
|
+
SECApi,
|
|
1414
|
+
} from '@invinite-org/data-api-client';
|
|
1415
|
+
import type { SecFilingNotesRequest } from '@invinite-org/data-api-client';
|
|
1416
|
+
|
|
1417
|
+
async function example() {
|
|
1418
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
1419
|
+
const config = new Configuration({
|
|
1420
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1421
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1422
|
+
});
|
|
1423
|
+
const api = new SECApi(config);
|
|
1424
|
+
|
|
1425
|
+
const body = {
|
|
1426
|
+
// string | Accession number, dashed (0000320193-26-000026) or 18 digits
|
|
1427
|
+
accession: 0000320193-26-000026,
|
|
1428
|
+
// string | One XBRL tag (optional)
|
|
1429
|
+
tag: Revenues,
|
|
1430
|
+
} satisfies SecFilingNotesRequest;
|
|
1431
|
+
|
|
1432
|
+
try {
|
|
1433
|
+
const data = await api.secFilingNotes(body);
|
|
1434
|
+
console.log(data);
|
|
1435
|
+
} catch (error) {
|
|
1436
|
+
console.error(error);
|
|
1437
|
+
}
|
|
1438
|
+
}
|
|
1439
|
+
|
|
1440
|
+
// Run the test
|
|
1441
|
+
example().catch(console.error);
|
|
1442
|
+
```
|
|
1443
|
+
|
|
1444
|
+
### Parameters
|
|
1445
|
+
|
|
1446
|
+
|
|
1447
|
+
| Name | Type | Description | Notes |
|
|
1448
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1449
|
+
| **accession** | `string` | Accession number, dashed (0000320193-26-000026) or 18 digits | [Defaults to `undefined`] |
|
|
1450
|
+
| **tag** | `string` | One XBRL tag | [Optional] [Defaults to `undefined`] |
|
|
1451
|
+
|
|
1452
|
+
### Return type
|
|
1453
|
+
|
|
1454
|
+
[**SecFilingFacts200Response**](SecFilingFacts200Response.md)
|
|
1455
|
+
|
|
1456
|
+
### Authorization
|
|
1457
|
+
|
|
1458
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1459
|
+
|
|
1460
|
+
### HTTP request headers
|
|
1461
|
+
|
|
1462
|
+
- **Content-Type**: Not defined
|
|
1463
|
+
- **Accept**: `application/json`
|
|
1464
|
+
|
|
1465
|
+
|
|
1466
|
+
### HTTP response details
|
|
1467
|
+
| Status code | Description | Response headers |
|
|
1468
|
+
|-------------|-------------|------------------|
|
|
1469
|
+
| **200** | Dataset text facts of one filing | - |
|
|
1470
|
+
| **202** | Dataset text facts of one filing | - |
|
|
1471
|
+
| **400** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1472
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
1473
|
+
| **403** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1474
|
+
| **404** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1475
|
+
| **424** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1476
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
1477
|
+
| **503** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1478
|
+
|
|
1479
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1480
|
+
|
|
1481
|
+
|
|
1482
|
+
## secFilingReviewChain
|
|
1483
|
+
|
|
1484
|
+
> SecFilingReviewChain200Response secFilingReviewChain(accession, maxDepth, maxNodes)
|
|
1485
|
+
|
|
1486
|
+
SEC review chain of a filing
|
|
1487
|
+
|
|
1488
|
+
The bounded SEC review graph around one filing: letters and responses (nodes, with whether the store holds them), confirmed edges (unconfirmed ones listed, never followed), text / PDF twins and what the graph cannot claim (`completeness`). Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
|
|
1489
|
+
|
|
1490
|
+
### Example
|
|
1491
|
+
|
|
1492
|
+
```ts
|
|
1493
|
+
import {
|
|
1494
|
+
Configuration,
|
|
1495
|
+
SECApi,
|
|
1496
|
+
} from '@invinite-org/data-api-client';
|
|
1497
|
+
import type { SecFilingReviewChainRequest } from '@invinite-org/data-api-client';
|
|
1498
|
+
|
|
1499
|
+
async function example() {
|
|
1500
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
1501
|
+
const config = new Configuration({
|
|
1502
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1503
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1504
|
+
});
|
|
1505
|
+
const api = new SECApi(config);
|
|
1506
|
+
|
|
1507
|
+
const body = {
|
|
1508
|
+
// string | Accession number, dashed (0000320193-26-000026) or 18 digits
|
|
1509
|
+
accession: 0000320193-26-000026,
|
|
1510
|
+
// number | Hops from the filing (1-6, default 3) (optional)
|
|
1511
|
+
maxDepth: 3,
|
|
1512
|
+
// number | Nodes at most (1-100, default 25) (optional)
|
|
1513
|
+
maxNodes: 25,
|
|
1514
|
+
} satisfies SecFilingReviewChainRequest;
|
|
1515
|
+
|
|
1516
|
+
try {
|
|
1517
|
+
const data = await api.secFilingReviewChain(body);
|
|
1518
|
+
console.log(data);
|
|
1519
|
+
} catch (error) {
|
|
1520
|
+
console.error(error);
|
|
1521
|
+
}
|
|
1522
|
+
}
|
|
1523
|
+
|
|
1524
|
+
// Run the test
|
|
1525
|
+
example().catch(console.error);
|
|
1526
|
+
```
|
|
1527
|
+
|
|
1528
|
+
### Parameters
|
|
1529
|
+
|
|
1530
|
+
|
|
1531
|
+
| Name | Type | Description | Notes |
|
|
1532
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1533
|
+
| **accession** | `string` | Accession number, dashed (0000320193-26-000026) or 18 digits | [Defaults to `undefined`] |
|
|
1534
|
+
| **maxDepth** | `number` | Hops from the filing (1-6, default 3) | [Optional] [Defaults to `undefined`] |
|
|
1535
|
+
| **maxNodes** | `number` | Nodes at most (1-100, default 25) | [Optional] [Defaults to `undefined`] |
|
|
1536
|
+
|
|
1537
|
+
### Return type
|
|
1538
|
+
|
|
1539
|
+
[**SecFilingReviewChain200Response**](SecFilingReviewChain200Response.md)
|
|
1540
|
+
|
|
1541
|
+
### Authorization
|
|
1542
|
+
|
|
1543
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1544
|
+
|
|
1545
|
+
### HTTP request headers
|
|
1546
|
+
|
|
1547
|
+
- **Content-Type**: Not defined
|
|
1548
|
+
- **Accept**: `application/json`
|
|
1549
|
+
|
|
1550
|
+
|
|
1551
|
+
### HTTP response details
|
|
1552
|
+
| Status code | Description | Response headers |
|
|
1553
|
+
|-------------|-------------|------------------|
|
|
1554
|
+
| **200** | One filing\'s review graph | - |
|
|
1555
|
+
| **202** | One filing\'s review graph | - |
|
|
1556
|
+
| **400** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1557
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
1558
|
+
| **403** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1559
|
+
| **404** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1560
|
+
| **424** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1561
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
1562
|
+
| **503** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1563
|
+
|
|
1564
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1565
|
+
|
|
1566
|
+
|
|
1567
|
+
## secFilingReviewRelations
|
|
1568
|
+
|
|
1569
|
+
> SecFilingReviewRelations200Response secFilingReviewRelations(accession, direction, kind, history, cursor, limit)
|
|
1570
|
+
|
|
1571
|
+
SEC review relations of a filing
|
|
1572
|
+
|
|
1573
|
+
The SEC comment-letter relations from or to one filing (UPLOAD / CORRESP letters, the filings they review, text / PDF twins), with their status, exact quotes and candidates. `history=true` adds superseded observations. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
|
|
1574
|
+
|
|
1575
|
+
### Example
|
|
1576
|
+
|
|
1577
|
+
```ts
|
|
1578
|
+
import {
|
|
1579
|
+
Configuration,
|
|
1580
|
+
SECApi,
|
|
1581
|
+
} from '@invinite-org/data-api-client';
|
|
1582
|
+
import type { SecFilingReviewRelationsRequest } from '@invinite-org/data-api-client';
|
|
1583
|
+
|
|
1584
|
+
async function example() {
|
|
1585
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
1586
|
+
const config = new Configuration({
|
|
1587
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1588
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1589
|
+
});
|
|
1590
|
+
const api = new SECApi(config);
|
|
1591
|
+
|
|
1592
|
+
const body = {
|
|
1593
|
+
// string | Accession number, dashed (0000320193-26-000026) or 18 digits
|
|
1594
|
+
accession: 0000320193-26-000026,
|
|
1595
|
+
// 'from' | 'to' | 'both' | Relations from, to or both (default both) (optional)
|
|
1596
|
+
direction: both,
|
|
1597
|
+
// 'text_twin_of' | 'responds_to' | 'reviews_filing' | 'continues_review' | One relation kind (optional)
|
|
1598
|
+
kind: responds_to,
|
|
1599
|
+
// 'true' | 'false' | Add superseded observations (`true` or `false`) (optional)
|
|
1600
|
+
history: false,
|
|
1601
|
+
// string | Opaque cursor of the previous page (`next_cursor`; follow `next_url`). Bound to the other filters. (optional)
|
|
1602
|
+
cursor: MTIz,
|
|
1603
|
+
// number | Relations per page (1-200, default 100) (optional)
|
|
1604
|
+
limit: 5,
|
|
1605
|
+
} satisfies SecFilingReviewRelationsRequest;
|
|
1606
|
+
|
|
1607
|
+
try {
|
|
1608
|
+
const data = await api.secFilingReviewRelations(body);
|
|
1609
|
+
console.log(data);
|
|
1610
|
+
} catch (error) {
|
|
1611
|
+
console.error(error);
|
|
1612
|
+
}
|
|
1613
|
+
}
|
|
1614
|
+
|
|
1615
|
+
// Run the test
|
|
1616
|
+
example().catch(console.error);
|
|
1617
|
+
```
|
|
1618
|
+
|
|
1619
|
+
### Parameters
|
|
1620
|
+
|
|
1621
|
+
|
|
1622
|
+
| Name | Type | Description | Notes |
|
|
1623
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1624
|
+
| **accession** | `string` | Accession number, dashed (0000320193-26-000026) or 18 digits | [Defaults to `undefined`] |
|
|
1625
|
+
| **direction** | `from`, `to`, `both` | Relations from, to or both (default both) | [Optional] [Defaults to `undefined`] [Enum: from, to, both] |
|
|
1626
|
+
| **kind** | `text_twin_of`, `responds_to`, `reviews_filing`, `continues_review` | One relation kind | [Optional] [Defaults to `undefined`] [Enum: text_twin_of, responds_to, reviews_filing, continues_review] |
|
|
1627
|
+
| **history** | `true`, `false` | Add superseded observations (`true` or `false`) | [Optional] [Defaults to `undefined`] [Enum: true, false] |
|
|
1628
|
+
| **cursor** | `string` | Opaque cursor of the previous page (`next_cursor`; follow `next_url`). Bound to the other filters. | [Optional] [Defaults to `undefined`] |
|
|
1629
|
+
| **limit** | `number` | Relations per page (1-200, default 100) | [Optional] [Defaults to `100`] |
|
|
1630
|
+
|
|
1631
|
+
### Return type
|
|
1632
|
+
|
|
1633
|
+
[**SecFilingReviewRelations200Response**](SecFilingReviewRelations200Response.md)
|
|
1634
|
+
|
|
1635
|
+
### Authorization
|
|
1636
|
+
|
|
1637
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1638
|
+
|
|
1639
|
+
### HTTP request headers
|
|
1640
|
+
|
|
1641
|
+
- **Content-Type**: Not defined
|
|
1642
|
+
- **Accept**: `application/json`
|
|
1643
|
+
|
|
1644
|
+
|
|
1645
|
+
### HTTP response details
|
|
1646
|
+
| Status code | Description | Response headers |
|
|
1647
|
+
|-------------|-------------|------------------|
|
|
1648
|
+
| **200** | One page of review relations | - |
|
|
1649
|
+
| **202** | One page of review relations | - |
|
|
1650
|
+
| **400** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1651
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
1652
|
+
| **403** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1653
|
+
| **404** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1654
|
+
| **409** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1655
|
+
| **424** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1656
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
1657
|
+
| **503** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1658
|
+
|
|
1659
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1660
|
+
|
|
1661
|
+
|
|
1662
|
+
## secFilings
|
|
1663
|
+
|
|
1664
|
+
> SecFilings200Response secFilings(identifier, form, filedFrom, filedTo, order, cursor, limit)
|
|
1665
|
+
|
|
1666
|
+
SEC filings of a filer
|
|
1667
|
+
|
|
1668
|
+
One filer\'s SEC filings, newest first: form, filing / report date, acceptance (null when SEC never stated it), 8-K items, primary document, the filer\'s roles. `identifier` is a ticker (a ticker the filer stated to the SEC) or a CIK — a CIK also finds a pre-IPO issuer or a fund manager without a ticker. `form_facet` lists every form the filer filed with its count (whatever the page\'s filters); OTC / ABS filings are never listed and are counted in `withheld`. Open a filing\'s documents with `GET /v1/sec/filings/{accession}`. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
|
|
1669
|
+
|
|
1670
|
+
### Example
|
|
1671
|
+
|
|
1672
|
+
```ts
|
|
1673
|
+
import {
|
|
1674
|
+
Configuration,
|
|
1675
|
+
SECApi,
|
|
1676
|
+
} from '@invinite-org/data-api-client';
|
|
1677
|
+
import type { SecFilingsRequest } from '@invinite-org/data-api-client';
|
|
1678
|
+
|
|
1679
|
+
async function example() {
|
|
1680
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
1681
|
+
const config = new Configuration({
|
|
1682
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1683
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1684
|
+
});
|
|
1685
|
+
const api = new SECApi(config);
|
|
1686
|
+
|
|
1687
|
+
const body = {
|
|
1688
|
+
// string | A ticker the filer stated to the SEC, or a CIK (a CIK also finds a pre-IPO issuer)
|
|
1689
|
+
identifier: AAPL,
|
|
1690
|
+
// string | Form types, a comma list (e.g. `10-K,10-K/A`) (optional)
|
|
1691
|
+
form: 10-K,10-K/A,
|
|
1692
|
+
// Date | First filing day (YYYY-MM-DD) (optional)
|
|
1693
|
+
filedFrom: 2025-01-01,
|
|
1694
|
+
// Date | Last filing day (YYYY-MM-DD) (optional)
|
|
1695
|
+
filedTo: 2026-11-05,
|
|
1696
|
+
// 'desc' | 'asc' | By filing date (default desc) (optional)
|
|
1697
|
+
order: desc,
|
|
1698
|
+
// string | Opaque cursor of the previous page (`next_cursor`; follow `next_url`). Bound to the other filters. (optional)
|
|
1699
|
+
cursor: eyJ2IjoxLCJhZnRlciI6WyIyMDI1LTEwLTMxIiwiMDAwMDMyMDE5My0yNS0wMDAwNzkiXSwiZiI6Ijg1NzNiMDg0ZjEyNzVjMjMifQ,
|
|
1700
|
+
// number | Filings per page (1-100, default 50) (optional)
|
|
1701
|
+
limit: 5,
|
|
1702
|
+
} satisfies SecFilingsRequest;
|
|
1703
|
+
|
|
1704
|
+
try {
|
|
1705
|
+
const data = await api.secFilings(body);
|
|
1706
|
+
console.log(data);
|
|
1707
|
+
} catch (error) {
|
|
1708
|
+
console.error(error);
|
|
1709
|
+
}
|
|
1710
|
+
}
|
|
1711
|
+
|
|
1712
|
+
// Run the test
|
|
1713
|
+
example().catch(console.error);
|
|
1714
|
+
```
|
|
1715
|
+
|
|
1716
|
+
### Parameters
|
|
1717
|
+
|
|
1718
|
+
|
|
1719
|
+
| Name | Type | Description | Notes |
|
|
1720
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1721
|
+
| **identifier** | `string` | A ticker the filer stated to the SEC, or a CIK (a CIK also finds a pre-IPO issuer) | [Defaults to `undefined`] |
|
|
1722
|
+
| **form** | `string` | Form types, a comma list (e.g. `10-K,10-K/A`) | [Optional] [Defaults to `undefined`] |
|
|
1723
|
+
| **filedFrom** | `Date` | First filing day (YYYY-MM-DD) | [Optional] [Defaults to `undefined`] |
|
|
1724
|
+
| **filedTo** | `Date` | Last filing day (YYYY-MM-DD) | [Optional] [Defaults to `undefined`] |
|
|
1725
|
+
| **order** | `desc`, `asc` | By filing date (default desc) | [Optional] [Defaults to `undefined`] [Enum: desc, asc] |
|
|
1726
|
+
| **cursor** | `string` | Opaque cursor of the previous page (`next_cursor`; follow `next_url`). Bound to the other filters. | [Optional] [Defaults to `undefined`] |
|
|
1727
|
+
| **limit** | `number` | Filings per page (1-100, default 50) | [Optional] [Defaults to `50`] |
|
|
1728
|
+
|
|
1729
|
+
### Return type
|
|
1730
|
+
|
|
1731
|
+
[**SecFilings200Response**](SecFilings200Response.md)
|
|
1732
|
+
|
|
1733
|
+
### Authorization
|
|
1734
|
+
|
|
1735
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1736
|
+
|
|
1737
|
+
### HTTP request headers
|
|
1738
|
+
|
|
1739
|
+
- **Content-Type**: Not defined
|
|
1740
|
+
- **Accept**: `application/json`
|
|
1741
|
+
|
|
1742
|
+
|
|
1743
|
+
### HTTP response details
|
|
1744
|
+
| Status code | Description | Response headers |
|
|
1745
|
+
|-------------|-------------|------------------|
|
|
1746
|
+
| **200** | One page of a filer\'s filings | - |
|
|
1747
|
+
| **202** | One page of a filer\'s filings | - |
|
|
1748
|
+
| **400** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1749
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
1750
|
+
| **403** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1751
|
+
| **404** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1752
|
+
| **409** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1753
|
+
| **424** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1754
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
1755
|
+
| **503** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1756
|
+
|
|
1757
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1758
|
+
|
|
1759
|
+
|
|
1760
|
+
## secFinancialsCatalog
|
|
1761
|
+
|
|
1762
|
+
> SecFinancialsCatalog200Response secFinancialsCatalog(statement, metricId)
|
|
1763
|
+
|
|
1764
|
+
Standardization rule catalog
|
|
1765
|
+
|
|
1766
|
+
The versioned rule catalog behind the standardized statements (`catalog_version`, rules per metric): which XBRL concepts and formulas produce each standardized metric. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
|
|
1767
|
+
|
|
1768
|
+
### Example
|
|
1769
|
+
|
|
1770
|
+
```ts
|
|
1771
|
+
import {
|
|
1772
|
+
Configuration,
|
|
1773
|
+
SECApi,
|
|
1774
|
+
} from '@invinite-org/data-api-client';
|
|
1775
|
+
import type { SecFinancialsCatalogRequest } from '@invinite-org/data-api-client';
|
|
1776
|
+
|
|
1777
|
+
async function example() {
|
|
1778
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
1779
|
+
const config = new Configuration({
|
|
1780
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1781
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1782
|
+
});
|
|
1783
|
+
const api = new SECApi(config);
|
|
1784
|
+
|
|
1785
|
+
const body = {
|
|
1786
|
+
// 'income_statement' | 'balance_sheet' | 'cash_flow_statement' | One statement (optional)
|
|
1787
|
+
statement: income_statement,
|
|
1788
|
+
// string | One standardized metric (optional)
|
|
1789
|
+
metricId: is_total_revenue,
|
|
1790
|
+
} satisfies SecFinancialsCatalogRequest;
|
|
1791
|
+
|
|
1792
|
+
try {
|
|
1793
|
+
const data = await api.secFinancialsCatalog(body);
|
|
1794
|
+
console.log(data);
|
|
1795
|
+
} catch (error) {
|
|
1796
|
+
console.error(error);
|
|
1797
|
+
}
|
|
1798
|
+
}
|
|
1799
|
+
|
|
1800
|
+
// Run the test
|
|
1801
|
+
example().catch(console.error);
|
|
1802
|
+
```
|
|
1803
|
+
|
|
1804
|
+
### Parameters
|
|
1805
|
+
|
|
1806
|
+
|
|
1807
|
+
| Name | Type | Description | Notes |
|
|
1808
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1809
|
+
| **statement** | `income_statement`, `balance_sheet`, `cash_flow_statement` | One statement | [Optional] [Defaults to `undefined`] [Enum: income_statement, balance_sheet, cash_flow_statement] |
|
|
1810
|
+
| **metricId** | `string` | One standardized metric | [Optional] [Defaults to `undefined`] |
|
|
1811
|
+
|
|
1812
|
+
### Return type
|
|
1813
|
+
|
|
1814
|
+
[**SecFinancialsCatalog200Response**](SecFinancialsCatalog200Response.md)
|
|
1815
|
+
|
|
1816
|
+
### Authorization
|
|
1817
|
+
|
|
1818
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1819
|
+
|
|
1820
|
+
### HTTP request headers
|
|
1821
|
+
|
|
1822
|
+
- **Content-Type**: Not defined
|
|
1823
|
+
- **Accept**: `application/json`
|
|
1824
|
+
|
|
1825
|
+
|
|
1826
|
+
### HTTP response details
|
|
1827
|
+
| Status code | Description | Response headers |
|
|
1828
|
+
|-------------|-------------|------------------|
|
|
1829
|
+
| **200** | The rule catalog | - |
|
|
1830
|
+
| **202** | The rule catalog | - |
|
|
1831
|
+
| **400** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1832
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
1833
|
+
| **403** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1834
|
+
| **404** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1835
|
+
| **424** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1836
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
1837
|
+
| **503** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1838
|
+
|
|
1839
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1840
|
+
|
|
1841
|
+
|
|
1842
|
+
## secFinancialsFact
|
|
1843
|
+
|
|
1844
|
+
> SecFinancialsCatalog200Response secFinancialsFact(id, maxDepth, maxMembers, places)
|
|
1845
|
+
|
|
1846
|
+
Explain a standardized fact
|
|
1847
|
+
|
|
1848
|
+
One standardized fact explained: its value, the applied rule (only from a matching receipt; a current-catalog candidate is labelled apart), its source facts with original and annotated places, the bounded formula walk (several operands for a formula value) and quality flags. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
|
|
1849
|
+
|
|
1850
|
+
### Example
|
|
1851
|
+
|
|
1852
|
+
```ts
|
|
1853
|
+
import {
|
|
1854
|
+
Configuration,
|
|
1855
|
+
SECApi,
|
|
1856
|
+
} from '@invinite-org/data-api-client';
|
|
1857
|
+
import type { SecFinancialsFactRequest } from '@invinite-org/data-api-client';
|
|
1858
|
+
|
|
1859
|
+
async function example() {
|
|
1860
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
1861
|
+
const config = new Configuration({
|
|
1862
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1863
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1864
|
+
});
|
|
1865
|
+
const api = new SECApi(config);
|
|
1866
|
+
|
|
1867
|
+
const body = {
|
|
1868
|
+
// string | Fact id `cik|metric_id|period type|fiscal year|fiscal quarter` (the `id` of a standardized row)
|
|
1869
|
+
id: 320193|is_total_revenue|annual|2026|4,
|
|
1870
|
+
// number | Formula depth (1-6, default 4) (optional)
|
|
1871
|
+
maxDepth: 3,
|
|
1872
|
+
// number | Formula members at most (1-200, default 64) (optional)
|
|
1873
|
+
maxMembers: 64,
|
|
1874
|
+
// 'true' | 'false' | Resolve the source facts\' places (default true) (`true` or `false`) (optional)
|
|
1875
|
+
places: true,
|
|
1876
|
+
} satisfies SecFinancialsFactRequest;
|
|
1877
|
+
|
|
1878
|
+
try {
|
|
1879
|
+
const data = await api.secFinancialsFact(body);
|
|
1880
|
+
console.log(data);
|
|
1881
|
+
} catch (error) {
|
|
1882
|
+
console.error(error);
|
|
1883
|
+
}
|
|
1884
|
+
}
|
|
1885
|
+
|
|
1886
|
+
// Run the test
|
|
1887
|
+
example().catch(console.error);
|
|
1888
|
+
```
|
|
1889
|
+
|
|
1890
|
+
### Parameters
|
|
1891
|
+
|
|
1892
|
+
|
|
1893
|
+
| Name | Type | Description | Notes |
|
|
1894
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1895
|
+
| **id** | `string` | Fact id `cik|metric_id|period type|fiscal year|fiscal quarter` (the `id` of a standardized row) | [Defaults to `undefined`] |
|
|
1896
|
+
| **maxDepth** | `number` | Formula depth (1-6, default 4) | [Optional] [Defaults to `undefined`] |
|
|
1897
|
+
| **maxMembers** | `number` | Formula members at most (1-200, default 64) | [Optional] [Defaults to `undefined`] |
|
|
1898
|
+
| **places** | `true`, `false` | Resolve the source facts\' places (default true) (`true` or `false`) | [Optional] [Defaults to `undefined`] [Enum: true, false] |
|
|
1899
|
+
|
|
1900
|
+
### Return type
|
|
1901
|
+
|
|
1902
|
+
[**SecFinancialsCatalog200Response**](SecFinancialsCatalog200Response.md)
|
|
1903
|
+
|
|
1904
|
+
### Authorization
|
|
1905
|
+
|
|
1906
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1907
|
+
|
|
1908
|
+
### HTTP request headers
|
|
1909
|
+
|
|
1910
|
+
- **Content-Type**: Not defined
|
|
1911
|
+
- **Accept**: `application/json`
|
|
1912
|
+
|
|
1913
|
+
|
|
1914
|
+
### HTTP response details
|
|
1915
|
+
| Status code | Description | Response headers |
|
|
1916
|
+
|-------------|-------------|------------------|
|
|
1917
|
+
| **200** | One explained fact | - |
|
|
1918
|
+
| **202** | One explained fact | - |
|
|
1919
|
+
| **400** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1920
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
1921
|
+
| **403** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1922
|
+
| **404** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1923
|
+
| **424** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1924
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
1925
|
+
| **503** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
1926
|
+
|
|
1927
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
1928
|
+
|
|
1929
|
+
|
|
1930
|
+
## secFinancialsStatement
|
|
1931
|
+
|
|
1932
|
+
> SecFinancialsCatalog200Response secFinancialsStatement(cik, statement, periodType, fiscalYearFrom, fiscalYearTo, metricId, otherEvidence, limit)
|
|
1933
|
+
|
|
1934
|
+
Standardized statement with provenance
|
|
1935
|
+
|
|
1936
|
+
A company\'s standardized statement cells (the values of `/v1/standardized/_*`, unchanged) with their provenance: the applied rule from a matching receipt (`recorded`; `stale` / `legacy_unrecorded` / `not_observed` otherwise — never reconstructed), the source facts and their places. Values are exact decimal strings. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
|
|
1937
|
+
|
|
1938
|
+
### Example
|
|
1939
|
+
|
|
1940
|
+
```ts
|
|
1941
|
+
import {
|
|
1942
|
+
Configuration,
|
|
1943
|
+
SECApi,
|
|
1944
|
+
} from '@invinite-org/data-api-client';
|
|
1945
|
+
import type { SecFinancialsStatementRequest } from '@invinite-org/data-api-client';
|
|
1946
|
+
|
|
1947
|
+
async function example() {
|
|
1948
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
1949
|
+
const config = new Configuration({
|
|
1950
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
1951
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
1952
|
+
});
|
|
1953
|
+
const api = new SECApi(config);
|
|
1954
|
+
|
|
1955
|
+
const body = {
|
|
1956
|
+
// string | CIK of the company
|
|
1957
|
+
cik: 320193,
|
|
1958
|
+
// 'income_statement' | 'balance_sheet' | 'cash_flow_statement' | The statement
|
|
1959
|
+
statement: income_statement,
|
|
1960
|
+
// 'quarterly' | 'annual' | 'ytd' | 'ttm' | Period type (default annual) (optional)
|
|
1961
|
+
periodType: annual,
|
|
1962
|
+
// number | First fiscal year (optional)
|
|
1963
|
+
fiscalYearFrom: 2022,
|
|
1964
|
+
// number | Last fiscal year (optional)
|
|
1965
|
+
fiscalYearTo: 2026,
|
|
1966
|
+
// string | Standardized metrics, a comma list (optional)
|
|
1967
|
+
metricId: is_total_revenue,is_net_income,
|
|
1968
|
+
// 'true' | 'false' | Add facts that did not win a cell (`true` or `false`) (optional)
|
|
1969
|
+
otherEvidence: false,
|
|
1970
|
+
// number | Cells at most (1-5000, default 2000) (optional)
|
|
1971
|
+
limit: 200,
|
|
1972
|
+
} satisfies SecFinancialsStatementRequest;
|
|
1973
|
+
|
|
1974
|
+
try {
|
|
1975
|
+
const data = await api.secFinancialsStatement(body);
|
|
1976
|
+
console.log(data);
|
|
1977
|
+
} catch (error) {
|
|
1978
|
+
console.error(error);
|
|
1979
|
+
}
|
|
1980
|
+
}
|
|
1981
|
+
|
|
1982
|
+
// Run the test
|
|
1983
|
+
example().catch(console.error);
|
|
1984
|
+
```
|
|
1985
|
+
|
|
1986
|
+
### Parameters
|
|
1987
|
+
|
|
1988
|
+
|
|
1989
|
+
| Name | Type | Description | Notes |
|
|
1990
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1991
|
+
| **cik** | `string` | CIK of the company | [Defaults to `undefined`] |
|
|
1992
|
+
| **statement** | `income_statement`, `balance_sheet`, `cash_flow_statement` | The statement | [Defaults to `undefined`] [Enum: income_statement, balance_sheet, cash_flow_statement] |
|
|
1993
|
+
| **periodType** | `quarterly`, `annual`, `ytd`, `ttm` | Period type (default annual) | [Optional] [Defaults to `undefined`] [Enum: quarterly, annual, ytd, ttm] |
|
|
1994
|
+
| **fiscalYearFrom** | `number` | First fiscal year | [Optional] [Defaults to `undefined`] |
|
|
1995
|
+
| **fiscalYearTo** | `number` | Last fiscal year | [Optional] [Defaults to `undefined`] |
|
|
1996
|
+
| **metricId** | `string` | Standardized metrics, a comma list | [Optional] [Defaults to `undefined`] |
|
|
1997
|
+
| **otherEvidence** | `true`, `false` | Add facts that did not win a cell (`true` or `false`) | [Optional] [Defaults to `undefined`] [Enum: true, false] |
|
|
1998
|
+
| **limit** | `number` | Cells at most (1-5000, default 2000) | [Optional] [Defaults to `2000`] |
|
|
1999
|
+
|
|
2000
|
+
### Return type
|
|
2001
|
+
|
|
2002
|
+
[**SecFinancialsCatalog200Response**](SecFinancialsCatalog200Response.md)
|
|
2003
|
+
|
|
2004
|
+
### Authorization
|
|
2005
|
+
|
|
2006
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2007
|
+
|
|
2008
|
+
### HTTP request headers
|
|
2009
|
+
|
|
2010
|
+
- **Content-Type**: Not defined
|
|
2011
|
+
- **Accept**: `application/json`
|
|
2012
|
+
|
|
2013
|
+
|
|
2014
|
+
### HTTP response details
|
|
2015
|
+
| Status code | Description | Response headers |
|
|
2016
|
+
|-------------|-------------|------------------|
|
|
2017
|
+
| **200** | One statement with provenance | - |
|
|
2018
|
+
| **202** | One statement with provenance | - |
|
|
2019
|
+
| **400** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2020
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
2021
|
+
| **403** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2022
|
+
| **404** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2023
|
+
| **424** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2024
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
2025
|
+
| **503** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2026
|
+
|
|
2027
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2028
|
+
|
|
2029
|
+
|
|
2030
|
+
## secHoldingsDeltas
|
|
2031
|
+
|
|
2032
|
+
> SecHoldingsHolders200Response secHoldingsDeltas(periodEnd, priorPeriodEnd, cusip, symbol, issuerCik, instruments, pinnedAt, cursor, limit)
|
|
2033
|
+
|
|
2034
|
+
Position changes in a security (13F)
|
|
2035
|
+
|
|
2036
|
+
Quarter-over-quarter changes of every manager\'s reported position in one security (new, added, reduced, sold out), each against the manager\'s own prior report. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
|
|
2037
|
+
|
|
2038
|
+
### Example
|
|
2039
|
+
|
|
2040
|
+
```ts
|
|
2041
|
+
import {
|
|
2042
|
+
Configuration,
|
|
2043
|
+
SECApi,
|
|
2044
|
+
} from '@invinite-org/data-api-client';
|
|
2045
|
+
import type { SecHoldingsDeltasRequest } from '@invinite-org/data-api-client';
|
|
2046
|
+
|
|
2047
|
+
async function example() {
|
|
2048
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
2049
|
+
const config = new Configuration({
|
|
2050
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
2051
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2052
|
+
});
|
|
2053
|
+
const api = new SECApi(config);
|
|
2054
|
+
|
|
2055
|
+
const body = {
|
|
2056
|
+
// Date | The 13F report quarter end (YYYY-MM-DD)
|
|
2057
|
+
periodEnd: 2026-06-30,
|
|
2058
|
+
// Date | The quarter compared with (default the previous quarter) (optional)
|
|
2059
|
+
priorPeriodEnd: 2026-03-31,
|
|
2060
|
+
// string | Security CUSIP (optional)
|
|
2061
|
+
cusip: 037833100,
|
|
2062
|
+
// string | Ticker symbol (optional)
|
|
2063
|
+
symbol: AAPL,
|
|
2064
|
+
// string | Issuer CIK (optional)
|
|
2065
|
+
issuerCik: 320193,
|
|
2066
|
+
// 'shareholder' | 'all' | `shareholder` (common / ordinary shares) or `all` (also options, notes, …; default shareholder) (optional)
|
|
2067
|
+
instruments: shareholder,
|
|
2068
|
+
// Date | Read every row as of this instant (`pinned_at` of a previous page keeps pages consistent) (optional)
|
|
2069
|
+
pinnedAt: 2026-11-05T00:00:00Z,
|
|
2070
|
+
// string | Opaque cursor of the previous page (`next_cursor`; follow `next_url`). Bound to the other filters. (optional)
|
|
2071
|
+
cursor: eyJ2IjoxLCJhZnRlciI6WyIyMDI1LTEwLTMxIiwiMDAwMDMyMDE5My0yNS0wMDAwNzkiXSwiZiI6Ijg1NzNiMDg0ZjEyNzVjMjMifQ,
|
|
2072
|
+
// number | Rows per page (1-200, default 50) (optional)
|
|
2073
|
+
limit: 5,
|
|
2074
|
+
} satisfies SecHoldingsDeltasRequest;
|
|
2075
|
+
|
|
2076
|
+
try {
|
|
2077
|
+
const data = await api.secHoldingsDeltas(body);
|
|
2078
|
+
console.log(data);
|
|
2079
|
+
} catch (error) {
|
|
2080
|
+
console.error(error);
|
|
2081
|
+
}
|
|
2082
|
+
}
|
|
2083
|
+
|
|
2084
|
+
// Run the test
|
|
2085
|
+
example().catch(console.error);
|
|
2086
|
+
```
|
|
2087
|
+
|
|
2088
|
+
### Parameters
|
|
2089
|
+
|
|
2090
|
+
|
|
2091
|
+
| Name | Type | Description | Notes |
|
|
2092
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2093
|
+
| **periodEnd** | `Date` | The 13F report quarter end (YYYY-MM-DD) | [Defaults to `undefined`] |
|
|
2094
|
+
| **priorPeriodEnd** | `Date` | The quarter compared with (default the previous quarter) | [Optional] [Defaults to `undefined`] |
|
|
2095
|
+
| **cusip** | `string` | Security CUSIP | [Optional] [Defaults to `undefined`] |
|
|
2096
|
+
| **symbol** | `string` | Ticker symbol | [Optional] [Defaults to `undefined`] |
|
|
2097
|
+
| **issuerCik** | `string` | Issuer CIK | [Optional] [Defaults to `undefined`] |
|
|
2098
|
+
| **instruments** | `shareholder`, `all` | `shareholder` (common / ordinary shares) or `all` (also options, notes, …; default shareholder) | [Optional] [Defaults to `undefined`] [Enum: shareholder, all] |
|
|
2099
|
+
| **pinnedAt** | `Date` | Read every row as of this instant (`pinned_at` of a previous page keeps pages consistent) | [Optional] [Defaults to `undefined`] |
|
|
2100
|
+
| **cursor** | `string` | Opaque cursor of the previous page (`next_cursor`; follow `next_url`). Bound to the other filters. | [Optional] [Defaults to `undefined`] |
|
|
2101
|
+
| **limit** | `number` | Rows per page (1-200, default 50) | [Optional] [Defaults to `50`] |
|
|
2102
|
+
|
|
2103
|
+
### Return type
|
|
2104
|
+
|
|
2105
|
+
[**SecHoldingsHolders200Response**](SecHoldingsHolders200Response.md)
|
|
2106
|
+
|
|
2107
|
+
### Authorization
|
|
2108
|
+
|
|
2109
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2110
|
+
|
|
2111
|
+
### HTTP request headers
|
|
2112
|
+
|
|
2113
|
+
- **Content-Type**: Not defined
|
|
2114
|
+
- **Accept**: `application/json`
|
|
2115
|
+
|
|
2116
|
+
|
|
2117
|
+
### HTTP response details
|
|
2118
|
+
| Status code | Description | Response headers |
|
|
2119
|
+
|-------------|-------------|------------------|
|
|
2120
|
+
| **200** | One page of position changes | - |
|
|
2121
|
+
| **202** | One page of position changes | - |
|
|
2122
|
+
| **400** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2123
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
2124
|
+
| **403** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2125
|
+
| **404** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2126
|
+
| **409** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2127
|
+
| **424** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2128
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
2129
|
+
| **503** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2130
|
+
|
|
2131
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2132
|
+
|
|
2133
|
+
|
|
2134
|
+
## secHoldingsFormFilers
|
|
2135
|
+
|
|
2136
|
+
> SecHoldingsHolders200Response secHoldingsFormFilers(form, exact, name, cik, cursor, limit)
|
|
2137
|
+
|
|
2138
|
+
Filers of an SEC form
|
|
2139
|
+
|
|
2140
|
+
Every filer of one SEC form (e.g. all 13F-HR managers), with or without a ticker or exchange, by name or CIK. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
|
|
2141
|
+
|
|
2142
|
+
### Example
|
|
2143
|
+
|
|
2144
|
+
```ts
|
|
2145
|
+
import {
|
|
2146
|
+
Configuration,
|
|
2147
|
+
SECApi,
|
|
2148
|
+
} from '@invinite-org/data-api-client';
|
|
2149
|
+
import type { SecHoldingsFormFilersRequest } from '@invinite-org/data-api-client';
|
|
2150
|
+
|
|
2151
|
+
async function example() {
|
|
2152
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
2153
|
+
const config = new Configuration({
|
|
2154
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
2155
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2156
|
+
});
|
|
2157
|
+
const api = new SECApi(config);
|
|
2158
|
+
|
|
2159
|
+
const body = {
|
|
2160
|
+
// string | The form type (e.g. 13F-HR)
|
|
2161
|
+
form: 13F-HR,
|
|
2162
|
+
// 'true' | 'false' | Only this exact form (not its amendments) (`true` or `false`) (optional)
|
|
2163
|
+
exact: false,
|
|
2164
|
+
// string | Filer name (substring) (optional)
|
|
2165
|
+
name: Berkshire,
|
|
2166
|
+
// string | One filer CIK (optional)
|
|
2167
|
+
cik: 1067983,
|
|
2168
|
+
// string | Opaque cursor of the previous page (`next_cursor`; follow `next_url`). Bound to the other filters. (optional)
|
|
2169
|
+
cursor: eyJ2IjoxLCJhZnRlciI6WyIyMDI1LTEwLTMxIiwiMDAwMDMyMDE5My0yNS0wMDAwNzkiXSwiZiI6Ijg1NzNiMDg0ZjEyNzVjMjMifQ,
|
|
2170
|
+
// number | Rows per page (1-200, default 50) (optional)
|
|
2171
|
+
limit: 5,
|
|
2172
|
+
} satisfies SecHoldingsFormFilersRequest;
|
|
2173
|
+
|
|
2174
|
+
try {
|
|
2175
|
+
const data = await api.secHoldingsFormFilers(body);
|
|
2176
|
+
console.log(data);
|
|
2177
|
+
} catch (error) {
|
|
2178
|
+
console.error(error);
|
|
2179
|
+
}
|
|
2180
|
+
}
|
|
2181
|
+
|
|
2182
|
+
// Run the test
|
|
2183
|
+
example().catch(console.error);
|
|
2184
|
+
```
|
|
2185
|
+
|
|
2186
|
+
### Parameters
|
|
2187
|
+
|
|
2188
|
+
|
|
2189
|
+
| Name | Type | Description | Notes |
|
|
2190
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2191
|
+
| **form** | `string` | The form type (e.g. 13F-HR) | [Defaults to `undefined`] |
|
|
2192
|
+
| **exact** | `true`, `false` | Only this exact form (not its amendments) (`true` or `false`) | [Optional] [Defaults to `undefined`] [Enum: true, false] |
|
|
2193
|
+
| **name** | `string` | Filer name (substring) | [Optional] [Defaults to `undefined`] |
|
|
2194
|
+
| **cik** | `string` | One filer CIK | [Optional] [Defaults to `undefined`] |
|
|
2195
|
+
| **cursor** | `string` | Opaque cursor of the previous page (`next_cursor`; follow `next_url`). Bound to the other filters. | [Optional] [Defaults to `undefined`] |
|
|
2196
|
+
| **limit** | `number` | Rows per page (1-200, default 50) | [Optional] [Defaults to `50`] |
|
|
2197
|
+
|
|
2198
|
+
### Return type
|
|
2199
|
+
|
|
2200
|
+
[**SecHoldingsHolders200Response**](SecHoldingsHolders200Response.md)
|
|
2201
|
+
|
|
2202
|
+
### Authorization
|
|
2203
|
+
|
|
2204
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2205
|
+
|
|
2206
|
+
### HTTP request headers
|
|
2207
|
+
|
|
2208
|
+
- **Content-Type**: Not defined
|
|
2209
|
+
- **Accept**: `application/json`
|
|
2210
|
+
|
|
2211
|
+
|
|
2212
|
+
### HTTP response details
|
|
2213
|
+
| Status code | Description | Response headers |
|
|
2214
|
+
|-------------|-------------|------------------|
|
|
2215
|
+
| **200** | One page of form filers | - |
|
|
2216
|
+
| **202** | One page of form filers | - |
|
|
2217
|
+
| **400** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2218
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
2219
|
+
| **403** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2220
|
+
| **404** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2221
|
+
| **409** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2222
|
+
| **424** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2223
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
2224
|
+
| **503** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2225
|
+
|
|
2226
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2227
|
+
|
|
2228
|
+
|
|
2229
|
+
## secHoldingsHolders
|
|
2230
|
+
|
|
2231
|
+
> SecHoldingsHolders200Response secHoldingsHolders(periodEnd, cusip, symbol, issuerCik, instruments, pinnedAt, cursor, limit)
|
|
2232
|
+
|
|
2233
|
+
Institutional holders of a security (13F)
|
|
2234
|
+
|
|
2235
|
+
Every 13F manager reporting a security for one quarter (all public 13F filers, historical; one row per manager report as filed, never a cross-manager sum), with how the CUSIP / symbol / issuer resolved (`identity`), the reconciled coverage boundary and the counting policy. Amendments and restatements follow `counting_policy`. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
|
|
2236
|
+
|
|
2237
|
+
### Example
|
|
2238
|
+
|
|
2239
|
+
```ts
|
|
2240
|
+
import {
|
|
2241
|
+
Configuration,
|
|
2242
|
+
SECApi,
|
|
2243
|
+
} from '@invinite-org/data-api-client';
|
|
2244
|
+
import type { SecHoldingsHoldersRequest } from '@invinite-org/data-api-client';
|
|
2245
|
+
|
|
2246
|
+
async function example() {
|
|
2247
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
2248
|
+
const config = new Configuration({
|
|
2249
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
2250
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2251
|
+
});
|
|
2252
|
+
const api = new SECApi(config);
|
|
2253
|
+
|
|
2254
|
+
const body = {
|
|
2255
|
+
// Date | The 13F report quarter end (YYYY-MM-DD)
|
|
2256
|
+
periodEnd: 2026-06-30,
|
|
2257
|
+
// string | Security CUSIP (optional)
|
|
2258
|
+
cusip: 037833100,
|
|
2259
|
+
// string | Ticker symbol (optional)
|
|
2260
|
+
symbol: AAPL,
|
|
2261
|
+
// string | Issuer CIK (optional)
|
|
2262
|
+
issuerCik: 320193,
|
|
2263
|
+
// 'shareholder' | 'all' | `shareholder` (common / ordinary shares) or `all` (also options, notes, …; default shareholder) (optional)
|
|
2264
|
+
instruments: shareholder,
|
|
2265
|
+
// Date | Read every row as of this instant (`pinned_at` of a previous page keeps pages consistent) (optional)
|
|
2266
|
+
pinnedAt: 2026-11-05T00:00:00Z,
|
|
2267
|
+
// string | Opaque cursor of the previous page (`next_cursor`; follow `next_url`). Bound to the other filters. (optional)
|
|
2268
|
+
cursor: eyJ2IjoxLCJhZnRlciI6WyIyMDI1LTEwLTMxIiwiMDAwMDMyMDE5My0yNS0wMDAwNzkiXSwiZiI6Ijg1NzNiMDg0ZjEyNzVjMjMifQ,
|
|
2269
|
+
// number | Rows per page (1-200, default 50) (optional)
|
|
2270
|
+
limit: 5,
|
|
2271
|
+
} satisfies SecHoldingsHoldersRequest;
|
|
2272
|
+
|
|
2273
|
+
try {
|
|
2274
|
+
const data = await api.secHoldingsHolders(body);
|
|
2275
|
+
console.log(data);
|
|
2276
|
+
} catch (error) {
|
|
2277
|
+
console.error(error);
|
|
2278
|
+
}
|
|
2279
|
+
}
|
|
2280
|
+
|
|
2281
|
+
// Run the test
|
|
2282
|
+
example().catch(console.error);
|
|
2283
|
+
```
|
|
2284
|
+
|
|
2285
|
+
### Parameters
|
|
2286
|
+
|
|
2287
|
+
|
|
2288
|
+
| Name | Type | Description | Notes |
|
|
2289
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2290
|
+
| **periodEnd** | `Date` | The 13F report quarter end (YYYY-MM-DD) | [Defaults to `undefined`] |
|
|
2291
|
+
| **cusip** | `string` | Security CUSIP | [Optional] [Defaults to `undefined`] |
|
|
2292
|
+
| **symbol** | `string` | Ticker symbol | [Optional] [Defaults to `undefined`] |
|
|
2293
|
+
| **issuerCik** | `string` | Issuer CIK | [Optional] [Defaults to `undefined`] |
|
|
2294
|
+
| **instruments** | `shareholder`, `all` | `shareholder` (common / ordinary shares) or `all` (also options, notes, …; default shareholder) | [Optional] [Defaults to `undefined`] [Enum: shareholder, all] |
|
|
2295
|
+
| **pinnedAt** | `Date` | Read every row as of this instant (`pinned_at` of a previous page keeps pages consistent) | [Optional] [Defaults to `undefined`] |
|
|
2296
|
+
| **cursor** | `string` | Opaque cursor of the previous page (`next_cursor`; follow `next_url`). Bound to the other filters. | [Optional] [Defaults to `undefined`] |
|
|
2297
|
+
| **limit** | `number` | Rows per page (1-200, default 50) | [Optional] [Defaults to `50`] |
|
|
2298
|
+
|
|
2299
|
+
### Return type
|
|
2300
|
+
|
|
2301
|
+
[**SecHoldingsHolders200Response**](SecHoldingsHolders200Response.md)
|
|
2302
|
+
|
|
2303
|
+
### Authorization
|
|
2304
|
+
|
|
2305
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2306
|
+
|
|
2307
|
+
### HTTP request headers
|
|
2308
|
+
|
|
2309
|
+
- **Content-Type**: Not defined
|
|
2310
|
+
- **Accept**: `application/json`
|
|
2311
|
+
|
|
2312
|
+
|
|
2313
|
+
### HTTP response details
|
|
2314
|
+
| Status code | Description | Response headers |
|
|
2315
|
+
|-------------|-------------|------------------|
|
|
2316
|
+
| **200** | One page of 13F holders | - |
|
|
2317
|
+
| **202** | One page of 13F holders | - |
|
|
2318
|
+
| **400** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2319
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
2320
|
+
| **403** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2321
|
+
| **404** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2322
|
+
| **409** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2323
|
+
| **424** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2324
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
2325
|
+
| **503** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2326
|
+
|
|
2327
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2328
|
+
|
|
2329
|
+
|
|
2330
|
+
## secHoldingsManagerPortfolio
|
|
2331
|
+
|
|
2332
|
+
> SecHoldingsHolders200Response secHoldingsManagerPortfolio(periodEnd, cik, instruments, pinnedAt, cursor, limit)
|
|
2333
|
+
|
|
2334
|
+
Portfolio of a 13F manager
|
|
2335
|
+
|
|
2336
|
+
One 13F manager\'s reported positions for a quarter — any public 13F filer, with or without an exchange listing of its own. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
|
|
2337
|
+
|
|
2338
|
+
### Example
|
|
2339
|
+
|
|
2340
|
+
```ts
|
|
2341
|
+
import {
|
|
2342
|
+
Configuration,
|
|
2343
|
+
SECApi,
|
|
2344
|
+
} from '@invinite-org/data-api-client';
|
|
2345
|
+
import type { SecHoldingsManagerPortfolioRequest } from '@invinite-org/data-api-client';
|
|
2346
|
+
|
|
2347
|
+
async function example() {
|
|
2348
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
2349
|
+
const config = new Configuration({
|
|
2350
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
2351
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2352
|
+
});
|
|
2353
|
+
const api = new SECApi(config);
|
|
2354
|
+
|
|
2355
|
+
const body = {
|
|
2356
|
+
// Date | The 13F report quarter end (YYYY-MM-DD)
|
|
2357
|
+
periodEnd: 2026-06-30,
|
|
2358
|
+
// string | CIK of the 13F manager
|
|
2359
|
+
cik: 1067983,
|
|
2360
|
+
// 'shareholder' | 'all' | `shareholder` (common / ordinary shares) or `all` (also options, notes, …; default all) (optional)
|
|
2361
|
+
instruments: shareholder,
|
|
2362
|
+
// Date | Read every row as of this instant (`pinned_at` of a previous page keeps pages consistent) (optional)
|
|
2363
|
+
pinnedAt: 2026-11-05T00:00:00Z,
|
|
2364
|
+
// string | Opaque cursor of the previous page (`next_cursor`; follow `next_url`). Bound to the other filters. (optional)
|
|
2365
|
+
cursor: eyJ2IjoxLCJhZnRlciI6WyIyMDI1LTEwLTMxIiwiMDAwMDMyMDE5My0yNS0wMDAwNzkiXSwiZiI6Ijg1NzNiMDg0ZjEyNzVjMjMifQ,
|
|
2366
|
+
// number | Rows per page (1-200, default 50) (optional)
|
|
2367
|
+
limit: 5,
|
|
2368
|
+
} satisfies SecHoldingsManagerPortfolioRequest;
|
|
2369
|
+
|
|
2370
|
+
try {
|
|
2371
|
+
const data = await api.secHoldingsManagerPortfolio(body);
|
|
2372
|
+
console.log(data);
|
|
2373
|
+
} catch (error) {
|
|
2374
|
+
console.error(error);
|
|
2375
|
+
}
|
|
2376
|
+
}
|
|
2377
|
+
|
|
2378
|
+
// Run the test
|
|
2379
|
+
example().catch(console.error);
|
|
2380
|
+
```
|
|
2381
|
+
|
|
2382
|
+
### Parameters
|
|
2383
|
+
|
|
2384
|
+
|
|
2385
|
+
| Name | Type | Description | Notes |
|
|
2386
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2387
|
+
| **periodEnd** | `Date` | The 13F report quarter end (YYYY-MM-DD) | [Defaults to `undefined`] |
|
|
2388
|
+
| **cik** | `string` | CIK of the 13F manager | [Defaults to `undefined`] |
|
|
2389
|
+
| **instruments** | `shareholder`, `all` | `shareholder` (common / ordinary shares) or `all` (also options, notes, …; default all) | [Optional] [Defaults to `undefined`] [Enum: shareholder, all] |
|
|
2390
|
+
| **pinnedAt** | `Date` | Read every row as of this instant (`pinned_at` of a previous page keeps pages consistent) | [Optional] [Defaults to `undefined`] |
|
|
2391
|
+
| **cursor** | `string` | Opaque cursor of the previous page (`next_cursor`; follow `next_url`). Bound to the other filters. | [Optional] [Defaults to `undefined`] |
|
|
2392
|
+
| **limit** | `number` | Rows per page (1-200, default 50) | [Optional] [Defaults to `50`] |
|
|
2393
|
+
|
|
2394
|
+
### Return type
|
|
2395
|
+
|
|
2396
|
+
[**SecHoldingsHolders200Response**](SecHoldingsHolders200Response.md)
|
|
2397
|
+
|
|
2398
|
+
### Authorization
|
|
2399
|
+
|
|
2400
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2401
|
+
|
|
2402
|
+
### HTTP request headers
|
|
2403
|
+
|
|
2404
|
+
- **Content-Type**: Not defined
|
|
2405
|
+
- **Accept**: `application/json`
|
|
2406
|
+
|
|
2407
|
+
|
|
2408
|
+
### HTTP response details
|
|
2409
|
+
| Status code | Description | Response headers |
|
|
2410
|
+
|-------------|-------------|------------------|
|
|
2411
|
+
| **200** | One page of a manager\'s portfolio | - |
|
|
2412
|
+
| **202** | One page of a manager\'s portfolio | - |
|
|
2413
|
+
| **400** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2414
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
2415
|
+
| **403** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2416
|
+
| **404** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2417
|
+
| **409** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2418
|
+
| **424** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2419
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
2420
|
+
| **503** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2421
|
+
|
|
2422
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2423
|
+
|
|
2424
|
+
|
|
2425
|
+
## secIssuers
|
|
2426
|
+
|
|
2427
|
+
> SecIssuers200Response secIssuers(query, phase, form, publicSeenFrom, publicSeenTo, cursor, limit)
|
|
2428
|
+
|
|
2429
|
+
List SEC issuers
|
|
2430
|
+
|
|
2431
|
+
Eligible SEC issuers by name, lifecycle phase, a form they filed or when they first became public — a research list of issuers, not an asset search. Several name candidates set `ambiguous`. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for display: FREE.
|
|
2432
|
+
|
|
2433
|
+
### Example
|
|
2434
|
+
|
|
2435
|
+
```ts
|
|
2436
|
+
import {
|
|
2437
|
+
Configuration,
|
|
2438
|
+
SECApi,
|
|
2439
|
+
} from '@invinite-org/data-api-client';
|
|
2440
|
+
import type { SecIssuersRequest } from '@invinite-org/data-api-client';
|
|
2441
|
+
|
|
2442
|
+
async function example() {
|
|
2443
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
2444
|
+
const config = new Configuration({
|
|
2445
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
2446
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2447
|
+
});
|
|
2448
|
+
const api = new SECApi(config);
|
|
2449
|
+
|
|
2450
|
+
const body = {
|
|
2451
|
+
// string | Name (substring) (optional)
|
|
2452
|
+
query: Iambic,
|
|
2453
|
+
// 'observed' | 'public_preipo' | 'listed_spac' | 'listed_operating' | 'former_listed' | 'unresolved' | Lifecycle phase (optional)
|
|
2454
|
+
phase: public_preipo,
|
|
2455
|
+
// string | A form type the issuer filed (optional)
|
|
2456
|
+
form: S-1,
|
|
2457
|
+
// Date | First public sighting on or after (YYYY-MM-DD) (optional)
|
|
2458
|
+
publicSeenFrom: 2026-01-01,
|
|
2459
|
+
// Date | First public sighting on or before (YYYY-MM-DD) (optional)
|
|
2460
|
+
publicSeenTo: 2026-10-31,
|
|
2461
|
+
// string | Opaque cursor of the previous page (`next_cursor`; follow `next_url`). Bound to the other filters. (optional)
|
|
2462
|
+
cursor: eyJ2IjoxLCJhZnRlciI6WyIyMDI1LTEwLTMxIiwiMDAwMDMyMDE5My0yNS0wMDAwNzkiXSwiZiI6Ijg1NzNiMDg0ZjEyNzVjMjMifQ,
|
|
2463
|
+
// number | Issuers per page (1-100, default 20) (optional)
|
|
2464
|
+
limit: 5,
|
|
2465
|
+
} satisfies SecIssuersRequest;
|
|
2466
|
+
|
|
2467
|
+
try {
|
|
2468
|
+
const data = await api.secIssuers(body);
|
|
2469
|
+
console.log(data);
|
|
2470
|
+
} catch (error) {
|
|
2471
|
+
console.error(error);
|
|
2472
|
+
}
|
|
2473
|
+
}
|
|
2474
|
+
|
|
2475
|
+
// Run the test
|
|
2476
|
+
example().catch(console.error);
|
|
2477
|
+
```
|
|
2478
|
+
|
|
2479
|
+
### Parameters
|
|
2480
|
+
|
|
2481
|
+
|
|
2482
|
+
| Name | Type | Description | Notes |
|
|
2483
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2484
|
+
| **query** | `string` | Name (substring) | [Optional] [Defaults to `undefined`] |
|
|
2485
|
+
| **phase** | `observed`, `public_preipo`, `listed_spac`, `listed_operating`, `former_listed`, `unresolved` | Lifecycle phase | [Optional] [Defaults to `undefined`] [Enum: observed, public_preipo, listed_spac, listed_operating, former_listed, unresolved] |
|
|
2486
|
+
| **form** | `string` | A form type the issuer filed | [Optional] [Defaults to `undefined`] |
|
|
2487
|
+
| **publicSeenFrom** | `Date` | First public sighting on or after (YYYY-MM-DD) | [Optional] [Defaults to `undefined`] |
|
|
2488
|
+
| **publicSeenTo** | `Date` | First public sighting on or before (YYYY-MM-DD) | [Optional] [Defaults to `undefined`] |
|
|
2489
|
+
| **cursor** | `string` | Opaque cursor of the previous page (`next_cursor`; follow `next_url`). Bound to the other filters. | [Optional] [Defaults to `undefined`] |
|
|
2490
|
+
| **limit** | `number` | Issuers per page (1-100, default 20) | [Optional] [Defaults to `20`] |
|
|
2491
|
+
|
|
2492
|
+
### Return type
|
|
2493
|
+
|
|
2494
|
+
[**SecIssuers200Response**](SecIssuers200Response.md)
|
|
2495
|
+
|
|
2496
|
+
### Authorization
|
|
2497
|
+
|
|
2498
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2499
|
+
|
|
2500
|
+
### HTTP request headers
|
|
2501
|
+
|
|
2502
|
+
- **Content-Type**: Not defined
|
|
2503
|
+
- **Accept**: `application/json`
|
|
2504
|
+
|
|
2505
|
+
|
|
2506
|
+
### HTTP response details
|
|
2507
|
+
| Status code | Description | Response headers |
|
|
2508
|
+
|-------------|-------------|------------------|
|
|
2509
|
+
| **200** | One page of issuers | - |
|
|
2510
|
+
| **202** | One page of issuers | - |
|
|
2511
|
+
| **400** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2512
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
2513
|
+
| **403** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2514
|
+
| **404** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2515
|
+
| **409** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2516
|
+
| **424** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2517
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
2518
|
+
| **503** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2519
|
+
|
|
2520
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2521
|
+
|
|
2522
|
+
|
|
2523
|
+
## secSearch
|
|
2524
|
+
|
|
2525
|
+
> SecSearch200Response secSearch(q, mode, caseSensitive, cik, entityId, successors, accession, versionId, form, filename, item, exhibitType, filedFrom, filedTo, cursor, limit)
|
|
2526
|
+
|
|
2527
|
+
Search SEC documents
|
|
2528
|
+
|
|
2529
|
+
Find passages in SEC documents, with citations: `mode=lexical` (default; keywords and quoted phrases, English stemming, ranked) or `mode=literal` (the exact characters; `case_sensitive=false` folds case). The earnings search contract: every hit carries `match` (`type`, `lexical_rank`, `spans` = code-point offsets into `text`), `document_spans` (offsets into the document text and each block), the cited blocks with neighbors and footnotes, and `citation` (version, block, the original\'s permanent URL). `coverage` says how complete the answer is: `forms_indexed` / `years_indexed` state the index policy; empty hits with `completeness: complete` is a genuine no-result, anything else is not. A stale or expired cursor answers 409 `restart_required`. Read from Invinite\'s SEC document store: every answer carries `readiness` (`ready` / `partial` 200, `pending` 202 — retry later, not billed — `excluded` 403, `unknown` 404, `failed` 424, `not_ready` 503 while the capability is switched off). Originals, figures and PDFs are permanent public URLs; nothing is fetched from SEC on request. Minimum tier for rag: STANDARD.
|
|
2530
|
+
|
|
2531
|
+
### Example
|
|
2532
|
+
|
|
2533
|
+
```ts
|
|
2534
|
+
import {
|
|
2535
|
+
Configuration,
|
|
2536
|
+
SECApi,
|
|
2537
|
+
} from '@invinite-org/data-api-client';
|
|
2538
|
+
import type { SecSearchRequest } from '@invinite-org/data-api-client';
|
|
2539
|
+
|
|
2540
|
+
async function example() {
|
|
2541
|
+
console.log("🚀 Testing @invinite-org/data-api-client SDK...");
|
|
2542
|
+
const config = new Configuration({
|
|
2543
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
2544
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
2545
|
+
});
|
|
2546
|
+
const api = new SECApi(config);
|
|
2547
|
+
|
|
2548
|
+
const body = {
|
|
2549
|
+
// string | Keywords / a quoted phrase (lexical) or the exact text (literal)
|
|
2550
|
+
q: supply chain concentration,
|
|
2551
|
+
// 'lexical' | 'literal' | `lexical` (default) or `literal` (optional)
|
|
2552
|
+
mode: lexical,
|
|
2553
|
+
// 'true' | 'false' | Literal only: `false` folds case (default case-sensitive) (optional)
|
|
2554
|
+
caseSensitive: false,
|
|
2555
|
+
// string | Filer CIKs, a comma list (optional)
|
|
2556
|
+
cik: 320193,
|
|
2557
|
+
// number | A company entity id (all its CIKs) (optional)
|
|
2558
|
+
entityId: 1,
|
|
2559
|
+
// 'true' | 'false' | Widen `cik` / `entity_id` over reviewed legal successors (`true` or `false`) (optional)
|
|
2560
|
+
successors: false,
|
|
2561
|
+
// string | Accession numbers, a comma list (optional)
|
|
2562
|
+
accession: 0000320193-26-000026,
|
|
2563
|
+
// string | Document version ids, a comma list (optional)
|
|
2564
|
+
versionId: 8be0b759-1a9d-5f89-8308-bd86185f5e1f,
|
|
2565
|
+
// string | Form types, a comma list (optional)
|
|
2566
|
+
form: 10-K,
|
|
2567
|
+
// string | Document file names, a comma list (optional)
|
|
2568
|
+
filename: aapl-20260926.htm,
|
|
2569
|
+
// string | 8-K items, a comma list (e.g. 2.02) (optional)
|
|
2570
|
+
item: 2.02,
|
|
2571
|
+
// string | Exhibit types, a comma list (e.g. EX-99.1) (optional)
|
|
2572
|
+
exhibitType: EX-99.1,
|
|
2573
|
+
// Date | First filing day (YYYY-MM-DD) (optional)
|
|
2574
|
+
filedFrom: 2025-01-01,
|
|
2575
|
+
// Date | Last filing day (YYYY-MM-DD) (optional)
|
|
2576
|
+
filedTo: 2026-11-05,
|
|
2577
|
+
// string | Opaque cursor of the previous page (`next_cursor`; follow `next_url`). Bound to the other filters. (optional)
|
|
2578
|
+
cursor: eyJ2IjoxLCJhZnRlciI6WyIyMDI1LTEwLTMxIiwiMDAwMDMyMDE5My0yNS0wMDAwNzkiXSwiZiI6Ijg1NzNiMDg0ZjEyNzVjMjMifQ,
|
|
2579
|
+
// number | Hits per page (1-50, default 20) (optional)
|
|
2580
|
+
limit: 5,
|
|
2581
|
+
} satisfies SecSearchRequest;
|
|
2582
|
+
|
|
2583
|
+
try {
|
|
2584
|
+
const data = await api.secSearch(body);
|
|
2585
|
+
console.log(data);
|
|
2586
|
+
} catch (error) {
|
|
2587
|
+
console.error(error);
|
|
2588
|
+
}
|
|
2589
|
+
}
|
|
2590
|
+
|
|
2591
|
+
// Run the test
|
|
2592
|
+
example().catch(console.error);
|
|
2593
|
+
```
|
|
2594
|
+
|
|
2595
|
+
### Parameters
|
|
2596
|
+
|
|
2597
|
+
|
|
2598
|
+
| Name | Type | Description | Notes |
|
|
2599
|
+
|------------- | ------------- | ------------- | -------------|
|
|
2600
|
+
| **q** | `string` | Keywords / a quoted phrase (lexical) or the exact text (literal) | [Defaults to `undefined`] |
|
|
2601
|
+
| **mode** | `lexical`, `literal` | `lexical` (default) or `literal` | [Optional] [Defaults to `undefined`] [Enum: lexical, literal] |
|
|
2602
|
+
| **caseSensitive** | `true`, `false` | Literal only: `false` folds case (default case-sensitive) | [Optional] [Defaults to `undefined`] [Enum: true, false] |
|
|
2603
|
+
| **cik** | `string` | Filer CIKs, a comma list | [Optional] [Defaults to `undefined`] |
|
|
2604
|
+
| **entityId** | `number` | A company entity id (all its CIKs) | [Optional] [Defaults to `undefined`] |
|
|
2605
|
+
| **successors** | `true`, `false` | Widen `cik` / `entity_id` over reviewed legal successors (`true` or `false`) | [Optional] [Defaults to `undefined`] [Enum: true, false] |
|
|
2606
|
+
| **accession** | `string` | Accession numbers, a comma list | [Optional] [Defaults to `undefined`] |
|
|
2607
|
+
| **versionId** | `string` | Document version ids, a comma list | [Optional] [Defaults to `undefined`] |
|
|
2608
|
+
| **form** | `string` | Form types, a comma list | [Optional] [Defaults to `undefined`] |
|
|
2609
|
+
| **filename** | `string` | Document file names, a comma list | [Optional] [Defaults to `undefined`] |
|
|
2610
|
+
| **item** | `string` | 8-K items, a comma list (e.g. 2.02) | [Optional] [Defaults to `undefined`] |
|
|
2611
|
+
| **exhibitType** | `string` | Exhibit types, a comma list (e.g. EX-99.1) | [Optional] [Defaults to `undefined`] |
|
|
2612
|
+
| **filedFrom** | `Date` | First filing day (YYYY-MM-DD) | [Optional] [Defaults to `undefined`] |
|
|
2613
|
+
| **filedTo** | `Date` | Last filing day (YYYY-MM-DD) | [Optional] [Defaults to `undefined`] |
|
|
2614
|
+
| **cursor** | `string` | Opaque cursor of the previous page (`next_cursor`; follow `next_url`). Bound to the other filters. | [Optional] [Defaults to `undefined`] |
|
|
2615
|
+
| **limit** | `number` | Hits per page (1-50, default 20) | [Optional] [Defaults to `20`] |
|
|
2616
|
+
|
|
2617
|
+
### Return type
|
|
2618
|
+
|
|
2619
|
+
[**SecSearch200Response**](SecSearch200Response.md)
|
|
2620
|
+
|
|
2621
|
+
### Authorization
|
|
2622
|
+
|
|
2623
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
2624
|
+
|
|
2625
|
+
### HTTP request headers
|
|
2626
|
+
|
|
2627
|
+
- **Content-Type**: Not defined
|
|
2628
|
+
- **Accept**: `application/json`
|
|
2629
|
+
|
|
2630
|
+
|
|
2631
|
+
### HTTP response details
|
|
2632
|
+
| Status code | Description | Response headers |
|
|
2633
|
+
|-------------|-------------|------------------|
|
|
2634
|
+
| **200** | Ranked, cited passages and the coverage of the searched scope | - |
|
|
2635
|
+
| **202** | Ranked, cited passages and the coverage of the searched scope | - |
|
|
2636
|
+
| **400** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2637
|
+
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
2638
|
+
| **403** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2639
|
+
| **404** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2640
|
+
| **409** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2641
|
+
| **424** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2642
|
+
| **500** | Internal Server Error - Server error occurred | - |
|
|
2643
|
+
| **503** | `error` = the readiness state (excluded / unknown / failed / not_ready) or the refusal (`Bad Request`, `restart_required`, `too_large`, `upstream_unavailable`); `code` = the reason; `readiness` = the backend\'s typed answer when there was one (absent for a refused request). Fields of the answer\'s subject (e.g. `filing`) may follow. | - |
|
|
2644
|
+
|
|
2645
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
2646
|
+
|