@invinite-org/data-api-client 6.3.0 → 6.3.1

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.
@@ -19,7 +19,7 @@ import type { AlertConditionYieldRule } from './AlertConditionYieldRule';
19
19
  import type { AlertConditionYoyRulesInner } from './AlertConditionYoyRulesInner';
20
20
  import type { IndicatorCondition } from './IndicatorCondition';
21
21
  /**
22
- * What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Price types (`price`, `price_move`, `volume_spike`, `price_reminder`) and `script` watch ONE instrument: `symbol` + `asset_class`. A `script` alert runs a script version (`/v1/scripts`) at each close of `interval`; alerts with the same version, instrument, interval, inputs and frequency share one evaluation. An `indicator` alert takes a built-in `template` (`GET /v1/alert-templates`) or a structured `condition` (+ optional `filters`) on `symbol` / `interval`; alerts crossing a constant on the same indicator, instrument and interval share one evaluation whatever the threshold. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls. US ETFs: `dividend`, `event_countdown` (`ex_dividend` / `dividend_payment`), `filing` and `filing_keyword` take an ETF ticker (SPY or a trust series such as TQQQ; a series ETF is stored by symbol and fires only on events that name it, never on another series' filing of its trust); `earnings_call`, `earnings_call_keyword`, `earnings_results`, `fundamental_metric` and an `earnings_call` countdown refuse an ETF by name (400 `invalid_parameter`), `news` / `news_keyword` a series ETF.
22
+ * What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Price types (`price`, `price_move`, `volume_spike`, `price_reminder`) and `script` watch ONE instrument: `symbol` + `asset_class`. A `script` alert runs a script version (`/v1/scripts`) at each close of `interval`; alerts with the same version, instrument, interval, inputs and frequency share one evaluation. An `indicator` alert takes a built-in `template` (`GET /v1/alert-templates`) or a structured `condition` (+ optional `filters`) on `symbol` / `interval`; alerts crossing a constant on the same indicator, instrument and interval share one evaluation whatever the threshold. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls. US ETFs: `dividend`, `event_countdown` (`ex_dividend` / `dividend_payment`), `filing` and `filing_keyword` take an ETF ticker (SPY or a trust series such as TQQQ; a series ETF is stored by symbol and fires only on events that name it, never on another series' filing of its trust); `earnings_call`, `earnings_call_keyword`, `earnings_results`, `fundamental_metric`, `news`, `news_keyword` and an `earnings_call` countdown refuse an ETF of either identity (its ticker or a fund registrant's CIK) by name (400 `invalid_parameter`).
23
23
  * @export
24
24
  * @interface AlertCondition
25
25
  */
@@ -18,7 +18,7 @@ import type { AlertConditionInputRulesInner } from './AlertConditionInputRulesIn
18
18
  import type { AlertConditionInputYieldRule } from './AlertConditionInputYieldRule';
19
19
  import type { IndicatorFiltersInput } from './IndicatorFiltersInput';
20
20
  /**
21
- * What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Price types (`price`, `price_move`, `volume_spike`, `price_reminder`), `script` and `indicator` watch ONE instrument: `symbol` + `asset_class`. An `indicator` alert takes a built-in `template` (`GET /v1/alert-templates`) or a structured `condition` (+ optional `filters`) on `symbol` / `interval`; alerts crossing a constant on the same indicator, instrument and interval share one evaluation whatever the threshold. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls. (request form) US ETFs: `dividend`, `event_countdown` (`ex_dividend` / `dividend_payment`), `filing` and `filing_keyword` take an ETF ticker (SPY or a trust series such as TQQQ; a series ETF is stored by symbol and fires only on events that name it, never on another series' filing of its trust); `earnings_call`, `earnings_call_keyword`, `earnings_results`, `fundamental_metric` and an `earnings_call` countdown refuse an ETF by name (400 `invalid_parameter`), `news` / `news_keyword` a series ETF.
21
+ * What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Price types (`price`, `price_move`, `volume_spike`, `price_reminder`), `script` and `indicator` watch ONE instrument: `symbol` + `asset_class`. An `indicator` alert takes a built-in `template` (`GET /v1/alert-templates`) or a structured `condition` (+ optional `filters`) on `symbol` / `interval`; alerts crossing a constant on the same indicator, instrument and interval share one evaluation whatever the threshold. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls. (request form) US ETFs: `dividend`, `event_countdown` (`ex_dividend` / `dividend_payment`), `filing` and `filing_keyword` take an ETF ticker (SPY or a trust series such as TQQQ; a series ETF is stored by symbol and fires only on events that name it, never on another series' filing of its trust); `earnings_call`, `earnings_call_keyword`, `earnings_results`, `fundamental_metric`, `news`, `news_keyword` and an `earnings_call` countdown refuse an ETF of either identity (its ticker or a fund registrant's CIK) by name (400 `invalid_parameter`).
22
22
  * @export
23
23
  * @interface AlertConditionInput
24
24
  */
