@invinite-org/data-api-client 6.1.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.
Files changed (41) hide show
  1. package/dist/apis/FilingsApi.d.ts +2 -2
  2. package/dist/apis/FilingsApi.js +2 -2
  3. package/dist/apis/ReferenceApi.d.ts +4 -4
  4. package/dist/apis/ReferenceApi.js +4 -4
  5. package/dist/esm/apis/FilingsApi.d.ts +2 -2
  6. package/dist/esm/apis/FilingsApi.js +2 -2
  7. package/dist/esm/apis/ReferenceApi.d.ts +4 -4
  8. package/dist/esm/apis/ReferenceApi.js +4 -4
  9. package/dist/esm/models/AlertCondition.d.ts +3 -3
  10. package/dist/esm/models/AlertConditionInput.d.ts +3 -3
  11. package/dist/esm/models/Company.d.ts +8 -8
  12. package/dist/esm/models/CompanyListItem.d.ts +1 -1
  13. package/dist/esm/models/CompanyRef.d.ts +1 -1
  14. package/dist/models/AlertCondition.d.ts +3 -3
  15. package/dist/models/AlertConditionInput.d.ts +3 -3
  16. package/dist/models/Company.d.ts +8 -8
  17. package/dist/models/CompanyListItem.d.ts +1 -1
  18. package/dist/models/CompanyRef.d.ts +1 -1
  19. package/docs/AlertCondition.md +1 -1
  20. package/docs/AlertConditionInput.md +1 -1
  21. package/docs/CompaniesApi.md +2 -2
  22. package/docs/EventsApi.md +2 -2
  23. package/docs/FilingsApi.md +5 -5
  24. package/docs/FinancialsApi.md +12 -12
  25. package/docs/GuidanceApi.md +4 -4
  26. package/docs/HoldingsApi.md +6 -6
  27. package/docs/IPOsApi.md +2 -2
  28. package/docs/InsiderTradesApi.md +2 -2
  29. package/docs/InvestorDocumentsApi.md +4 -4
  30. package/docs/MetricsApi.md +10 -10
  31. package/docs/NewsApi.md +6 -6
  32. package/docs/ReferenceApi.md +8 -8
  33. package/docs/TranscriptsApi.md +2 -2
  34. package/package.json +1 -1
  35. package/src/apis/FilingsApi.ts +2 -2
  36. package/src/apis/ReferenceApi.ts +4 -4
  37. package/src/models/AlertCondition.ts +3 -3
  38. package/src/models/AlertConditionInput.ts +3 -3
  39. package/src/models/Company.ts +8 -8
  40. package/src/models/CompanyListItem.ts +1 -1
  41. package/src/models/CompanyRef.ts +1 -1
@@ -154,12 +154,12 @@ export declare class FilingsApi extends runtime.BaseAPI {
154
154
  */
155
155
  listFilingsRequestOpts(requestParameters: ListFilingsRequest): Promise<runtime.RequestOpts>;
156
156
  /**
157
- * 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.
157
+ * 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.
158
158
  * List filings
159
159
  */
160
160
  listFilingsRaw(requestParameters: ListFilingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListFilings200Response>>;
161
161
  /**
162
- * 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.
162
+ * 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.
163
163
  * List filings
164
164
  */
165
165
  listFilings(requestParameters: ListFilingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListFilings200Response>;
@@ -382,7 +382,7 @@ class FilingsApi extends runtime.BaseAPI {
382
382
  });
383
383
  }
384
384
  /**
385
- * 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.
385
+ * 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.
386
386
  * List filings
387
387
  */
388
388
  listFilingsRaw(requestParameters, initOverrides) {
@@ -393,7 +393,7 @@ class FilingsApi extends runtime.BaseAPI {
393
393
  });
394
394
  }
395
395
  /**
396
- * 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.
396
+ * 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.
397
397
  * List filings
398
398
  */
