@invinite-org/data-api-client 6.0.0 → 6.2.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/dist/apis/FilingsApi.d.ts +2 -2
- package/dist/apis/FilingsApi.js +2 -2
- package/dist/apis/ReferenceApi.d.ts +4 -4
- package/dist/apis/ReferenceApi.js +4 -4
- package/dist/esm/apis/FilingsApi.d.ts +2 -2
- package/dist/esm/apis/FilingsApi.js +2 -2
- package/dist/esm/apis/ReferenceApi.d.ts +4 -4
- package/dist/esm/apis/ReferenceApi.js +4 -4
- package/dist/esm/models/AlertCondition.d.ts +199 -5
- package/dist/esm/models/AlertCondition.js +113 -0
- package/dist/esm/models/AlertConditionInput.d.ts +199 -5
- package/dist/esm/models/AlertConditionInput.js +113 -0
- package/dist/esm/models/Company.d.ts +8 -8
- package/dist/esm/models/CompanyListItem.d.ts +1 -1
- package/dist/esm/models/CompanyRef.d.ts +1 -1
- package/dist/esm/models/CreateDestinationRequest.d.ts +12 -0
- package/dist/esm/models/CreateDestinationRequest.js +4 -0
- package/dist/esm/models/Destination.d.ts +12 -0
- package/dist/esm/models/Destination.js +8 -0
- package/dist/esm/models/DestinationCreated.d.ts +12 -0
- package/dist/esm/models/DestinationCreated.js +8 -0
- package/dist/esm/models/UpdateDestinationRequest.d.ts +12 -0
- package/dist/esm/models/UpdateDestinationRequest.js +4 -0
- package/dist/models/AlertCondition.d.ts +199 -5
- package/dist/models/AlertCondition.js +114 -1
- package/dist/models/AlertConditionInput.d.ts +199 -5
- package/dist/models/AlertConditionInput.js +114 -1
- package/dist/models/Company.d.ts +8 -8
- package/dist/models/CompanyListItem.d.ts +1 -1
- package/dist/models/CompanyRef.d.ts +1 -1
- package/dist/models/CreateDestinationRequest.d.ts +12 -0
- package/dist/models/CreateDestinationRequest.js +4 -0
- package/dist/models/Destination.d.ts +12 -0
- package/dist/models/Destination.js +8 -0
- package/dist/models/DestinationCreated.d.ts +12 -0
- package/dist/models/DestinationCreated.js +8 -0
- package/dist/models/UpdateDestinationRequest.d.ts +12 -0
- package/dist/models/UpdateDestinationRequest.js +4 -0
- package/docs/AlertCondition.md +37 -1
- package/docs/AlertConditionInput.md +37 -1
- package/docs/CompaniesApi.md +2 -2
- package/docs/CreateDestinationRequest.md +4 -0
- package/docs/Destination.md +4 -0
- package/docs/DestinationCreated.md +4 -0
- package/docs/EventsApi.md +2 -2
- package/docs/FilingsApi.md +5 -5
- package/docs/FinancialsApi.md +12 -12
- package/docs/GuidanceApi.md +4 -4
- package/docs/HoldingsApi.md +6 -6
- package/docs/IPOsApi.md +2 -2
- package/docs/InsiderTradesApi.md +2 -2
- package/docs/InvestorDocumentsApi.md +4 -4
- package/docs/MetricsApi.md +10 -10
- package/docs/NewsApi.md +6 -6
- package/docs/ReferenceApi.md +8 -8
- package/docs/TranscriptsApi.md +2 -2
- package/docs/UpdateDestinationRequest.md +4 -0
- package/package.json +1 -1
- package/src/apis/FilingsApi.ts +2 -2
- package/src/apis/ReferenceApi.ts +4 -4
- package/src/models/AlertCondition.ts +244 -5
- package/src/models/AlertConditionInput.ts +244 -5
- package/src/models/Company.ts +8 -8
- package/src/models/CompanyListItem.ts +1 -1
- package/src/models/CompanyRef.ts +1 -1
- package/src/models/CreateDestinationRequest.ts +16 -0
- package/src/models/Destination.ts +18 -0
- package/src/models/DestinationCreated.ts +18 -0
- package/src/models/UpdateDestinationRequest.ts +16 -0
package/docs/FilingsApi.md
CHANGED
|
@@ -467,7 +467,7 @@ example().catch(console.error);
|
|
|
467
467
|
|
|
468
468
|
List filings
|
|
469
469
|
|
|
470
|
-
A company’s SEC filings by filing date (newest first by default). Several companies are read one after another: all filings of the first company in the request’s order, then the next; `meta.form_facet` sums the forms of the companies read on the page. `items` is applied to the store’s pages, so a page can hold fewer than `limit` rows while `has_more` is true; follow `next_cursor` until `has_more` is false.
|
|
470
|
+
A company’s SEC filings by filing date (newest first by default). Several companies are read one after another: all filings of the first company in the request’s order, then the next; `meta.form_facet` sums the forms of the companies read on the page. `items` is applied to the store’s pages, so a page can hold fewer than `limit` rows while `has_more` is true; follow `next_cursor` until `has_more` is false. For a US ETF that is a series of a multi-series trust (TQQQ), only the accessions naming its series (`series_id`) are listed, never the whole trust; an ETF that is its own SEC registrant (SPY, QQQ) lists its registrant\'s filings.
|
|
471
471
|
|
|
472
472
|
### Example
|
|
473
473
|
|
|
@@ -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.
|
|
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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company.
|
|
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. | [Defaults to `undefined`] |
|
|
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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [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. (optional)
|
|
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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. (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. | [Optional] [Defaults to `undefined`] |
|
|
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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [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.
|
|
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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company.
|
|
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. | [Defaults to `undefined`] |
|
|
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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [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.
|
|
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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company.
|
|
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. | [Defaults to `undefined`] |
|
|
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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [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.
|
|
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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company.
|
|
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. | [Defaults to `undefined`] |
|
|
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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [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.
|
|
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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company.
|
|
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. | [Defaults to `undefined`] |
|
|
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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [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.
|
|
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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company.
|
|
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. | [Defaults to `undefined`] |
|
|
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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [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.
|
|
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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company.
|
|
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. | [Defaults to `undefined`] |
|
|
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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [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. (optional)
|
|
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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. (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. | [Optional] [Defaults to `undefined`] |
|
|
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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [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. (optional)
|
|
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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. (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. | [Optional] [Defaults to `undefined`] |
|
|
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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [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
|
@@ -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. (optional)
|
|
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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. (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. | [Optional] [Defaults to `undefined`] |
|
|
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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [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. (optional)
|
|
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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. (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. | [Optional] [Defaults to `undefined`] |
|
|
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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [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. (optional)
|
|
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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. (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. | [Optional] [Defaults to `undefined`] |
|
|
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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [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. (optional)
|
|
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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. (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. | [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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [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`] |
|
package/docs/InsiderTradesApi.md
CHANGED
|
@@ -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.
|
|
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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company.
|
|
122
122
|
company: AAPL,
|
|
123
123
|
// 'buy' | 'sell' | buy = acquired, sell = disposed (optional)
|
|
124
124
|
side: buy,
|
|
@@ -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. | [Defaults to `undefined`] |
|
|
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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [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`] |
|
|
@@ -119,7 +119,7 @@ async function example() {
|
|
|
119
119
|
const api = new InvestorDocumentsApi(config);
|
|
120
120
|
|
|
121
121
|
const body = {
|
|
122
|
-
// 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. (optional)
|
|
122
|
+
// 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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. (optional)
|
|
123
123
|
company: AAPL,
|
|
124
124
|
// string | Event id (optional)
|
|
125
125
|
event: evt_01JC8M2X,
|
|
@@ -156,7 +156,7 @@ example().catch(console.error);
|
|
|
156
156
|
|
|
157
157
|
| Name | Type | Description | Notes |
|
|
158
158
|
|------------- | ------------- | ------------- | -------------|
|
|
159
|
-
| **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. | [Optional] [Defaults to `undefined`] |
|
|
159
|
+
| **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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [Optional] [Defaults to `undefined`] |
|
|
160
160
|
| **event** | `string` | Event id | [Optional] [Defaults to `undefined`] |
|
|
161
161
|
| **category** | `string` | Categories, comma list | [Optional] [Defaults to `undefined`] |
|
|
162
162
|
| **kind** | `string` | Kinds, comma list | [Optional] [Defaults to `undefined`] |
|
|
@@ -225,7 +225,7 @@ async function example() {
|
|
|
225
225
|
const body = {
|
|
226
226
|
// string | Query
|
|
227
227
|
q: capital allocation,
|
|
228
|
-
// 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. (optional)
|
|
228
|
+
// 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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. (optional)
|
|
229
229
|
company: AAPL,
|
|
230
230
|
// string | Kinds, comma list (optional)
|
|
231
231
|
kind: investor_presentation,
|
|
@@ -255,7 +255,7 @@ example().catch(console.error);
|
|
|
255
255
|
| Name | Type | Description | Notes |
|
|
256
256
|
|------------- | ------------- | ------------- | -------------|
|
|
257
257
|
| **q** | `string` | Query | [Defaults to `undefined`] |
|
|
258
|
-
| **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. | [Optional] [Defaults to `undefined`] |
|
|
258
|
+
| **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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [Optional] [Defaults to `undefined`] |
|
|
259
259
|
| **kind** | `string` | Kinds, comma list | [Optional] [Defaults to `undefined`] |
|
|
260
260
|
| **mode** | `lexical`, `literal` | Mode | [Optional] [Defaults to `'lexical'`] [Enum: lexical, literal] |
|
|
261
261
|
| **limit** | `number` | Rows per page (default 25, max 200) | [Optional] [Defaults to `25`] |
|
package/docs/MetricsApi.md
CHANGED
|
@@ -125,7 +125,7 @@ async function example() {
|
|
|
125
125
|
const api = new MetricsApi(config);
|
|
126
126
|
|
|
127
127
|
const body = {
|
|
128
|
-
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required.
|
|
128
|
+
// 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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company.
|
|
129
129
|
company: AAPL,
|
|
130
130
|
// 'annual' | 'quarterly' | 'ytd' | 'ttm' | Period type
|
|
131
131
|
period: annual,
|
|
@@ -166,7 +166,7 @@ example().catch(console.error);
|
|
|
166
166
|
|
|
167
167
|
| Name | Type | Description | Notes |
|
|
168
168
|
|------------- | ------------- | ------------- | -------------|
|
|
169
|
-
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. | [Defaults to `undefined`] |
|
|
169
|
+
| **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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [Defaults to `undefined`] |
|
|
170
170
|
| **period** | `annual`, `quarterly`, `ytd`, `ttm` | Period type | [Defaults to `undefined`] [Enum: annual, quarterly, ytd, ttm] |
|
|
171
171
|
| **horizon** | `3`, `5`, `10` | Years spanned | [Optional] [Defaults to `undefined`] [Enum: 3, 5, 10] |
|
|
172
172
|
| **fiscalYearGte** | `number` | `fiscal_year` on or after this value | [Optional] [Defaults to `undefined`] |
|
|
@@ -235,7 +235,7 @@ async function example() {
|
|
|
235
235
|
const api = new MetricsApi(config);
|
|
236
236
|
|
|
237
237
|
const body = {
|
|
238
|
-
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required.
|
|
238
|
+
// 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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company.
|
|
239
239
|
company: AAPL,
|
|
240
240
|
// 'annual' | 'quarterly' | 'ytd' | 'ttm' | Period type
|
|
241
241
|
period: annual,
|
|
@@ -276,7 +276,7 @@ example().catch(console.error);
|
|
|
276
276
|
|
|
277
277
|
| Name | Type | Description | Notes |
|
|
278
278
|
|------------- | ------------- | ------------- | -------------|
|
|
279
|
-
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. | [Defaults to `undefined`] |
|
|
279
|
+
| **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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [Defaults to `undefined`] |
|
|
280
280
|
| **period** | `annual`, `quarterly`, `ytd`, `ttm` | Period type | [Defaults to `undefined`] [Enum: annual, quarterly, ytd, ttm] |
|
|
281
281
|
| **basis** | `yoy`, `qoq` | Comparison basis | [Optional] [Defaults to `'yoy'`] [Enum: yoy, qoq] |
|
|
282
282
|
| **fiscalYearGte** | `number` | `fiscal_year` on or after this value | [Optional] [Defaults to `undefined`] |
|
|
@@ -345,7 +345,7 @@ async function example() {
|
|
|
345
345
|
const api = new MetricsApi(config);
|
|
346
346
|
|
|
347
347
|
const body = {
|
|
348
|
-
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required.
|
|
348
|
+
// 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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company.
|
|
349
349
|
company: AAPL,
|
|
350
350
|
// 'annual' | 'quarterly' | 'ytd' | 'ttm' | Period type
|
|
351
351
|
period: annual,
|
|
@@ -386,7 +386,7 @@ example().catch(console.error);
|
|
|
386
386
|
|
|
387
387
|
| Name | Type | Description | Notes |
|
|
388
388
|
|------------- | ------------- | ------------- | -------------|
|
|
389
|
-
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. | [Defaults to `undefined`] |
|
|
389
|
+
| **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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [Defaults to `undefined`] |
|
|
390
390
|
| **period** | `annual`, `quarterly`, `ytd`, `ttm` | Period type | [Defaults to `undefined`] [Enum: annual, quarterly, ytd, ttm] |
|
|
391
391
|
| **category** | `string` | Ratio categories — any of `profitability`, `liquidity`, `leverage`, `efficiency`, `valuation`, comma-separated | [Optional] [Defaults to `undefined`] |
|
|
392
392
|
| **fiscalYearGte** | `number` | `fiscal_year` on or after this value | [Optional] [Defaults to `undefined`] |
|
|
@@ -455,7 +455,7 @@ async function example() {
|
|
|
455
455
|
const api = new MetricsApi(config);
|
|
456
456
|
|
|
457
457
|
const body = {
|
|
458
|
-
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required.
|
|
458
|
+
// 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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company.
|
|
459
459
|
company: AAPL,
|
|
460
460
|
// 'annual' | 'quarterly' | 'ytd' | 'ttm' | Period type
|
|
461
461
|
period: annual,
|
|
@@ -498,7 +498,7 @@ example().catch(console.error);
|
|
|
498
498
|
|
|
499
499
|
| Name | Type | Description | Notes |
|
|
500
500
|
|------------- | ------------- | ------------- | -------------|
|
|
501
|
-
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. | [Defaults to `undefined`] |
|
|
501
|
+
| **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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [Defaults to `undefined`] |
|
|
502
502
|
| **period** | `annual`, `quarterly`, `ytd`, `ttm` | Period type | [Defaults to `undefined`] [Enum: annual, quarterly, ytd, ttm] |
|
|
503
503
|
| **metric** | `string` | Metric id, comma list | [Optional] [Defaults to `undefined`] |
|
|
504
504
|
| **axis** | `string` | XBRL axis, comma list | [Optional] [Defaults to `undefined`] |
|
|
@@ -568,7 +568,7 @@ async function example() {
|
|
|
568
568
|
const api = new MetricsApi(config);
|
|
569
569
|
|
|
570
570
|
const body = {
|
|
571
|
-
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required.
|
|
571
|
+
// 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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company.
|
|
572
572
|
company: AAPL,
|
|
573
573
|
// 'annual' | 'quarterly' | 'ytd' | 'ttm' | Period type
|
|
574
574
|
period: annual,
|
|
@@ -611,7 +611,7 @@ example().catch(console.error);
|
|
|
611
611
|
|
|
612
612
|
| Name | Type | Description | Notes |
|
|
613
613
|
|------------- | ------------- | ------------- | -------------|
|
|
614
|
-
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. | [Defaults to `undefined`] |
|
|
614
|
+
| **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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [Defaults to `undefined`] |
|
|
615
615
|
| **period** | `annual`, `quarterly`, `ytd`, `ttm` | Period type | [Defaults to `undefined`] [Enum: annual, quarterly, ytd, ttm] |
|
|
616
616
|
| **metric** | `string` | Metric id, comma list | [Optional] [Defaults to `undefined`] |
|
|
617
617
|
| **axis** | `string` | XBRL axis, comma list | [Optional] [Defaults to `undefined`] |
|
package/docs/NewsApi.md
CHANGED
|
@@ -207,7 +207,7 @@ async function example() {
|
|
|
207
207
|
const api = new NewsApi(config);
|
|
208
208
|
|
|
209
209
|
const body = {
|
|
210
|
-
// 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. (optional)
|
|
210
|
+
// 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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. (optional)
|
|
211
211
|
company: AAPL,
|
|
212
212
|
// string | Topics, comma list (optional)
|
|
213
213
|
topic: product_launch,
|
|
@@ -252,7 +252,7 @@ example().catch(console.error);
|
|
|
252
252
|
|
|
253
253
|
| Name | Type | Description | Notes |
|
|
254
254
|
|------------- | ------------- | ------------- | -------------|
|
|
255
|
-
| **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. | [Optional] [Defaults to `undefined`] |
|
|
255
|
+
| **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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [Optional] [Defaults to `undefined`] |
|
|
256
256
|
| **topic** | `string` | Topics, comma list | [Optional] [Defaults to `undefined`] |
|
|
257
257
|
| **item** | `string` | News item id | [Optional] [Defaults to `undefined`] |
|
|
258
258
|
| **announcedAtGte** | `Date` | `announced_at` on or after this value | [Optional] [Defaults to `undefined`] |
|
|
@@ -323,7 +323,7 @@ async function example() {
|
|
|
323
323
|
const api = new NewsApi(config);
|
|
324
324
|
|
|
325
325
|
const body = {
|
|
326
|
-
// 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. (optional)
|
|
326
|
+
// 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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. (optional)
|
|
327
327
|
company: AAPL,
|
|
328
328
|
// string | Event id (optional)
|
|
329
329
|
event: evt_01JC8M2X,
|
|
@@ -366,7 +366,7 @@ example().catch(console.error);
|
|
|
366
366
|
|
|
367
367
|
| Name | Type | Description | Notes |
|
|
368
368
|
|------------- | ------------- | ------------- | -------------|
|
|
369
|
-
| **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. | [Optional] [Defaults to `undefined`] |
|
|
369
|
+
| **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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [Optional] [Defaults to `undefined`] |
|
|
370
370
|
| **event** | `string` | Event id | [Optional] [Defaults to `undefined`] |
|
|
371
371
|
| **kind** | `string` | Kinds, comma list | [Optional] [Defaults to `undefined`] |
|
|
372
372
|
| **topic** | `string` | Topics, comma list | [Optional] [Defaults to `undefined`] |
|
|
@@ -438,7 +438,7 @@ async function example() {
|
|
|
438
438
|
const body = {
|
|
439
439
|
// string | Query
|
|
440
440
|
q: buyback,
|
|
441
|
-
// 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. (optional)
|
|
441
|
+
// 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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. (optional)
|
|
442
442
|
company: AAPL,
|
|
443
443
|
// 'title' | 'lede' | 'summary' | 'any' | Field searched (optional)
|
|
444
444
|
field: any,
|
|
@@ -476,7 +476,7 @@ example().catch(console.error);
|
|
|
476
476
|
| Name | Type | Description | Notes |
|
|
477
477
|
|------------- | ------------- | ------------- | -------------|
|
|
478
478
|
| **q** | `string` | Query | [Defaults to `undefined`] |
|
|
479
|
-
| **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. | [Optional] [Defaults to `undefined`] |
|
|
479
|
+
| **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 company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [Optional] [Defaults to `undefined`] |
|
|
480
480
|
| **field** | `title`, `lede`, `summary`, `any` | Field searched | [Optional] [Defaults to `'any'`] [Enum: title, lede, summary, any] |
|
|
481
481
|
| **mode** | `lexical`, `literal` | Mode | [Optional] [Defaults to `'lexical'`] [Enum: lexical, literal] |
|
|
482
482
|
| **publishedAtGte** | `Date` | `published_at` on or after this value | [Optional] [Defaults to `undefined`] |
|