@@ -23,7 +23,7 @@ export interface Company {
23
23
  */
24
24
  ticker: string;
25
25
  /**
26
- * CIK with or without leading zeros
26
+ * CIK with or without leading zeros; for a US ETF that is a series of a multi-series trust (TQQQ) the trust's CIK, empty ("") for such an ETF without a registrant link
27
27
  * @type {string}
28
28
  * @memberof Company
29
29
  */
@@ -41,7 +41,7 @@ export interface Company {
41
41
  */
42
42
  description: string | null;
43
43
  /**
44
- * High-level category
44
+ * High-level category (`ETF` for a series of a multi-series trust such as TQQQ)
45
45
  * @type {string}
46
46
  * @memberof Company
47
47
  */
@@ -65,13 +65,13 @@ export interface Company {
65
65
  */
66
66
  sic: string | null;
67
67
  /**
68
- * Fama-French sector
68
+ * Fama-French sector, from the issuer's SIC code; null for a US ETF (no SIC-derived values are shown for a fund)
69
69
  * @type {string}
70
70
  * @memberof Company
71
71
  */
72
72
  fama_sector: string | null;
73
73
  /**
74
- * Fama-French industry
74
+ * Fama-French industry, from the issuer's SIC code; null for a US ETF (no SIC-derived values are shown for a fund)
75
75
  * @type {string}
76
76
  * @memberof Company
77
77
  */
@@ -191,7 +191,7 @@ export interface Company {
191
191
  */
192
192
  brand_colors: Array<string> | null;
193
193
  /**
194
- * Street address
194
+ * Street address; null for a US ETF
195
195
  * @type {string}
196
196
  * @memberof Company
197
197
  */
@@ -209,7 +209,7 @@ export interface Company {
209
209
  */
210
210
  state: string | null;
211
211
  /**
212
- * Postal/ZIP code
212
+ * Postal/ZIP code; null for a US ETF
213
213
  * @type {string}
214
214
  * @memberof Company
215
215
  */
@@ -19,7 +19,7 @@ import type { AlertConditionYieldRule } from './AlertConditionYieldRule';
19
19
  import type { AlertConditionYoyRulesInner } from './AlertConditionYoyRulesInner';
20
20
  import type { IndicatorCondition } from './IndicatorCondition';
21
21
  /**
22
- * What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Price types (`price`, `price_move`, `volume_spike`, `price_reminder`) and `script` watch ONE instrument: `symbol` + `asset_class`. A `script` alert runs a script version (`/v1/scripts`) at each close of `interval`; alerts with the same version, instrument, interval, inputs and frequency share one evaluation. An `indicator` alert takes a built-in `template` (`GET /v1/alert-templates`) or a structured `condition` (+ optional `filters`) on `symbol` / `interval`; alerts crossing a constant on the same indicator, instrument and interval share one evaluation whatever the threshold. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls. US ETFs: `dividend`, `event_countdown` (`ex_dividend` / `dividend_payment`), `filing` and `filing_keyword` take an ETF ticker (SPY or a trust series such as TQQQ; a series ETF is stored by symbol and fires only on events that name it, never on another series' filing of its trust); `earnings_call`, `earnings_call_keyword`, `earnings_results`, `fundamental_metric` and an `earnings_call` countdown refuse an ETF by name (400 `invalid_parameter`), `news` / `news_keyword` a series ETF.
22
+ * What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Price types (`price`, `price_move`, `volume_spike`, `price_reminder`) and `script` watch ONE instrument: `symbol` + `asset_class`. A `script` alert runs a script version (`/v1/scripts`) at each close of `interval`; alerts with the same version, instrument, interval, inputs and frequency share one evaluation. An `indicator` alert takes a built-in `template` (`GET /v1/alert-templates`) or a structured `condition` (+ optional `filters`) on `symbol` / `interval`; alerts crossing a constant on the same indicator, instrument and interval share one evaluation whatever the threshold. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls. US ETFs: `dividend`, `event_countdown` (`ex_dividend` / `dividend_payment`), `filing` and `filing_keyword` take an ETF ticker (SPY or a trust series such as TQQQ; a series ETF is stored by symbol and fires only on events that name it, never on another series' filing of its trust); `earnings_call`, `earnings_call_keyword`, `earnings_results`, `fundamental_metric`, `news`, `news_keyword` and an `earnings_call` countdown refuse an ETF of either identity (its ticker or a fund registrant's CIK) by name (400 `invalid_parameter`).
23
23
  * @export
24
24
  * @interface AlertCondition
25
25
  */
@@ -18,7 +18,7 @@ import type { AlertConditionInputRulesInner } from './AlertConditionInputRulesIn
18
18
  import type { AlertConditionInputYieldRule } from './AlertConditionInputYieldRule';
19
19
  import type { IndicatorFiltersInput } from './IndicatorFiltersInput';
20
20
  /**
21
- * What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Price types (`price`, `price_move`, `volume_spike`, `price_reminder`), `script` and `indicator` watch ONE instrument: `symbol` + `asset_class`. An `indicator` alert takes a built-in `template` (`GET /v1/alert-templates`) or a structured `condition` (+ optional `filters`) on `symbol` / `interval`; alerts crossing a constant on the same indicator, instrument and interval share one evaluation whatever the threshold. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls. (request form) US ETFs: `dividend`, `event_countdown` (`ex_dividend` / `dividend_payment`), `filing` and `filing_keyword` take an ETF ticker (SPY or a trust series such as TQQQ; a series ETF is stored by symbol and fires only on events that name it, never on another series' filing of its trust); `earnings_call`, `earnings_call_keyword`, `earnings_results`, `fundamental_metric` and an `earnings_call` countdown refuse an ETF by name (400 `invalid_parameter`), `news` / `news_keyword` a series ETF.
21
+ * What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Price types (`price`, `price_move`, `volume_spike`, `price_reminder`), `script` and `indicator` watch ONE instrument: `symbol` + `asset_class`. An `indicator` alert takes a built-in `template` (`GET /v1/alert-templates`) or a structured `condition` (+ optional `filters`) on `symbol` / `interval`; alerts crossing a constant on the same indicator, instrument and interval share one evaluation whatever the threshold. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls. (request form) US ETFs: `dividend`, `event_countdown` (`ex_dividend` / `dividend_payment`), `filing` and `filing_keyword` take an ETF ticker (SPY or a trust series such as TQQQ; a series ETF is stored by symbol and fires only on events that name it, never on another series' filing of its trust); `earnings_call`, `earnings_call_keyword`, `earnings_results`, `fundamental_metric`, `news`, `news_keyword` and an `earnings_call` countdown refuse an ETF of either identity (its ticker or a fund registrant's CIK) by name (400 `invalid_parameter`).
22
22
  * @export
23
23
  * @interface AlertConditionInput
24
24
  */
@@ -23,7 +23,7 @@ export interface Company {
23
23
  */
24
24
  ticker: string;
25
25
  /**
26
- * CIK with or without leading zeros
26
+ * CIK with or without leading zeros; for a US ETF that is a series of a multi-series trust (TQQQ) the trust's CIK, empty ("") for such an ETF without a registrant link
27
27
  * @type {string}
28
28
  * @memberof Company
29
29
  */
@@ -41,7 +41,7 @@ export interface Company {
41
41
  */
42
42
  description: string | null;
43
43
  /**
44
- * High-level category
44
+ * High-level category (`ETF` for a series of a multi-series trust such as TQQQ)
45
45
  * @type {string}
46
46
  * @memberof Company
47
47
  */
@@ -65,13 +65,13 @@ export interface Company {
65
65
  */
66
66
  sic: string | null;
67
67
  /**
68
- * Fama-French sector
68
+ * Fama-French sector, from the issuer's SIC code; null for a US ETF (no SIC-derived values are shown for a fund)
69
69
  * @type {string}
70
70
  * @memberof Company
71
71
  */
72
72
  fama_sector: string | null;
73
73
  /**
74
- * Fama-French industry
74
+ * Fama-French industry, from the issuer's SIC code; null for a US ETF (no SIC-derived values are shown for a fund)
75
75
  * @type {string}
76
76
  * @memberof Company
77
77
  */
@@ -191,7 +191,7 @@ export interface Company {
191
191
  */
192
192
  brand_colors: Array<string> | null;
193
193
  /**
194
- * Street address
194
+ * Street address; null for a US ETF
195
195
  * @type {string}
196
196
  * @memberof Company
197
197
  */
@@ -209,7 +209,7 @@ export interface Company {
209
209
  */
210
210
  state: string | null;
211
211
  /**
212
- * Postal/ZIP code
212
+ * Postal/ZIP code; null for a US ETF
213
213
  * @type {string}
214
214
  * @memberof Company
215
215
  */
@@ -1,7 +1,7 @@
1
1
 
2
2
  # AlertCondition
3
3
 
4
- What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Price types (`price`, `price_move`, `volume_spike`, `price_reminder`) and `script` watch ONE instrument: `symbol` + `asset_class`. A `script` alert runs a script version (`/v1/scripts`) at each close of `interval`; alerts with the same version, instrument, interval, inputs and frequency share one evaluation. An `indicator` alert takes a built-in `template` (`GET /v1/alert-templates`) or a structured `condition` (+ optional `filters`) on `symbol` / `interval`; alerts crossing a constant on the same indicator, instrument and interval share one evaluation whatever the threshold. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls. US ETFs: `dividend`, `event_countdown` (`ex_dividend` / `dividend_payment`), `filing` and `filing_keyword` take an ETF ticker (SPY or a trust series such as TQQQ; a series ETF is stored by symbol and fires only on events that name it, never on another series\' filing of its trust); `earnings_call`, `earnings_call_keyword`, `earnings_results`, `fundamental_metric` and an `earnings_call` countdown refuse an ETF by name (400 `invalid_parameter`), `news` / `news_keyword` a series ETF.
4
+ What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Price types (`price`, `price_move`, `volume_spike`, `price_reminder`) and `script` watch ONE instrument: `symbol` + `asset_class`. A `script` alert runs a script version (`/v1/scripts`) at each close of `interval`; alerts with the same version, instrument, interval, inputs and frequency share one evaluation. An `indicator` alert takes a built-in `template` (`GET /v1/alert-templates`) or a structured `condition` (+ optional `filters`) on `symbol` / `interval`; alerts crossing a constant on the same indicator, instrument and interval share one evaluation whatever the threshold. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls. US ETFs: `dividend`, `event_countdown` (`ex_dividend` / `dividend_payment`), `filing` and `filing_keyword` take an ETF ticker (SPY or a trust series such as TQQQ; a series ETF is stored by symbol and fires only on events that name it, never on another series\' filing of its trust); `earnings_call`, `earnings_call_keyword`, `earnings_results`, `fundamental_metric`, `news`, `news_keyword` and an `earnings_call` countdown refuse an ETF of either identity (its ticker or a fund registrant\'s CIK) by name (400 `invalid_parameter`).
5
5
 
6
6
  ## Properties
7
7
 
@@ -1,7 +1,7 @@
1
1
 
2
2
  # AlertConditionInput
3
3
 
4
- What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Price types (`price`, `price_move`, `volume_spike`, `price_reminder`), `script` and `indicator` watch ONE instrument: `symbol` + `asset_class`. An `indicator` alert takes a built-in `template` (`GET /v1/alert-templates`) or a structured `condition` (+ optional `filters`) on `symbol` / `interval`; alerts crossing a constant on the same indicator, instrument and interval share one evaluation whatever the threshold. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls. (request form) US ETFs: `dividend`, `event_countdown` (`ex_dividend` / `dividend_payment`), `filing` and `filing_keyword` take an ETF ticker (SPY or a trust series such as TQQQ; a series ETF is stored by symbol and fires only on events that name it, never on another series\' filing of its trust); `earnings_call`, `earnings_call_keyword`, `earnings_results`, `fundamental_metric` and an `earnings_call` countdown refuse an ETF by name (400 `invalid_parameter`), `news` / `news_keyword` a series ETF.
4
+ What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Price types (`price`, `price_move`, `volume_spike`, `price_reminder`), `script` and `indicator` watch ONE instrument: `symbol` + `asset_class`. An `indicator` alert takes a built-in `template` (`GET /v1/alert-templates`) or a structured `condition` (+ optional `filters`) on `symbol` / `interval`; alerts crossing a constant on the same indicator, instrument and interval share one evaluation whatever the threshold. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls. (request form) US ETFs: `dividend`, `event_countdown` (`ex_dividend` / `dividend_payment`), `filing` and `filing_keyword` take an ETF ticker (SPY or a trust series such as TQQQ; a series ETF is stored by symbol and fires only on events that name it, never on another series\' filing of its trust); `earnings_call`, `earnings_call_keyword`, `earnings_results`, `fundamental_metric`, `news`, `news_keyword` and an `earnings_call` countdown refuse an ETF of either identity (its ticker or a fund registrant\'s CIK) by name (400 `invalid_parameter`).
5
5
 
6
6
  ## Properties
7
7
 
@@ -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: &#x60;cik&#x60; / &#x60;filer_cik&#x60; its trust\&#39;s CIK, &#x60;category&#x60; &#x60;ETF&#x60;, every SIC-derived, address and company-only field null | [Defaults to `undefined`] |
69
69
  | **expand** | `string` | Optional objects to include: &#x60;coverage&#x60; (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 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)
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 (&#x60;AAPL&#x60;) 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 &#x60;/v1/dividends&#x60;, &#x60;/v1/splits&#x60; and &#x60;/v1/filings&#x60; (a trust series\&#39; filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\&#39;s; a row\&#39;s &#x60;company.cik&#x60; is the trust\&#39;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 &#x60;not_covered&#x60; naming the ETF (\&quot;TQQQ is an ETF: … exists only for companies\&quot;); on the other lists a series ETF such as TQQQ is not a known company. | [Optional] [Defaults to `undefined`] |
625
+ | **company** | `string` | Ticker (&#x60;AAPL&#x60;) 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: &#x60;/v1/dividends&#x60;, &#x60;/v1/splits&#x60;, &#x60;/v1/filings&#x60; and &#x60;/v1/search/filings&#x60; (a trust series\&#39; filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\&#39;s; a row\&#39;s &#x60;company.cik&#x60; is the trust\&#39;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 &#x60;not_covered&#x60; naming it: holders are found by issuer CIK, which would mix its trust\&#39;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 &#x60;not_covered&#x60; naming the ETF, the same for SPY and TQQQ (\&quot;TQQQ is an ETF: … exists only for companies\&quot;); 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 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)
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 (&#x60;AAPL&#x60;) 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 &#x60;/v1/dividends&#x60;, &#x60;/v1/splits&#x60; and &#x60;/v1/filings&#x60; (a trust series\&#39; filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\&#39;s; a row\&#39;s &#x60;company.cik&#x60; is the trust\&#39;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 &#x60;not_covered&#x60; naming the ETF (\&quot;TQQQ is an ETF: … exists only for companies\&quot;); on the other lists a series ETF such as TQQQ is not a known company. | [Optional] [Defaults to `undefined`] |
504
+ | **company** | `string` | Ticker (&#x60;AAPL&#x60;) 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: &#x60;/v1/dividends&#x60;, &#x60;/v1/splits&#x60;, &#x60;/v1/filings&#x60; and &#x60;/v1/search/filings&#x60; (a trust series\&#39; filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\&#39;s; a row\&#39;s &#x60;company.cik&#x60; is the trust\&#39;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 &#x60;not_covered&#x60; naming it: holders are found by issuer CIK, which would mix its trust\&#39;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 &#x60;not_covered&#x60; naming the ETF, the same for SPY and TQQQ (\&quot;TQQQ is an ETF: … exists only for companies\&quot;); in a mixed list the companies answer. | [Optional] [Defaults to `undefined`] |
505
505
  | **type** | `string` | Event types (default earnings_call) — any of &#x60;earnings_call&#x60;, &#x60;investor_day&#x60;, &#x60;conference&#x60;, &#x60;agm&#x60;, &#x60;other&#x60;, &#x60;all&#x60;, comma-separated | [Optional] [Defaults to `undefined`] |
506
506
  | **status** | `string` | Status — any of &#x60;upcoming&#x60;, &#x60;live&#x60;, &#x60;ended&#x60;, comma-separated | [Optional] [Defaults to `undefined`] |
507
507
  | **scheduledAtGte** | `Date` | &#x60;scheduled_at&#x60; on or after this value | [Optional] [Defaults to `undefined`] |
@@ -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 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.
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 (&#x60;AAPL&#x60;) 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 &#x60;/v1/dividends&#x60;, &#x60;/v1/splits&#x60; and &#x60;/v1/filings&#x60; (a trust series\&#39; filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\&#39;s; a row\&#39;s &#x60;company.cik&#x60; is the trust\&#39;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 &#x60;not_covered&#x60; naming the ETF (\&quot;TQQQ is an ETF: … exists only for companies\&quot;); on the other lists a series ETF such as TQQQ is not a known company. | [Defaults to `undefined`] |
531
+ | **company** | `string` | Ticker (&#x60;AAPL&#x60;) 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: &#x60;/v1/dividends&#x60;, &#x60;/v1/splits&#x60;, &#x60;/v1/filings&#x60; and &#x60;/v1/search/filings&#x60; (a trust series\&#39; filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\&#39;s; a row\&#39;s &#x60;company.cik&#x60; is the trust\&#39;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 &#x60;not_covered&#x60; naming it: holders are found by issuer CIK, which would mix its trust\&#39;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 &#x60;not_covered&#x60; naming the ETF, the same for SPY and TQQQ (\&quot;TQQQ is an ETF: … exists only for companies\&quot;); 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` | &#x60;filed_at&#x60; 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 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)
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 &#x3D; ranked words; literal &#x3D; exact phrase | [Optional] [Defaults to `&#39;lexical&#39;`] [Enum: lexical, literal] |
645
645
  | **caseSensitive** | `boolean` | literal mode only | [Optional] [Defaults to `false`] |
646
- | **company** | `string` | Ticker (&#x60;AAPL&#x60;) 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 &#x60;/v1/dividends&#x60;, &#x60;/v1/splits&#x60; and &#x60;/v1/filings&#x60; (a trust series\&#39; filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\&#39;s; a row\&#39;s &#x60;company.cik&#x60; is the trust\&#39;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 &#x60;not_covered&#x60; naming the ETF (\&quot;TQQQ is an ETF: … exists only for companies\&quot;); on the other lists a series ETF such as TQQQ is not a known company. | [Optional] [Defaults to `undefined`] |
646
+ | **company** | `string` | Ticker (&#x60;AAPL&#x60;) 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: &#x60;/v1/dividends&#x60;, &#x60;/v1/splits&#x60;, &#x60;/v1/filings&#x60; and &#x60;/v1/search/filings&#x60; (a trust series\&#39; filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\&#39;s; a row\&#39;s &#x60;company.cik&#x60; is the trust\&#39;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 &#x60;not_covered&#x60; naming it: holders are found by issuer CIK, which would mix its trust\&#39;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 &#x60;not_covered&#x60; naming the ETF, the same for SPY and TQQQ (\&quot;TQQQ is an ETF: … exists only for companies\&quot;); 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` | &#x60;filed_at&#x60; on or after this value | [Optional] [Defaults to `undefined`] |
@@ -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 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.
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 (&#x60;AAPL&#x60;) 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 &#x60;/v1/dividends&#x60;, &#x60;/v1/splits&#x60; and &#x60;/v1/filings&#x60; (a trust series\&#39; filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\&#39;s; a row\&#39;s &#x60;company.cik&#x60; is the trust\&#39;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 &#x60;not_covered&#x60; naming the ETF (\&quot;TQQQ is an ETF: … exists only for companies\&quot;); on the other lists a series ETF such as TQQQ is not a known company. | [Defaults to `undefined`] |
95
+ | **company** | `string` | Ticker (&#x60;AAPL&#x60;) 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: &#x60;/v1/dividends&#x60;, &#x60;/v1/splits&#x60;, &#x60;/v1/filings&#x60; and &#x60;/v1/search/filings&#x60; (a trust series\&#39; filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\&#39;s; a row\&#39;s &#x60;company.cik&#x60; is the trust\&#39;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 &#x60;not_covered&#x60; naming it: holders are found by issuer CIK, which would mix its trust\&#39;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 &#x60;not_covered&#x60; naming the ETF, the same for SPY and TQQQ (\&quot;TQQQ is an ETF: … exists only for companies\&quot;); 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 &#x60;income-statement&#x60;, &#x60;balance-sheet&#x60;, &#x60;cash-flow&#x60;, 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 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.
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 (&#x60;AAPL&#x60;) 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 &#x60;/v1/dividends&#x60;, &#x60;/v1/splits&#x60; and &#x60;/v1/filings&#x60; (a trust series\&#39; filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\&#39;s; a row\&#39;s &#x60;company.cik&#x60; is the trust\&#39;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 &#x60;not_covered&#x60; naming the ETF (\&quot;TQQQ is an ETF: … exists only for companies\&quot;); on the other lists a series ETF such as TQQQ is not a known company. | [Defaults to `undefined`] |
223
+ | **company** | `string` | Ticker (&#x60;AAPL&#x60;) 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: &#x60;/v1/dividends&#x60;, &#x60;/v1/splits&#x60;, &#x60;/v1/filings&#x60; and &#x60;/v1/search/filings&#x60; (a trust series\&#39; filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\&#39;s; a row\&#39;s &#x60;company.cik&#x60; is the trust\&#39;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 &#x60;not_covered&#x60; naming it: holders are found by issuer CIK, which would mix its trust\&#39;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 &#x60;not_covered&#x60; naming the ETF, the same for SPY and TQQQ (\&quot;TQQQ is an ETF: … exists only for companies\&quot;); 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 &#x60;income-statement&#x60;, &#x60;balance-sheet&#x60;, &#x60;cash-flow&#x60;, 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 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.
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 (&#x60;AAPL&#x60;) 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 &#x60;/v1/dividends&#x60;, &#x60;/v1/splits&#x60; and &#x60;/v1/filings&#x60; (a trust series\&#39; filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\&#39;s; a row\&#39;s &#x60;company.cik&#x60; is the trust\&#39;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 &#x60;not_covered&#x60; naming the ETF (\&quot;TQQQ is an ETF: … exists only for companies\&quot;); on the other lists a series ETF such as TQQQ is not a known company. | [Defaults to `undefined`] |
351
+ | **company** | `string` | Ticker (&#x60;AAPL&#x60;) 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: &#x60;/v1/dividends&#x60;, &#x60;/v1/splits&#x60;, &#x60;/v1/filings&#x60; and &#x60;/v1/search/filings&#x60; (a trust series\&#39; filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\&#39;s; a row\&#39;s &#x60;company.cik&#x60; is the trust\&#39;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 &#x60;not_covered&#x60; naming it: holders are found by issuer CIK, which would mix its trust\&#39;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 &#x60;not_covered&#x60; naming the ETF, the same for SPY and TQQQ (\&quot;TQQQ is an ETF: … exists only for companies\&quot;); 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 &#x60;income-statement&#x60;, &#x60;balance-sheet&#x60;, &#x60;cash-flow&#x60;, 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 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.
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 (&#x60;AAPL&#x60;) 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 &#x60;/v1/dividends&#x60;, &#x60;/v1/splits&#x60; and &#x60;/v1/filings&#x60; (a trust series\&#39; filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\&#39;s; a row\&#39;s &#x60;company.cik&#x60; is the trust\&#39;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 &#x60;not_covered&#x60; naming the ETF (\&quot;TQQQ is an ETF: … exists only for companies\&quot;); on the other lists a series ETF such as TQQQ is not a known company. | [Defaults to `undefined`] |
475
+ | **company** | `string` | Ticker (&#x60;AAPL&#x60;) 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: &#x60;/v1/dividends&#x60;, &#x60;/v1/splits&#x60;, &#x60;/v1/filings&#x60; and &#x60;/v1/search/filings&#x60; (a trust series\&#39; filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\&#39;s; a row\&#39;s &#x60;company.cik&#x60; is the trust\&#39;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 &#x60;not_covered&#x60; naming it: holders are found by issuer CIK, which would mix its trust\&#39;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 &#x60;not_covered&#x60; naming the ETF, the same for SPY and TQQQ (\&quot;TQQQ is an ETF: … exists only for companies\&quot;); 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 &#x60;income-statement&#x60;, &#x60;balance-sheet&#x60;, &#x60;cash-flow&#x60;, 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 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.
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 (&#x60;AAPL&#x60;) 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 &#x60;/v1/dividends&#x60;, &#x60;/v1/splits&#x60; and &#x60;/v1/filings&#x60; (a trust series\&#39; filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\&#39;s; a row\&#39;s &#x60;company.cik&#x60; is the trust\&#39;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 &#x60;not_covered&#x60; naming the ETF (\&quot;TQQQ is an ETF: … exists only for companies\&quot;); on the other lists a series ETF such as TQQQ is not a known company. | [Defaults to `undefined`] |
597
+ | **company** | `string` | Ticker (&#x60;AAPL&#x60;) 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: &#x60;/v1/dividends&#x60;, &#x60;/v1/splits&#x60;, &#x60;/v1/filings&#x60; and &#x60;/v1/search/filings&#x60; (a trust series\&#39; filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\&#39;s; a row\&#39;s &#x60;company.cik&#x60; is the trust\&#39;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 &#x60;not_covered&#x60; naming it: holders are found by issuer CIK, which would mix its trust\&#39;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 &#x60;not_covered&#x60; naming the ETF, the same for SPY and TQQQ (\&quot;TQQQ is an ETF: … exists only for companies\&quot;); 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 &#x60;income-statement&#x60;, &#x60;balance-sheet&#x60;, &#x60;cash-flow&#x60;, 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 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.
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 (&#x60;AAPL&#x60;) 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 &#x60;/v1/dividends&#x60;, &#x60;/v1/splits&#x60; and &#x60;/v1/filings&#x60; (a trust series\&#39; filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\&#39;s; a row\&#39;s &#x60;company.cik&#x60; is the trust\&#39;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 &#x60;not_covered&#x60; naming the ETF (\&quot;TQQQ is an ETF: … exists only for companies\&quot;); on the other lists a series ETF such as TQQQ is not a known company. | [Defaults to `undefined`] |
719
+ | **company** | `string` | Ticker (&#x60;AAPL&#x60;) 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: &#x60;/v1/dividends&#x60;, &#x60;/v1/splits&#x60;, &#x60;/v1/filings&#x60; and &#x60;/v1/search/filings&#x60; (a trust series\&#39; filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\&#39;s; a row\&#39;s &#x60;company.cik&#x60; is the trust\&#39;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 &#x60;not_covered&#x60; naming it: holders are found by issuer CIK, which would mix its trust\&#39;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 &#x60;not_covered&#x60; naming the ETF, the same for SPY and TQQQ (\&quot;TQQQ is an ETF: … exists only for companies\&quot;); 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 &#x60;income-statement&#x60;, &#x60;balance-sheet&#x60;, &#x60;cash-flow&#x60;, comma-separated | [Optional] [Defaults to `undefined`] |
722
722
  | **fiscalYear** | `number` | Fiscal year | [Optional] [Defaults to `undefined`] |
@@ -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 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)
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 (&#x60;AAPL&#x60;) 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 &#x60;/v1/dividends&#x60;, &#x60;/v1/splits&#x60; and &#x60;/v1/filings&#x60; (a trust series\&#39; filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\&#39;s; a row\&#39;s &#x60;company.cik&#x60; is the trust\&#39;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 &#x60;not_covered&#x60; naming the ETF (\&quot;TQQQ is an ETF: … exists only for companies\&quot;); on the other lists a series ETF such as TQQQ is not a known company. | [Optional] [Defaults to `undefined`] |
77
+ | **company** | `string` | Ticker (&#x60;AAPL&#x60;) 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: &#x60;/v1/dividends&#x60;, &#x60;/v1/splits&#x60;, &#x60;/v1/filings&#x60; and &#x60;/v1/search/filings&#x60; (a trust series\&#39; filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\&#39;s; a row\&#39;s &#x60;company.cik&#x60; is the trust\&#39;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 &#x60;not_covered&#x60; naming it: holders are found by issuer CIK, which would mix its trust\&#39;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 &#x60;not_covered&#x60; naming the ETF, the same for SPY and TQQQ (\&quot;TQQQ is an ETF: … exists only for companies\&quot;); 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 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)
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 (&#x60;AAPL&#x60;) 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 &#x60;/v1/dividends&#x60;, &#x60;/v1/splits&#x60; and &#x60;/v1/filings&#x60; (a trust series\&#39; filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\&#39;s; a row\&#39;s &#x60;company.cik&#x60; is the trust\&#39;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 &#x60;not_covered&#x60; naming the ETF (\&quot;TQQQ is an ETF: … exists only for companies\&quot;); on the other lists a series ETF such as TQQQ is not a known company. | [Optional] [Defaults to `undefined`] |
178
+ | **company** | `string` | Ticker (&#x60;AAPL&#x60;) 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: &#x60;/v1/dividends&#x60;, &#x60;/v1/splits&#x60;, &#x60;/v1/filings&#x60; and &#x60;/v1/search/filings&#x60; (a trust series\&#39; filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\&#39;s; a row\&#39;s &#x60;company.cik&#x60; is the trust\&#39;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 &#x60;not_covered&#x60; naming it: holders are found by issuer CIK, which would mix its trust\&#39;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 &#x60;not_covered&#x60; naming the ETF, the same for SPY and TQQQ (\&quot;TQQQ is an ETF: … exists only for companies\&quot;); 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 (&#x60;-&#x60; &#x3D; descending); the id tiebreaker is always appended. Default &#x60;-conference_date&#x60; | [Optional] [Defaults to `&#39;-conference_date&#39;`] [Enum: conference_date, -conference_date] |