399
399
  listFilings(requestParameters, initOverrides) {
@@ -58,12 +58,12 @@ export declare class ReferenceApi extends runtime.BaseAPI {
58
58
  */
59
59
  listDividendsRequestOpts(requestParameters: ListDividendsRequest): Promise<runtime.RequestOpts>;
60
60
  /**
61
- *
61
+ * Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
62
62
  * List dividends
63
63
  */
64
64
  listDividendsRaw(requestParameters: ListDividendsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListDividends200Response>>;
65
65
  /**
66
- *
66
+ * Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
67
67
  * List dividends
68
68
  */
69
69
  listDividends(requestParameters: ListDividendsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListDividends200Response>;
@@ -100,12 +100,12 @@ export declare class ReferenceApi extends runtime.BaseAPI {
100
100
  */
101
101
  listSplitsRequestOpts(requestParameters: ListSplitsRequest): Promise<runtime.RequestOpts>;
102
102
  /**
103
- *
103
+ * Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
104
104
  * List stock splits
105
105
  */
106
106
  listSplitsRaw(requestParameters: ListSplitsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListSplits200Response>>;
107
107
  /**
108
- *
108
+ * Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
109
109
  * List stock splits
110
110
  */
111
111
  listSplits(requestParameters: ListSplitsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListSplits200Response>;
@@ -86,7 +86,7 @@ class ReferenceApi extends runtime.BaseAPI {
86
86
  });
87
87
  }
88
88
  /**
89
- *
89
+ * Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
90
90
  * List dividends
91
91
  */
92
92
  listDividendsRaw(requestParameters, initOverrides) {
@@ -97,7 +97,7 @@ class ReferenceApi extends runtime.BaseAPI {
97
97
  });
98
98
  }
99
99
  /**
100
- *
100
+ * Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
101
101
  * List dividends
102
102
  */
103
103
  listDividends(requestParameters, initOverrides) {
@@ -278,7 +278,7 @@ class ReferenceApi extends runtime.BaseAPI {
278
278
  });
279
279
  }
280
280
  /**
281
- *
281
+ * Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
282
282
  * List stock splits
283
283
  */
284
284
  listSplitsRaw(requestParameters, initOverrides) {
@@ -289,7 +289,7 @@ class ReferenceApi extends runtime.BaseAPI {
289
289
  });
290
290
  }
291
291
  /**
292
- *
292
+ * Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
293
293
  * List stock splits
294
294
  */
295
295
  listSplits(requestParameters, initOverrides) {
@@ -154,12 +154,12 @@ export declare class FilingsApi extends runtime.BaseAPI {
154
154
  */
155
155
  listFilingsRequestOpts(requestParameters: ListFilingsRequest): Promise<runtime.RequestOpts>;
156
156
  /**
157
- * 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.
157
+ * 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.
158
158
  * List filings
159
159
  */
160
160
  listFilingsRaw(requestParameters: ListFilingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListFilings200Response>>;
161
161
  /**
162
- * 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.
162
+ * 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.
163
163
  * List filings
164
164
  */
165
165
  listFilings(requestParameters: ListFilingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListFilings200Response>;
@@ -379,7 +379,7 @@ export class FilingsApi extends runtime.BaseAPI {
379
379
  });
380
380
  }
381
381
  /**
382
- * 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.
382
+ * 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.
383
383
  * List filings
384
384
  */
385
385
  listFilingsRaw(requestParameters, initOverrides) {
@@ -390,7 +390,7 @@ export class FilingsApi extends runtime.BaseAPI {
390
390
  });
391
391
  }
392
392
  /**
393
- * 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.
393
+ * 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.
394
394
  * List filings
395
395
  */
396
396
  listFilings(requestParameters, initOverrides) {
@@ -58,12 +58,12 @@ export declare class ReferenceApi extends runtime.BaseAPI {
58
58
  */
59
59
  listDividendsRequestOpts(requestParameters: ListDividendsRequest): Promise<runtime.RequestOpts>;
60
60
  /**
61
- *
61
+ * Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
62
62
  * List dividends
63
63
  */
64
64
  listDividendsRaw(requestParameters: ListDividendsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListDividends200Response>>;
65
65
  /**
66
- *
66
+ * Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
67
67
  * List dividends
68
68
  */
69
69
  listDividends(requestParameters: ListDividendsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListDividends200Response>;
@@ -100,12 +100,12 @@ export declare class ReferenceApi extends runtime.BaseAPI {
100
100
  */
101
101
  listSplitsRequestOpts(requestParameters: ListSplitsRequest): Promise<runtime.RequestOpts>;
102
102
  /**
103
- *
103
+ * Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
104
104
  * List stock splits
105
105
  */
106
106
  listSplitsRaw(requestParameters: ListSplitsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListSplits200Response>>;
107
107
  /**
108
- *
108
+ * Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
109
109
  * List stock splits
110
110
  */
111
111
  listSplits(requestParameters: ListSplitsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListSplits200Response>;
@@ -83,7 +83,7 @@ export class ReferenceApi extends runtime.BaseAPI {
83
83
  });
84
84
  }
85
85
  /**
86
- *
86
+ * Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
87
87
  * List dividends
88
88
  */
89
89
  listDividendsRaw(requestParameters, initOverrides) {
@@ -94,7 +94,7 @@ export class ReferenceApi extends runtime.BaseAPI {
94
94
  });
95
95
  }
96
96
  /**
97
- *
97
+ * Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
98
98
  * List dividends
99
99
  */
100
100
  listDividends(requestParameters, initOverrides) {
@@ -275,7 +275,7 @@ export class ReferenceApi extends runtime.BaseAPI {
275
275
  });
276
276
  }
277
277
  /**
278
- *
278
+ * Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
279
279
  * List stock splits
280
280
  */
281
281
  listSplitsRaw(requestParameters, initOverrides) {
@@ -286,7 +286,7 @@ export class ReferenceApi extends runtime.BaseAPI {
286
286
  });
287
287
  }
288
288
  /**
289
- *
289
+ * Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
290
290
  * List stock splits
291
291
  */
292
292
  listSplits(requestParameters, initOverrides) {
@@ -15,7 +15,7 @@ import type { AlertConditionRulesInner } from './AlertConditionRulesInner';
15
15
  import type { AlertConditionYieldRule } from './AlertConditionYieldRule';
16
16
  import type { AlertConditionYoyRulesInner } from './AlertConditionYoyRulesInner';
17
17
  /**
18
- * 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`) watch ONE instrument: `symbol` + `asset_class`. 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.
18
+ * 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`) watch ONE instrument: `symbol` + `asset_class`. 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.
19
19
  * @export
20
20
  * @interface AlertCondition
21
21
  */
@@ -27,7 +27,7 @@ export interface AlertCondition {
27
27
  */
28
28
  ciks?: Array<string>;
29
29
  /**
30
- * Companies by ticker. Same types as `ciks`
30
+ * Companies by ticker. Same types as `ciks`; a US ETF ticker for the types that take ETFs
31
31
  * @type {Array<string>}
32
32
  * @memberof AlertCondition
33
33
  */
@@ -39,7 +39,7 @@ export interface AlertCondition {
39
39
  */
40
40
  cik?: string;
41
41
  /**
42
- * The company by ticker. Same types as `cik`; price types: the instrument (a US stock / ETF ticker, or a crypto slug / ticker)
42
+ * The company (or, for the types that take ETFs, the US ETF) by ticker. Same types as `cik`; price types: the instrument (a US stock / ETF ticker, or a crypto slug / ticker)
43
43
  * @type {string}
44
44
  * @memberof AlertCondition
45
45
  */
@@ -15,7 +15,7 @@ import type { AlertConditionInputYoyRulesInner } from './AlertConditionInputYoyR
15
15
  import type { AlertConditionInputRulesInner } from './AlertConditionInputRulesInner';
16
16
  import type { AlertConditionInputYieldRule } from './AlertConditionInputYieldRule';
17
17
  /**
18
- * 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`) watch ONE instrument: `symbol` + `asset_class`. 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)
18
+ * 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`) watch ONE instrument: `symbol` + `asset_class`. 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.
19
19
  * @export
20
20
  * @interface AlertConditionInput
21
21
  */
@@ -27,7 +27,7 @@ export interface AlertConditionInput {
27
27
  */
28
28
  ciks?: Array<string>;
29
29
  /**
30
- * Companies by ticker. Same types as `ciks`
30
+ * Companies by ticker. Same types as `ciks`; a US ETF ticker for the types that take ETFs
31
31
  * @type {Array<string>}
32
32
  * @memberof AlertConditionInput
33
33
  */
@@ -39,7 +39,7 @@ export interface AlertConditionInput {
39
39
  */
40
40
  cik?: string;
41
41
  /**
42
- * The company by ticker. Same types as `cik`; price types: the instrument (a US stock / ETF ticker, or a crypto slug / ticker)
42
+ * The company (or, for the types that take ETFs, the US ETF) by ticker. Same types as `cik`; price types: the instrument (a US stock / ETF ticker, or a crypto slug / ticker)
43
43
  * @type {string}
44
44
  * @memberof AlertConditionInput
45
45
  */
@@ -47,23 +47,23 @@ export interface Company {
47
47
  */
48
48
  category: string;
49
49
  /**
50
- * Sector, from the issuer's SIC code (SEC mapping)
50
+ * Sector, from the issuer's SIC code (SEC mapping); null for a US ETF (no SIC-derived values are shown for a fund)
51
51
  * @type {string}
52
52
  * @memberof Company
53
53
  */
54
- sector: string;
54
+ sector: string | null;
55
55
  /**
56
- * Industry, from the issuer's SIC code (SEC mapping)
56
+ * Industry, from the issuer's SIC code (SEC mapping); null for a US ETF (no SIC-derived values are shown for a fund)
57
57
  * @type {string}
58
58
  * @memberof Company
59
59
  */
60
- industry: string;
60
+ industry: string | null;
61
61
  /**
62
- * SIC code
62
+ * SIC code; null for a US ETF (no SIC-derived values are shown for a fund)
63
63
  * @type {string}
64
64
  * @memberof Company
65
65
  */
66
- sic: string;
66
+ sic: string | null;
67
67
  /**
68
68
  * Fama-French sector
69
69
  * @type {string}
@@ -197,13 +197,13 @@ export interface Company {
197
197
  */
198
198
  street: string | null;
199
199
  /**
200
- * City
200
+ * City; null for a US ETF
201
201
  * @type {string}
202
202
  * @memberof Company
203
203
  */
204
204
  city: string | null;
205
205
  /**
206
- * State or province
206
+ * State or province; null for a US ETF
207
207
  * @type {string}
208
208
  * @memberof Company
209
209
  */
@@ -40,7 +40,7 @@ export interface CompanyListItem {
40
40
  */
41
41
  exchange: string | null;
42
42
  /**
43
- * Sector
43
+ * Sector; null for a US ETF
44
44
  * @type {string}
45
45
  * @memberof CompanyListItem
46
46
  */
@@ -16,7 +16,7 @@
16
16
  */
17
17
  export interface CompanyRef {
18
18
  /**
19
- * SEC CIK, 10 digits
19
+ * SEC CIK, 10 digits; for a US ETF that is a series of a trust (TQQQ) the trust's CIK, empty ("") for such an ETF without a registrant link
20
20
  * @type {string}
21
21
  * @memberof CompanyRef
22
22
  */
@@ -15,7 +15,7 @@ import type { AlertConditionRulesInner } from './AlertConditionRulesInner';
15
15
  import type { AlertConditionYieldRule } from './AlertConditionYieldRule';
16
16
  import type { AlertConditionYoyRulesInner } from './AlertConditionYoyRulesInner';
17
17
  /**
18
- * 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`) watch ONE instrument: `symbol` + `asset_class`. 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.
18
+ * 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`) watch ONE instrument: `symbol` + `asset_class`. 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.
19
19
  * @export
20
20
  * @interface AlertCondition
21
21
  */
@@ -27,7 +27,7 @@ export interface AlertCondition {
27
27
  */
28
28
  ciks?: Array<string>;
29
29
  /**
30
- * Companies by ticker. Same types as `ciks`
30
+ * Companies by ticker. Same types as `ciks`; a US ETF ticker for the types that take ETFs
31
31
  * @type {Array<string>}
32
32
  * @memberof AlertCondition
33
33
  */
@@ -39,7 +39,7 @@ export interface AlertCondition {
39
39
  */
40
40
  cik?: string;
41
41
  /**
42
- * The company by ticker. Same types as `cik`; price types: the instrument (a US stock / ETF ticker, or a crypto slug / ticker)
42
+ * The company (or, for the types that take ETFs, the US ETF) by ticker. Same types as `cik`; price types: the instrument (a US stock / ETF ticker, or a crypto slug / ticker)
43
43
  * @type {string}
44
44
  * @memberof AlertCondition
45
45
  */
@@ -15,7 +15,7 @@ import type { AlertConditionInputYoyRulesInner } from './AlertConditionInputYoyR
15
15
  import type { AlertConditionInputRulesInner } from './AlertConditionInputRulesInner';
16
16
  import type { AlertConditionInputYieldRule } from './AlertConditionInputYieldRule';
17
17
  /**
18
- * 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`) watch ONE instrument: `symbol` + `asset_class`. 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)
18
+ * 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`) watch ONE instrument: `symbol` + `asset_class`. 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.
19
19
  * @export
20
20
  * @interface AlertConditionInput
21
21
  */
@@ -27,7 +27,7 @@ export interface AlertConditionInput {
27
27
  */
28
28
  ciks?: Array<string>;
29
29
  /**
30
- * Companies by ticker. Same types as `ciks`
30
+ * Companies by ticker. Same types as `ciks`; a US ETF ticker for the types that take ETFs
31
31
  * @type {Array<string>}
32
32
  * @memberof AlertConditionInput
33
33
  */
@@ -39,7 +39,7 @@ export interface AlertConditionInput {
39
39
  */
40
40
  cik?: string;
41
41
  /**
42
- * The company by ticker. Same types as `cik`; price types: the instrument (a US stock / ETF ticker, or a crypto slug / ticker)
42
+ * The company (or, for the types that take ETFs, the US ETF) by ticker. Same types as `cik`; price types: the instrument (a US stock / ETF ticker, or a crypto slug / ticker)
43
43
  * @type {string}
44
44
  * @memberof AlertConditionInput
45
45
  */
@@ -47,23 +47,23 @@ export interface Company {
47
47
  */
48
48
  category: string;
49
49
  /**
50
- * Sector, from the issuer's SIC code (SEC mapping)
50
+ * Sector, from the issuer's SIC code (SEC mapping); null for a US ETF (no SIC-derived values are shown for a fund)
51
51
  * @type {string}
52
52
  * @memberof Company
53
53
  */
54
- sector: string;
54
+ sector: string | null;
55
55
  /**
56
- * Industry, from the issuer's SIC code (SEC mapping)
56
+ * Industry, from the issuer's SIC code (SEC mapping); null for a US ETF (no SIC-derived values are shown for a fund)
57
57
  * @type {string}
58
58
  * @memberof Company
59
59
  */
60
- industry: string;
60
+ industry: string | null;
61
61
  /**
62
- * SIC code
62
+ * SIC code; null for a US ETF (no SIC-derived values are shown for a fund)
63
63
  * @type {string}
64
64
  * @memberof Company
65
65
  */
66
- sic: string;
66
+ sic: string | null;
67
67
  /**
68
68
  * Fama-French sector
69
69
  * @type {string}
@@ -197,13 +197,13 @@ export interface Company {
197
197
  */
198
198
  street: string | null;
199
199
  /**
200
- * City
200
+ * City; null for a US ETF
201
201
  * @type {string}
202
202
  * @memberof Company
203
203
  */
204
204
  city: string | null;
205
205
  /**
206
- * State or province
206
+ * State or province; null for a US ETF
207
207
  * @type {string}
208
208
  * @memberof Company
209
209
  */
@@ -40,7 +40,7 @@ export interface CompanyListItem {
40
40
  */
41
41
  exchange: string | null;
42
42
  /**
43
- * Sector
43
+ * Sector; null for a US ETF
44
44
  * @type {string}
45
45
  * @memberof CompanyListItem
46
46
  */
@@ -16,7 +16,7 @@
16
16
  */
17
17
  export interface CompanyRef {
18
18
  /**
19
- * SEC CIK, 10 digits
19
+ * SEC CIK, 10 digits; for a US ETF that is a series of a trust (TQQQ) the trust's CIK, empty ("") for such an ETF without a registrant link
20
20
  * @type {string}
21
21
  * @memberof CompanyRef
22
22
  */
@@ -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`) watch ONE instrument: `symbol` + `asset_class`. 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.
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`) watch ONE instrument: `symbol` + `asset_class`. 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.
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`) watch ONE instrument: `symbol` + `asset_class`. 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)
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`) watch ONE instrument: `symbol` + `asset_class`. 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.
5
5
 
6
6
  ## Properties
7
7
 
@@ -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. (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 `/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)
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. | [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 &#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`] |
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. (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 `/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)
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. | [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 &#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`] |
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`] |
@@ -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; &#x60;meta.form_facet&#x60; sums the forms of the companies read on the page. &#x60;items&#x60; is applied to the store’s pages, so a page can hold fewer than &#x60;limit&#x60; rows while &#x60;has_more&#x60; is true; follow &#x60;next_cursor&#x60; until &#x60;has_more&#x60; 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; &#x60;meta.form_facet&#x60; sums the forms of the companies read on the page. &#x60;items&#x60; is applied to the store’s pages, so a page can hold fewer than &#x60;limit&#x60; rows while &#x60;has_more&#x60; is true; follow &#x60;next_cursor&#x60; until &#x60;has_more&#x60; is false. For a US ETF that is a series of a multi-series trust (TQQQ), only the accessions naming its series (&#x60;series_id&#x60;) are listed, never the whole trust; an ETF that is its own SEC registrant (SPY, QQQ) lists its registrant\&#39;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 (&#x60;AAPL&#x60;) 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 (&#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`] |
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. (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 &#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. | [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 &#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`] |
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`] |