@invinite-org/data-api-client 6.3.0 → 6.4.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 +12 -0
- package/dist/apis/InsiderTradesApi.d.ts +2 -2
- package/dist/apis/InsiderTradesApi.js +2 -2
- package/dist/esm/apis/InsiderTradesApi.d.ts +2 -2
- package/dist/esm/apis/InsiderTradesApi.js +2 -2
- package/dist/esm/models/AlertCondition.d.ts +29 -5
- package/dist/esm/models/AlertCondition.js +12 -1
- package/dist/esm/models/AlertConditionInput.d.ts +29 -5
- package/dist/esm/models/AlertConditionInput.js +12 -1
- package/dist/esm/models/AlertTrigger.d.ts +2 -2
- package/dist/esm/models/AlertTriggerInput.d.ts +2 -2
- package/dist/esm/models/Company.d.ts +6 -6
- package/dist/esm/models/IndicatorFilterCondition.d.ts +3 -0
- package/dist/esm/models/IndicatorFilterCondition.js +4 -1
- package/dist/esm/models/IndicatorFilterConditionInput.d.ts +3 -0
- package/dist/esm/models/IndicatorFilterConditionInput.js +4 -1
- package/dist/esm/models/ScriptEvaluation.d.ts +65 -0
- package/dist/esm/models/ScriptEvaluation.js +66 -0
- package/dist/esm/models/ScriptEvaluationInput.d.ts +65 -0
- package/dist/esm/models/ScriptEvaluationInput.js +66 -0
- package/dist/esm/models/ScriptNode.d.ts +55 -0
- package/dist/esm/models/ScriptNode.js +53 -0
- package/dist/esm/models/ScriptNodeInput.d.ts +55 -0
- package/dist/esm/models/ScriptNodeInput.js +53 -0
- package/dist/esm/models/ScriptSeriesInput.d.ts +99 -0
- package/dist/esm/models/ScriptSeriesInput.js +78 -0
- package/dist/esm/models/ScriptSeriesInputInput.d.ts +93 -0
- package/dist/esm/models/ScriptSeriesInputInput.js +76 -0
- package/dist/esm/models/index.d.ts +6 -0
- package/dist/esm/models/index.js +6 -0
- package/dist/models/AlertCondition.d.ts +29 -5
- package/dist/models/AlertCondition.js +12 -1
- package/dist/models/AlertConditionInput.d.ts +29 -5
- package/dist/models/AlertConditionInput.js +12 -1
- package/dist/models/AlertTrigger.d.ts +2 -2
- package/dist/models/AlertTriggerInput.d.ts +2 -2
- package/dist/models/Company.d.ts +6 -6
- package/dist/models/IndicatorFilterCondition.d.ts +3 -0
- package/dist/models/IndicatorFilterCondition.js +4 -1
- package/dist/models/IndicatorFilterConditionInput.d.ts +3 -0
- package/dist/models/IndicatorFilterConditionInput.js +4 -1
- package/dist/models/ScriptEvaluation.d.ts +65 -0
- package/dist/models/ScriptEvaluation.js +74 -0
- package/dist/models/ScriptEvaluationInput.d.ts +65 -0
- package/dist/models/ScriptEvaluationInput.js +74 -0
- package/dist/models/ScriptNode.d.ts +55 -0
- package/dist/models/ScriptNode.js +60 -0
- package/dist/models/ScriptNodeInput.d.ts +55 -0
- package/dist/models/ScriptNodeInput.js +60 -0
- package/dist/models/ScriptSeriesInput.d.ts +99 -0
- package/dist/models/ScriptSeriesInput.js +86 -0
- package/dist/models/ScriptSeriesInputInput.d.ts +93 -0
- package/dist/models/ScriptSeriesInputInput.js +84 -0
- package/dist/models/index.d.ts +6 -0
- package/dist/models/index.js +6 -0
- package/docs/AlertCondition.md +7 -1
- package/docs/AlertConditionInput.md +7 -1
- package/docs/CompaniesApi.md +4 -4
- package/docs/EventsApi.md +2 -2
- package/docs/FilingsApi.md +4 -4
- package/docs/FinancialsApi.md +12 -12
- package/docs/GuidanceApi.md +4 -4
- package/docs/HoldingsApi.md +8 -8
- package/docs/IPOsApi.md +4 -4
- package/docs/InsiderTradesApi.md +5 -5
- package/docs/InvestorDocumentsApi.md +4 -4
- package/docs/MetricsApi.md +10 -10
- package/docs/NewsApi.md +6 -6
- package/docs/ReferenceApi.md +6 -6
- package/docs/ScriptEvaluation.md +39 -0
- package/docs/ScriptEvaluationInput.md +39 -0
- package/docs/ScriptNode.md +41 -0
- package/docs/ScriptNodeInput.md +41 -0
- package/docs/ScriptSeriesInput.md +49 -0
- package/docs/ScriptSeriesInputInput.md +47 -0
- package/docs/TranscriptsApi.md +2 -2
- package/package.json +1 -1
- package/src/apis/InsiderTradesApi.ts +2 -2
- package/src/models/AlertCondition.ts +52 -6
- package/src/models/AlertConditionInput.ts +52 -6
- package/src/models/AlertTrigger.ts +2 -2
- package/src/models/AlertTriggerInput.ts +2 -2
- package/src/models/Company.ts +6 -6
- package/src/models/IndicatorFilterCondition.ts +4 -1
- package/src/models/IndicatorFilterConditionInput.ts +4 -1
- package/src/models/ScriptEvaluation.ts +107 -0
- package/src/models/ScriptEvaluationInput.ts +107 -0
- package/src/models/ScriptNode.ts +99 -0
- package/src/models/ScriptNodeInput.ts +99 -0
- package/src/models/ScriptSeriesInput.ts +149 -0
- package/src/models/ScriptSeriesInputInput.ts +141 -0
- package/src/models/index.ts +6 -0
package/docs/CompaniesApi.md
CHANGED
|
@@ -40,7 +40,7 @@ async function example() {
|
|
|
40
40
|
const api = new CompaniesApi(config);
|
|
41
41
|
|
|
42
42
|
const body = {
|
|
43
|
-
// string | Ticker or CIK
|
|
43
|
+
// string | Ticker or CIK. A US ETF that is a series of a multi-series trust (TQQQ) answers its ETF profile by ticker: `cik` / `filer_cik` its trust\'s CIK, `category` `ETF`, every SIC-derived, address and company-only field null
|
|
44
44
|
company: AAPL,
|
|
45
45
|
// string | Optional objects to include: `coverage` (comma list) (optional)
|
|
46
46
|
expand: coverage,
|
|
@@ -65,7 +65,7 @@ example().catch(console.error);
|
|
|
65
65
|
|
|
66
66
|
| Name | Type | Description | Notes |
|
|
67
67
|
|------------- | ------------- | ------------- | -------------|
|
|
68
|
-
| **company** | `string` | Ticker or CIK | [Defaults to `undefined`] |
|
|
68
|
+
| **company** | `string` | Ticker or CIK. A US ETF that is a series of a multi-series trust (TQQQ) answers its ETF profile by ticker: `cik` / `filer_cik` its trust\'s CIK, `category` `ETF`, every SIC-derived, address and company-only field null | [Defaults to `undefined`] |
|
|
69
69
|
| **expand** | `string` | Optional objects to include: `coverage` (comma list) | [Optional] [Defaults to `undefined`] |
|
|
70
70
|
| **fields** | `string` | Comma list of root-level fields to keep (R7) | [Optional] [Defaults to `undefined`] |
|
|
71
71
|
|
|
@@ -587,7 +587,7 @@ async function example() {
|
|
|
587
587
|
const api = new CompaniesApi(config);
|
|
588
588
|
|
|
589
589
|
const body = {
|
|
590
|
-
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
590
|
+
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. (optional)
|
|
591
591
|
company: AAPL,
|
|
592
592
|
// string | Event id (optional)
|
|
593
593
|
event: evt_01JC8M2X,
|
|
@@ -622,7 +622,7 @@ example().catch(console.error);
|
|
|
622
622
|
|
|
623
623
|
| Name | Type | Description | Notes |
|
|
624
624
|
|------------- | ------------- | ------------- | -------------|
|
|
625
|
-
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
625
|
+
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Optional] [Defaults to `undefined`] |
|
|
626
626
|
| **event** | `string` | Event id | [Optional] [Defaults to `undefined`] |
|
|
627
627
|
| **role** | `executive`, `analyst`, `operator`, `other` | Role | [Optional] [Defaults to `undefined`] [Enum: executive, analyst, operator, other] |
|
|
628
628
|
| **q** | `string` | Name | [Optional] [Defaults to `undefined`] |
|
package/docs/EventsApi.md
CHANGED
|
@@ -452,7 +452,7 @@ async function example() {
|
|
|
452
452
|
const api = new EventsApi(config);
|
|
453
453
|
|
|
454
454
|
const body = {
|
|
455
|
-
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
455
|
+
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. (optional)
|
|
456
456
|
company: AAPL,
|
|
457
457
|
// string | Event types (default earnings_call) — any of `earnings_call`, `investor_day`, `conference`, `agm`, `other`, `all`, comma-separated (optional)
|
|
458
458
|
type: earnings_call,
|
|
@@ -501,7 +501,7 @@ example().catch(console.error);
|
|
|
501
501
|
|
|
502
502
|
| Name | Type | Description | Notes |
|
|
503
503
|
|------------- | ------------- | ------------- | -------------|
|
|
504
|
-
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
504
|
+
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Optional] [Defaults to `undefined`] |
|
|
505
505
|
| **type** | `string` | Event types (default earnings_call) — any of `earnings_call`, `investor_day`, `conference`, `agm`, `other`, `all`, comma-separated | [Optional] [Defaults to `undefined`] |
|
|
506
506
|
| **status** | `string` | Status — any of `upcoming`, `live`, `ended`, comma-separated | [Optional] [Defaults to `undefined`] |
|
|
507
507
|
| **scheduledAtGte** | `Date` | `scheduled_at` on or after this value | [Optional] [Defaults to `undefined`] |
|
package/docs/FilingsApi.md
CHANGED
|
@@ -487,7 +487,7 @@ async function example() {
|
|
|
487
487
|
const api = new FilingsApi(config);
|
|
488
488
|
|
|
489
489
|
const body = {
|
|
490
|
-
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
490
|
+
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer.
|
|
491
491
|
company: AAPL,
|
|
492
492
|
// string | Forms, comma list (optional)
|
|
493
493
|
form: 10-K,
|
|
@@ -528,7 +528,7 @@ example().catch(console.error);
|
|
|
528
528
|
|
|
529
529
|
| Name | Type | Description | Notes |
|
|
530
530
|
|------------- | ------------- | ------------- | -------------|
|
|
531
|
-
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
531
|
+
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Defaults to `undefined`] |
|
|
532
532
|
| **form** | `string` | Forms, comma list | [Optional] [Defaults to `undefined`] |
|
|
533
533
|
| **items** | `string` | 8-K items, comma list | [Optional] [Defaults to `undefined`] |
|
|
534
534
|
| **filedAtGte** | `Date` | `filed_at` on or after this value | [Optional] [Defaults to `undefined`] |
|
|
@@ -603,7 +603,7 @@ async function example() {
|
|
|
603
603
|
mode: lexical,
|
|
604
604
|
// boolean | literal mode only (optional)
|
|
605
605
|
caseSensitive: false,
|
|
606
|
-
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
606
|
+
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. (optional)
|
|
607
607
|
company: AAPL,
|
|
608
608
|
// string | Forms, comma list (optional)
|
|
609
609
|
form: 10-K,
|
|
@@ -643,7 +643,7 @@ example().catch(console.error);
|
|
|
643
643
|
| **q** | `string` | Query | [Defaults to `undefined`] |
|
|
644
644
|
| **mode** | `lexical`, `literal` | lexical = ranked words; literal = exact phrase | [Optional] [Defaults to `'lexical'`] [Enum: lexical, literal] |
|
|
645
645
|
| **caseSensitive** | `boolean` | literal mode only | [Optional] [Defaults to `false`] |
|
|
646
|
-
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
646
|
+
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Optional] [Defaults to `undefined`] |
|
|
647
647
|
| **form** | `string` | Forms, comma list | [Optional] [Defaults to `undefined`] |
|
|
648
648
|
| **item** | `string` | Section ids, comma list | [Optional] [Defaults to `undefined`] |
|
|
649
649
|
| **filedAtGte** | `Date` | `filed_at` on or after this value | [Optional] [Defaults to `undefined`] |
|
package/docs/FinancialsApi.md
CHANGED
|
@@ -39,7 +39,7 @@ async function example() {
|
|
|
39
39
|
const api = new FinancialsApi(config);
|
|
40
40
|
|
|
41
41
|
const body = {
|
|
42
|
-
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
42
|
+
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer.
|
|
43
43
|
company: AAPL,
|
|
44
44
|
// 'annual' | 'quarterly' | 'ytd' | 'ttm' | Period type
|
|
45
45
|
period: annual,
|
|
@@ -92,7 +92,7 @@ example().catch(console.error);
|
|
|
92
92
|
|
|
93
93
|
| Name | Type | Description | Notes |
|
|
94
94
|
|------------- | ------------- | ------------- | -------------|
|
|
95
|
-
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
95
|
+
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Defaults to `undefined`] |
|
|
96
96
|
| **period** | `annual`, `quarterly`, `ytd`, `ttm` | Period type | [Defaults to `undefined`] [Enum: annual, quarterly, ytd, ttm] |
|
|
97
97
|
| **statement** | `string` | Statements (default all three) — any of `income-statement`, `balance-sheet`, `cash-flow`, comma-separated | [Optional] [Defaults to `undefined`] |
|
|
98
98
|
| **fiscalYear** | `number` | Fiscal year | [Optional] [Defaults to `undefined`] |
|
|
@@ -167,7 +167,7 @@ async function example() {
|
|
|
167
167
|
const api = new FinancialsApi(config);
|
|
168
168
|
|
|
169
169
|
const body = {
|
|
170
|
-
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
170
|
+
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer.
|
|
171
171
|
company: AAPL,
|
|
172
172
|
// 'annual' | 'quarterly' | 'ytd' | 'ttm' | Period type
|
|
173
173
|
period: annual,
|
|
@@ -220,7 +220,7 @@ example().catch(console.error);
|
|
|
220
220
|
|
|
221
221
|
| Name | Type | Description | Notes |
|
|
222
222
|
|------------- | ------------- | ------------- | -------------|
|
|
223
|
-
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
223
|
+
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Defaults to `undefined`] |
|
|
224
224
|
| **period** | `annual`, `quarterly`, `ytd`, `ttm` | Period type | [Defaults to `undefined`] [Enum: annual, quarterly, ytd, ttm] |
|
|
225
225
|
| **statement** | `string` | Statements (default all three) — any of `income-statement`, `balance-sheet`, `cash-flow`, comma-separated | [Optional] [Defaults to `undefined`] |
|
|
226
226
|
| **fiscalYear** | `number` | Fiscal year | [Optional] [Defaults to `undefined`] |
|
|
@@ -295,7 +295,7 @@ async function example() {
|
|
|
295
295
|
const api = new FinancialsApi(config);
|
|
296
296
|
|
|
297
297
|
const body = {
|
|
298
|
-
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
298
|
+
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer.
|
|
299
299
|
company: AAPL,
|
|
300
300
|
// 'annual' | 'quarterly' | 'ytd' | 'ttm' | Period type
|
|
301
301
|
period: annual,
|
|
@@ -348,7 +348,7 @@ example().catch(console.error);
|
|
|
348
348
|
|
|
349
349
|
| Name | Type | Description | Notes |
|
|
350
350
|
|------------- | ------------- | ------------- | -------------|
|
|
351
|
-
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
351
|
+
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Defaults to `undefined`] |
|
|
352
352
|
| **period** | `annual`, `quarterly`, `ytd`, `ttm` | Period type | [Defaults to `undefined`] [Enum: annual, quarterly, ytd, ttm] |
|
|
353
353
|
| **statement** | `string` | Statements (default all three) — any of `income-statement`, `balance-sheet`, `cash-flow`, comma-separated | [Optional] [Defaults to `undefined`] |
|
|
354
354
|
| **fiscalYear** | `number` | Fiscal year | [Optional] [Defaults to `undefined`] |
|
|
@@ -423,7 +423,7 @@ async function example() {
|
|
|
423
423
|
const api = new FinancialsApi(config);
|
|
424
424
|
|
|
425
425
|
const body = {
|
|
426
|
-
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
426
|
+
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer.
|
|
427
427
|
company: AAPL,
|
|
428
428
|
// 'annual' | 'quarterly' | 'ytd' | 'ttm' | Period type
|
|
429
429
|
period: annual,
|
|
@@ -472,7 +472,7 @@ example().catch(console.error);
|
|
|
472
472
|
|
|
473
473
|
| Name | Type | Description | Notes |
|
|
474
474
|
|------------- | ------------- | ------------- | -------------|
|
|
475
|
-
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
475
|
+
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Defaults to `undefined`] |
|
|
476
476
|
| **period** | `annual`, `quarterly`, `ytd`, `ttm` | Period type | [Defaults to `undefined`] [Enum: annual, quarterly, ytd, ttm] |
|
|
477
477
|
| **statement** | `string` | Statements (default all three) — any of `income-statement`, `balance-sheet`, `cash-flow`, comma-separated | [Optional] [Defaults to `undefined`] |
|
|
478
478
|
| **fiscalYear** | `number` | Fiscal year | [Optional] [Defaults to `undefined`] |
|
|
@@ -545,7 +545,7 @@ async function example() {
|
|
|
545
545
|
const api = new FinancialsApi(config);
|
|
546
546
|
|
|
547
547
|
const body = {
|
|
548
|
-
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
548
|
+
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer.
|
|
549
549
|
company: AAPL,
|
|
550
550
|
// 'annual' | 'quarterly' | 'ytd' | 'ttm' | Period type
|
|
551
551
|
period: annual,
|
|
@@ -594,7 +594,7 @@ example().catch(console.error);
|
|
|
594
594
|
|
|
595
595
|
| Name | Type | Description | Notes |
|
|
596
596
|
|------------- | ------------- | ------------- | -------------|
|
|
597
|
-
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
597
|
+
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Defaults to `undefined`] |
|
|
598
598
|
| **period** | `annual`, `quarterly`, `ytd`, `ttm` | Period type | [Defaults to `undefined`] [Enum: annual, quarterly, ytd, ttm] |
|
|
599
599
|
| **statement** | `string` | Statements (default all three) — any of `income-statement`, `balance-sheet`, `cash-flow`, comma-separated | [Optional] [Defaults to `undefined`] |
|
|
600
600
|
| **fiscalYear** | `number` | Fiscal year | [Optional] [Defaults to `undefined`] |
|
|
@@ -667,7 +667,7 @@ async function example() {
|
|
|
667
667
|
const api = new FinancialsApi(config);
|
|
668
668
|
|
|
669
669
|
const body = {
|
|
670
|
-
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
670
|
+
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer.
|
|
671
671
|
company: AAPL,
|
|
672
672
|
// 'annual' | 'quarterly' | 'ytd' | 'ttm' | Period type
|
|
673
673
|
period: annual,
|
|
@@ -716,7 +716,7 @@ example().catch(console.error);
|
|
|
716
716
|
|
|
717
717
|
| Name | Type | Description | Notes |
|
|
718
718
|
|------------- | ------------- | ------------- | -------------|
|
|
719
|
-
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
719
|
+
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Defaults to `undefined`] |
|
|
720
720
|
| **period** | `annual`, `quarterly`, `ytd`, `ttm` | Period type | [Defaults to `undefined`] [Enum: annual, quarterly, ytd, ttm] |
|
|
721
721
|
| **statement** | `string` | Statements (default all three) — any of `income-statement`, `balance-sheet`, `cash-flow`, comma-separated | [Optional] [Defaults to `undefined`] |
|
|
722
722
|
| **fiscalYear** | `number` | Fiscal year | [Optional] [Defaults to `undefined`] |
|
package/docs/GuidanceApi.md
CHANGED
|
@@ -35,7 +35,7 @@ async function example() {
|
|
|
35
35
|
const api = new GuidanceApi(config);
|
|
36
36
|
|
|
37
37
|
const body = {
|
|
38
|
-
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
38
|
+
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. (optional)
|
|
39
39
|
company: AAPL,
|
|
40
40
|
// string | Event id (optional)
|
|
41
41
|
event: evt_01JC8M2X,
|
|
@@ -74,7 +74,7 @@ example().catch(console.error);
|
|
|
74
74
|
|
|
75
75
|
| Name | Type | Description | Notes |
|
|
76
76
|
|------------- | ------------- | ------------- | -------------|
|
|
77
|
-
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
77
|
+
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Optional] [Defaults to `undefined`] |
|
|
78
78
|
| **event** | `string` | Event id | [Optional] [Defaults to `undefined`] |
|
|
79
79
|
| **metric** | `string` | Normalized metric, comma list | [Optional] [Defaults to `undefined`] |
|
|
80
80
|
| **periodKind** | `string` | Period kinds, comma list | [Optional] [Defaults to `undefined`] |
|
|
@@ -142,7 +142,7 @@ async function example() {
|
|
|
142
142
|
const api = new GuidanceApi(config);
|
|
143
143
|
|
|
144
144
|
const body = {
|
|
145
|
-
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
145
|
+
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. (optional)
|
|
146
146
|
company: AAPL,
|
|
147
147
|
// string | Event id (optional)
|
|
148
148
|
event: evt_01JC8M2X,
|
|
@@ -175,7 +175,7 @@ example().catch(console.error);
|
|
|
175
175
|
|
|
176
176
|
| Name | Type | Description | Notes |
|
|
177
177
|
|------------- | ------------- | ------------- | -------------|
|
|
178
|
-
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
178
|
+
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Optional] [Defaults to `undefined`] |
|
|
179
179
|
| **event** | `string` | Event id | [Optional] [Defaults to `undefined`] |
|
|
180
180
|
| **metric** | `string` | Normalized metric, comma list | [Optional] [Defaults to `undefined`] |
|
|
181
181
|
| **sort** | `conference_date`, `-conference_date` | Sort field (`-` = descending); the id tiebreaker is always appended. Default `-conference_date` | [Optional] [Defaults to `'-conference_date'`] [Enum: conference_date, -conference_date] |
|
package/docs/HoldingsApi.md
CHANGED
|
@@ -40,7 +40,7 @@ async function example() {
|
|
|
40
40
|
const body = {
|
|
41
41
|
// string | ETF ticker: the fund\'s freshest composition (one ETF) (optional)
|
|
42
42
|
etf: SPY,
|
|
43
|
-
// string | Ticker (`NVDA`) or CIK of ONE company: the ETFs holding it (from the ETFs\' issuer files). Exactly one of `etf` or `company` is required. (optional)
|
|
43
|
+
// string | Ticker (`NVDA`) or CIK of ONE company: the ETFs holding it (from the ETFs\' issuer files). Exactly one of `etf` or `company` is required. A US ETF that is its own registrant (SPY) is found by its CIK; a series of a multi-series trust (TQQQ) answers one 404 `not_covered` naming it (holders are found by issuer CIK, which would mix its trust\'s other series). (optional)
|
|
44
44
|
company: NVDA,
|
|
45
45
|
// Date | With etf=: the composition stored on or before this date (issuer files about 30 days back, older dates from the N-PORT report); default the freshest (optional)
|
|
46
46
|
asOf: 2026-11-12,
|
|
@@ -72,7 +72,7 @@ example().catch(console.error);
|
|
|
72
72
|
| Name | Type | Description | Notes |
|
|
73
73
|
|------------- | ------------- | ------------- | -------------|
|
|
74
74
|
| **etf** | `string` | ETF ticker: the fund\'s freshest composition (one ETF) | [Optional] [Defaults to `undefined`] |
|
|
75
|
-
| **company** | `string` | Ticker (`NVDA`) or CIK of ONE company: the ETFs holding it (from the ETFs\' issuer files). Exactly one of `etf` or `company` is required. | [Optional] [Defaults to `undefined`] |
|
|
75
|
+
| **company** | `string` | Ticker (`NVDA`) or CIK of ONE company: the ETFs holding it (from the ETFs\' issuer files). Exactly one of `etf` or `company` is required. A US ETF that is its own registrant (SPY) is found by its CIK; a series of a multi-series trust (TQQQ) answers one 404 `not_covered` naming it (holders are found by issuer CIK, which would mix its trust\'s other series). | [Optional] [Defaults to `undefined`] |
|
|
76
76
|
| **asOf** | `Date` | With etf=: the composition stored on or before this date (issuer files about 30 days back, older dates from the N-PORT report); default the freshest | [Optional] [Defaults to `undefined`] |
|
|
77
77
|
| **sort** | `-weight_pct`, `-market_value_usd` | Sort field: `-weight_pct` with etf= (default), `-market_value_usd` with company= (default); the only orders the store serves | [Optional] [Defaults to `undefined`] [Enum: -weight_pct, -market_value_usd] |
|
|
78
78
|
| **fields** | `string` | Comma list of root-level fields to keep (R7) | [Optional] [Defaults to `undefined`] |
|
|
@@ -231,7 +231,7 @@ async function example() {
|
|
|
231
231
|
const api = new HoldingsApi(config);
|
|
232
232
|
|
|
233
233
|
const body = {
|
|
234
|
-
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
234
|
+
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. (optional)
|
|
235
235
|
company: AAPL,
|
|
236
236
|
// string | Fund registrant CIK (one): its fund portfolio (optional)
|
|
237
237
|
filer: 0000036405,
|
|
@@ -268,7 +268,7 @@ example().catch(console.error);
|
|
|
268
268
|
|
|
269
269
|
| Name | Type | Description | Notes |
|
|
270
270
|
|------------- | ------------- | ------------- | -------------|
|
|
271
|
-
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
271
|
+
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Optional] [Defaults to `undefined`] |
|
|
272
272
|
| **filer** | `string` | Fund registrant CIK (one): its fund portfolio | [Optional] [Defaults to `undefined`] |
|
|
273
273
|
| **series** | `string` | SEC series id of one fund (S + 9 digits; a unit investment trust without a series: cik:<registrant CIK>); with filer=, required when the registrant files for more than one fund | [Optional] [Defaults to `undefined`] |
|
|
274
274
|
| **accession** | `string` | NPORT-P filing: its reported holdings as filed | [Optional] [Defaults to `undefined`] |
|
|
@@ -335,7 +335,7 @@ async function example() {
|
|
|
335
335
|
const api = new HoldingsApi(config);
|
|
336
336
|
|
|
337
337
|
const body = {
|
|
338
|
-
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
338
|
+
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. (optional)
|
|
339
339
|
company: AAPL,
|
|
340
340
|
// string | Manager CIK, comma list (optional)
|
|
341
341
|
filer: 0000102909,
|
|
@@ -370,7 +370,7 @@ example().catch(console.error);
|
|
|
370
370
|
|
|
371
371
|
| Name | Type | Description | Notes |
|
|
372
372
|
|------------- | ------------- | ------------- | -------------|
|
|
373
|
-
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
373
|
+
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Optional] [Defaults to `undefined`] |
|
|
374
374
|
| **filer** | `string` | Manager CIK, comma list | [Optional] [Defaults to `undefined`] |
|
|
375
375
|
| **periodEnd** | `Date` | Quarter end | [Optional] [Defaults to `undefined`] |
|
|
376
376
|
| **priorPeriodEnd** | `Date` | Quarter compared against (default the previous one) | [Optional] [Defaults to `undefined`] |
|
|
@@ -436,7 +436,7 @@ async function example() {
|
|
|
436
436
|
const api = new HoldingsApi(config);
|
|
437
437
|
|
|
438
438
|
const body = {
|
|
439
|
-
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
439
|
+
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. (optional)
|
|
440
440
|
company: AAPL,
|
|
441
441
|
// string | Manager CIK, comma list (optional)
|
|
442
442
|
filer: 0000102909,
|
|
@@ -473,7 +473,7 @@ example().catch(console.error);
|
|
|
473
473
|
|
|
474
474
|
| Name | Type | Description | Notes |
|
|
475
475
|
|------------- | ------------- | ------------- | -------------|
|
|
476
|
-
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
476
|
+
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Optional] [Defaults to `undefined`] |
|
|
477
477
|
| **filer** | `string` | Manager CIK, comma list | [Optional] [Defaults to `undefined`] |
|
|
478
478
|
| **accession** | `string` | 13F filing | [Optional] [Defaults to `undefined`] |
|
|
479
479
|
| **periodEnd** | `Date` | Quarter end | [Optional] [Defaults to `undefined`] |
|
package/docs/IPOsApi.md
CHANGED
|
@@ -215,7 +215,7 @@ async function example() {
|
|
|
215
215
|
listingDateLte: 2026-01-01,
|
|
216
216
|
// Date | `listing_date` before this value (optional)
|
|
217
217
|
listingDateLt: 2026-01-01,
|
|
218
|
-
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
218
|
+
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. (optional)
|
|
219
219
|
company: AAPL,
|
|
220
220
|
// 'listing_date' | '-listing_date' | 'first_public_at' | '-first_public_at' | Sort field (`-` = descending); the id tiebreaker is always appended. Default `-listing_date` (optional)
|
|
221
221
|
sort: -listing_date,
|
|
@@ -250,7 +250,7 @@ example().catch(console.error);
|
|
|
250
250
|
| **listingDateGt** | `Date` | `listing_date` after this value | [Optional] [Defaults to `undefined`] |
|
|
251
251
|
| **listingDateLte** | `Date` | `listing_date` on or before this value | [Optional] [Defaults to `undefined`] |
|
|
252
252
|
| **listingDateLt** | `Date` | `listing_date` before this value | [Optional] [Defaults to `undefined`] |
|
|
253
|
-
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
253
|
+
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Optional] [Defaults to `undefined`] |
|
|
254
254
|
| **sort** | `listing_date`, `-listing_date`, `first_public_at`, `-first_public_at` | Sort field (`-` = descending); the id tiebreaker is always appended. Default `-listing_date` | [Optional] [Defaults to `'-listing_date'`] [Enum: listing_date, -listing_date, first_public_at, -first_public_at] |
|
|
255
255
|
| **fields** | `string` | Comma list of root-level fields to keep (R7) | [Optional] [Defaults to `undefined`] |
|
|
256
256
|
| **limit** | `number` | Rows per page (default 25, max 200) | [Optional] [Defaults to `25`] |
|
|
@@ -312,7 +312,7 @@ async function example() {
|
|
|
312
312
|
const api = new IPOsApi(config);
|
|
313
313
|
|
|
314
314
|
const body = {
|
|
315
|
-
// string | Issuer: a CIK (all digits, any padding; any Form D issuer, listed or not) or the ticker of a listed company — ONE value; matches the primary issuer and co-issuers. Without it: every offering (optional)
|
|
315
|
+
// string | Issuer: a CIK (all digits, any padding; any Form D issuer, listed or not) or the ticker of a listed company — ONE value; matches the primary issuer and co-issuers. Without it: every offering. A US ETF answers one 404 `not_covered` naming it, whatever identifier names it — a ticker of either identity (SPY, TQQQ) or the CIK of an ETF that is its own registrant (SPY\'s): no Form D data exists for a fund. A CIK of no listed company (a private issuer) still reads the Form D data (optional)
|
|
316
316
|
company: 0001991882,
|
|
317
317
|
// Date | Latest filing on or after this date (optional)
|
|
318
318
|
filedAtGte: 2026-01-01,
|
|
@@ -353,7 +353,7 @@ example().catch(console.error);
|
|
|
353
353
|
|
|
354
354
|
| Name | Type | Description | Notes |
|
|
355
355
|
|------------- | ------------- | ------------- | -------------|
|
|
356
|
-
| **company** | `string` | Issuer: a CIK (all digits, any padding; any Form D issuer, listed or not) or the ticker of a listed company — ONE value; matches the primary issuer and co-issuers. Without it: every offering | [Optional] [Defaults to `undefined`] |
|
|
356
|
+
| **company** | `string` | Issuer: a CIK (all digits, any padding; any Form D issuer, listed or not) or the ticker of a listed company — ONE value; matches the primary issuer and co-issuers. Without it: every offering. A US ETF answers one 404 `not_covered` naming it, whatever identifier names it — a ticker of either identity (SPY, TQQQ) or the CIK of an ETF that is its own registrant (SPY\'s): no Form D data exists for a fund. A CIK of no listed company (a private issuer) still reads the Form D data | [Optional] [Defaults to `undefined`] |
|
|
357
357
|
| **filedAtGte** | `Date` | Latest filing on or after this date | [Optional] [Defaults to `undefined`] |
|
|
358
358
|
| **filedAtLte** | `Date` | Latest filing on or before this date | [Optional] [Defaults to `undefined`] |
|
|
359
359
|
| **exemption** | `string` | Offerings claiming this exemption, as filed (06b, 06c, 04, 3C.7, …) | [Optional] [Defaults to `undefined`] |
|
package/docs/InsiderTradesApi.md
CHANGED
|
@@ -98,7 +98,7 @@ example().catch(console.error);
|
|
|
98
98
|
|
|
99
99
|
List insider trades
|
|
100
100
|
|
|
101
|
-
|
|
101
|
+
Insider transaction lines (Form 4; Forms 3 and 5 where the SEC insider data set supplies them), newest filing first. Since release 5.7 the default result includes derivative-security lines (options, RSUs, warrants; `is_derivative: true` on the row) beside the non-derivative ones. `is_derivative=false` restores the non-derivative-only result of the releases before 5.7, which is what a buy / sell aggregate wants.
|
|
102
102
|
|
|
103
103
|
### Example
|
|
104
104
|
|
|
@@ -118,7 +118,7 @@ async function example() {
|
|
|
118
118
|
const api = new InsiderTradesApi(config);
|
|
119
119
|
|
|
120
120
|
const body = {
|
|
121
|
-
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
121
|
+
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer.
|
|
122
122
|
company: AAPL,
|
|
123
123
|
// 'buy' | 'sell' | buy = acquired, sell = disposed (optional)
|
|
124
124
|
side: buy,
|
|
@@ -134,7 +134,7 @@ async function example() {
|
|
|
134
134
|
transactionDateGte: 2025-01-01,
|
|
135
135
|
// Date | `transaction_date` on or before this value (rows without a transaction date are excluded) (optional)
|
|
136
136
|
transactionDateLte: 2025-01-01,
|
|
137
|
-
// boolean | true = only derivative-security lines; false = only non-derivative lines (optional)
|
|
137
|
+
// boolean | Omitted = derivative-security lines (options, RSUs, warrants) AND non-derivative lines, the default since release 5.7; true = only derivative-security lines; false = only non-derivative lines (the result of the releases before 5.7: use it for a buy / sell aggregate) (optional)
|
|
138
138
|
isDerivative: false,
|
|
139
139
|
// 'filed_at' | '-filed_at' | Sort field (`-` = descending); the id tiebreaker is always appended. Default `-filed_at` (optional)
|
|
140
140
|
sort: -filed_at,
|
|
@@ -163,7 +163,7 @@ example().catch(console.error);
|
|
|
163
163
|
|
|
164
164
|
| Name | Type | Description | Notes |
|
|
165
165
|
|------------- | ------------- | ------------- | -------------|
|
|
166
|
-
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
166
|
+
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Defaults to `undefined`] |
|
|
167
167
|
| **side** | `buy`, `sell` | buy = acquired, sell = disposed | [Optional] [Defaults to `undefined`] [Enum: buy, sell] |
|
|
168
168
|
| **filedAtGte** | `Date` | `filed_at` on or after this value | [Optional] [Defaults to `undefined`] |
|
|
169
169
|
| **filedAtGt** | `Date` | `filed_at` after this value | [Optional] [Defaults to `undefined`] |
|
|
@@ -171,7 +171,7 @@ example().catch(console.error);
|
|
|
171
171
|
| **filedAtLt** | `Date` | `filed_at` before this value | [Optional] [Defaults to `undefined`] |
|
|
172
172
|
| **transactionDateGte** | `Date` | `transaction_date` on or after this value (rows without a transaction date are excluded) | [Optional] [Defaults to `undefined`] |
|
|
173
173
|
| **transactionDateLte** | `Date` | `transaction_date` on or before this value (rows without a transaction date are excluded) | [Optional] [Defaults to `undefined`] |
|
|
174
|
-
| **isDerivative** | `boolean` | true = only derivative-security lines; false = only non-derivative lines | [Optional] [Defaults to `undefined`] |
|
|
174
|
+
| **isDerivative** | `boolean` | Omitted = derivative-security lines (options, RSUs, warrants) AND non-derivative lines, the default since release 5.7; true = only derivative-security lines; false = only non-derivative lines (the result of the releases before 5.7: use it for a buy / sell aggregate) | [Optional] [Defaults to `undefined`] |
|
|
175
175
|
| **sort** | `filed_at`, `-filed_at` | Sort field (`-` = descending); the id tiebreaker is always appended. Default `-filed_at` | [Optional] [Defaults to `'-filed_at'`] [Enum: filed_at, -filed_at] |
|
|
176
176
|
| **fields** | `string` | Comma list of root-level fields to keep (R7) | [Optional] [Defaults to `undefined`] |
|
|
177
177
|
| **limit** | `number` | Rows per page (default 25, max 200) | [Optional] [Defaults to `25`] |
|