@invinite-org/data-api-client 6.2.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.
Files changed (208) hide show
  1. package/.openapi-generator/FILES +52 -0
  2. package/dist/apis/ScriptsApi.d.ts +148 -0
  3. package/dist/apis/ScriptsApi.js +396 -0
  4. package/dist/apis/index.d.ts +1 -0
  5. package/dist/apis/index.js +1 -0
  6. package/dist/esm/apis/ScriptsApi.d.ts +148 -0
  7. package/dist/esm/apis/ScriptsApi.js +392 -0
  8. package/dist/esm/apis/index.d.ts +1 -0
  9. package/dist/esm/apis/index.js +1 -0
  10. package/dist/esm/models/Alert.d.ts +6 -0
  11. package/dist/esm/models/Alert.js +4 -0
  12. package/dist/esm/models/AlertCondition.d.ts +61 -5
  13. package/dist/esm/models/AlertCondition.js +27 -1
  14. package/dist/esm/models/AlertConditionInput.d.ts +54 -5
  15. package/dist/esm/models/AlertConditionInput.js +24 -1
  16. package/dist/esm/models/AlertTemplate.d.ts +83 -0
  17. package/dist/esm/models/AlertTemplate.js +79 -0
  18. package/dist/esm/models/AlertTemplateInput.d.ts +78 -0
  19. package/dist/esm/models/AlertTemplateInput.js +70 -0
  20. package/dist/esm/models/AlertTrigger.d.ts +1 -1
  21. package/dist/esm/models/AlertTriggerInput.d.ts +1 -1
  22. package/dist/esm/models/Company.d.ts +6 -6
  23. package/dist/esm/models/CreateScriptRequest.d.ts +44 -0
  24. package/dist/esm/models/CreateScriptRequest.js +49 -0
  25. package/dist/esm/models/CreateScriptVersionRequest.d.ts +32 -0
  26. package/dist/esm/models/CreateScriptVersionRequest.js +43 -0
  27. package/dist/esm/models/IndicatorCondition.d.ts +56 -0
  28. package/dist/esm/models/IndicatorCondition.js +62 -0
  29. package/dist/esm/models/IndicatorConditionInput.d.ts +56 -0
  30. package/dist/esm/models/IndicatorConditionInput.js +62 -0
  31. package/dist/esm/models/IndicatorFilterChild.d.ts +68 -0
  32. package/dist/esm/models/IndicatorFilterChild.js +65 -0
  33. package/dist/esm/models/IndicatorFilterChildInput.d.ts +68 -0
  34. package/dist/esm/models/IndicatorFilterChildInput.js +65 -0
  35. package/dist/esm/models/IndicatorFilterCondition.d.ts +73 -0
  36. package/dist/esm/models/IndicatorFilterCondition.js +74 -0
  37. package/dist/esm/models/IndicatorFilterConditionInput.d.ts +73 -0
  38. package/dist/esm/models/IndicatorFilterConditionInput.js +74 -0
  39. package/dist/esm/models/IndicatorFilterLeaf.d.ts +46 -0
  40. package/dist/esm/models/IndicatorFilterLeaf.js +54 -0
  41. package/dist/esm/models/IndicatorFilterLeafInput.d.ts +46 -0
  42. package/dist/esm/models/IndicatorFilterLeafInput.js +56 -0
  43. package/dist/esm/models/IndicatorFilters.d.ts +47 -0
  44. package/dist/esm/models/IndicatorFilters.js +55 -0
  45. package/dist/esm/models/IndicatorFiltersInput.d.ts +47 -0
  46. package/dist/esm/models/IndicatorFiltersInput.js +55 -0
  47. package/dist/esm/models/IndicatorOperand.d.ts +91 -0
  48. package/dist/esm/models/IndicatorOperand.js +74 -0
  49. package/dist/esm/models/IndicatorOperandInput.d.ts +91 -0
  50. package/dist/esm/models/IndicatorOperandInput.js +74 -0
  51. package/dist/esm/models/IndicatorResolved.d.ts +67 -0
  52. package/dist/esm/models/IndicatorResolved.js +65 -0
  53. package/dist/esm/models/IndicatorResolvedThreshold.d.ts +47 -0
  54. package/dist/esm/models/IndicatorResolvedThreshold.js +55 -0
  55. package/dist/esm/models/IndicatorTemplateRef.d.ts +46 -0
  56. package/dist/esm/models/IndicatorTemplateRef.js +47 -0
  57. package/dist/esm/models/ListAlertTemplates200Response.d.ts +52 -0
  58. package/dist/esm/models/ListAlertTemplates200Response.js +57 -0
  59. package/dist/esm/models/ListScriptVersions200Response.d.ts +52 -0
  60. package/dist/esm/models/ListScriptVersions200Response.js +57 -0
  61. package/dist/esm/models/ListScripts200Response.d.ts +52 -0
  62. package/dist/esm/models/ListScripts200Response.js +57 -0
  63. package/dist/esm/models/Script.d.ts +69 -0
  64. package/dist/esm/models/Script.js +68 -0
  65. package/dist/esm/models/ScriptDiagnostic.d.ts +64 -0
  66. package/dist/esm/models/ScriptDiagnostic.js +66 -0
  67. package/dist/esm/models/ScriptVersion.d.ts +103 -0
  68. package/dist/esm/models/ScriptVersion.js +91 -0
  69. package/dist/esm/models/index.d.ts +25 -0
  70. package/dist/esm/models/index.js +25 -0
  71. package/dist/models/Alert.d.ts +6 -0
  72. package/dist/models/Alert.js +4 -0
  73. package/dist/models/AlertCondition.d.ts +61 -5
  74. package/dist/models/AlertCondition.js +27 -1
  75. package/dist/models/AlertConditionInput.d.ts +54 -5
  76. package/dist/models/AlertConditionInput.js +24 -1
  77. package/dist/models/AlertTemplate.d.ts +83 -0
  78. package/dist/models/AlertTemplate.js +87 -0
  79. package/dist/models/AlertTemplateInput.d.ts +78 -0
  80. package/dist/models/AlertTemplateInput.js +78 -0
  81. package/dist/models/AlertTrigger.d.ts +1 -1
  82. package/dist/models/AlertTriggerInput.d.ts +1 -1
  83. package/dist/models/Company.d.ts +6 -6
  84. package/dist/models/CreateScriptRequest.d.ts +44 -0
  85. package/dist/models/CreateScriptRequest.js +56 -0
  86. package/dist/models/CreateScriptVersionRequest.d.ts +32 -0
  87. package/dist/models/CreateScriptVersionRequest.js +50 -0
  88. package/dist/models/IndicatorCondition.d.ts +56 -0
  89. package/dist/models/IndicatorCondition.js +70 -0
  90. package/dist/models/IndicatorConditionInput.d.ts +56 -0
  91. package/dist/models/IndicatorConditionInput.js +70 -0
  92. package/dist/models/IndicatorFilterChild.d.ts +68 -0
  93. package/dist/models/IndicatorFilterChild.js +73 -0
  94. package/dist/models/IndicatorFilterChildInput.d.ts +68 -0
  95. package/dist/models/IndicatorFilterChildInput.js +73 -0
  96. package/dist/models/IndicatorFilterCondition.d.ts +73 -0
  97. package/dist/models/IndicatorFilterCondition.js +82 -0
  98. package/dist/models/IndicatorFilterConditionInput.d.ts +73 -0
  99. package/dist/models/IndicatorFilterConditionInput.js +82 -0
  100. package/dist/models/IndicatorFilterLeaf.d.ts +46 -0
  101. package/dist/models/IndicatorFilterLeaf.js +62 -0
  102. package/dist/models/IndicatorFilterLeafInput.d.ts +46 -0
  103. package/dist/models/IndicatorFilterLeafInput.js +64 -0
  104. package/dist/models/IndicatorFilters.d.ts +47 -0
  105. package/dist/models/IndicatorFilters.js +63 -0
  106. package/dist/models/IndicatorFiltersInput.d.ts +47 -0
  107. package/dist/models/IndicatorFiltersInput.js +63 -0
  108. package/dist/models/IndicatorOperand.d.ts +91 -0
  109. package/dist/models/IndicatorOperand.js +82 -0
  110. package/dist/models/IndicatorOperandInput.d.ts +91 -0
  111. package/dist/models/IndicatorOperandInput.js +82 -0
  112. package/dist/models/IndicatorResolved.d.ts +67 -0
  113. package/dist/models/IndicatorResolved.js +73 -0
  114. package/dist/models/IndicatorResolvedThreshold.d.ts +47 -0
  115. package/dist/models/IndicatorResolvedThreshold.js +63 -0
  116. package/dist/models/IndicatorTemplateRef.d.ts +46 -0
  117. package/dist/models/IndicatorTemplateRef.js +54 -0
  118. package/dist/models/ListAlertTemplates200Response.d.ts +52 -0
  119. package/dist/models/ListAlertTemplates200Response.js +64 -0
  120. package/dist/models/ListScriptVersions200Response.d.ts +52 -0
  121. package/dist/models/ListScriptVersions200Response.js +64 -0
  122. package/dist/models/ListScripts200Response.d.ts +52 -0
  123. package/dist/models/ListScripts200Response.js +64 -0
  124. package/dist/models/Script.d.ts +69 -0
  125. package/dist/models/Script.js +75 -0
  126. package/dist/models/ScriptDiagnostic.d.ts +64 -0
  127. package/dist/models/ScriptDiagnostic.js +74 -0
  128. package/dist/models/ScriptVersion.d.ts +103 -0
  129. package/dist/models/ScriptVersion.js +99 -0
  130. package/dist/models/index.d.ts +25 -0
  131. package/dist/models/index.js +25 -0
  132. package/docs/Alert.md +2 -0
  133. package/docs/AlertCondition.md +15 -1
  134. package/docs/AlertConditionInput.md +13 -1
  135. package/docs/AlertTemplate.md +49 -0
  136. package/docs/AlertTemplateInput.md +47 -0
  137. package/docs/CompaniesApi.md +4 -4
  138. package/docs/CreateScriptRequest.md +38 -0
  139. package/docs/CreateScriptVersionRequest.md +34 -0
  140. package/docs/EventsApi.md +2 -2
  141. package/docs/FilingsApi.md +4 -4
  142. package/docs/FinancialsApi.md +12 -12
  143. package/docs/GuidanceApi.md +4 -4
  144. package/docs/HoldingsApi.md +8 -8
  145. package/docs/IPOsApi.md +4 -4
  146. package/docs/IndicatorCondition.md +39 -0
  147. package/docs/IndicatorConditionInput.md +39 -0
  148. package/docs/IndicatorFilterChild.md +41 -0
  149. package/docs/IndicatorFilterChildInput.md +41 -0
  150. package/docs/IndicatorFilterCondition.md +41 -0
  151. package/docs/IndicatorFilterConditionInput.md +41 -0
  152. package/docs/IndicatorFilterLeaf.md +37 -0
  153. package/docs/IndicatorFilterLeafInput.md +37 -0
  154. package/docs/IndicatorFilters.md +37 -0
  155. package/docs/IndicatorFiltersInput.md +37 -0
  156. package/docs/IndicatorOperand.md +47 -0
  157. package/docs/IndicatorOperandInput.md +47 -0
  158. package/docs/IndicatorResolved.md +43 -0
  159. package/docs/IndicatorResolvedThreshold.md +37 -0
  160. package/docs/IndicatorTemplateRef.md +39 -0
  161. package/docs/InsiderTradesApi.md +2 -2
  162. package/docs/InvestorDocumentsApi.md +4 -4
  163. package/docs/ListAlertTemplates200Response.md +41 -0
  164. package/docs/ListScriptVersions200Response.md +41 -0
  165. package/docs/ListScripts200Response.md +41 -0
  166. package/docs/MetricsApi.md +10 -10
  167. package/docs/NewsApi.md +6 -6
  168. package/docs/ReferenceApi.md +6 -6
  169. package/docs/Script.md +46 -0
  170. package/docs/ScriptDiagnostic.md +42 -0
  171. package/docs/ScriptVersion.md +54 -0
  172. package/docs/ScriptsApi.md +588 -0
  173. package/docs/TranscriptsApi.md +2 -2
  174. package/package.json +1 -1
  175. package/src/apis/ScriptsApi.ts +504 -0
  176. package/src/apis/index.ts +1 -0
  177. package/src/models/Alert.ts +9 -0
  178. package/src/models/AlertCondition.ts +98 -6
  179. package/src/models/AlertConditionInput.ts +83 -6
  180. package/src/models/AlertTemplate.ts +148 -0
  181. package/src/models/AlertTemplateInput.ts +130 -0
  182. package/src/models/AlertTrigger.ts +1 -1
  183. package/src/models/AlertTriggerInput.ts +1 -1
  184. package/src/models/Company.ts +6 -6
  185. package/src/models/CreateScriptRequest.ts +83 -0
  186. package/src/models/CreateScriptVersionRequest.ts +66 -0
  187. package/src/models/IndicatorCondition.ts +106 -0
  188. package/src/models/IndicatorConditionInput.ts +106 -0
  189. package/src/models/IndicatorFilterChild.ts +125 -0
  190. package/src/models/IndicatorFilterChildInput.ts +125 -0
  191. package/src/models/IndicatorFilterCondition.ts +126 -0
  192. package/src/models/IndicatorFilterConditionInput.ts +126 -0
  193. package/src/models/IndicatorFilterLeaf.ts +93 -0
  194. package/src/models/IndicatorFilterLeafInput.ts +95 -0
  195. package/src/models/IndicatorFilters.ts +94 -0
  196. package/src/models/IndicatorFiltersInput.ts +94 -0
  197. package/src/models/IndicatorOperand.ts +139 -0
  198. package/src/models/IndicatorOperandInput.ts +139 -0
  199. package/src/models/IndicatorResolved.ts +120 -0
  200. package/src/models/IndicatorResolvedThreshold.ts +87 -0
  201. package/src/models/IndicatorTemplateRef.ts +82 -0
  202. package/src/models/ListAlertTemplates200Response.ts +108 -0
  203. package/src/models/ListScriptVersions200Response.ts +108 -0
  204. package/src/models/ListScripts200Response.ts +108 -0
  205. package/src/models/Script.ts +128 -0
  206. package/src/models/ScriptDiagnostic.ts +113 -0
  207. package/src/models/ScriptVersion.ts +175 -0
  208. package/src/models/index.ts +25 -0
@@ -0,0 +1,43 @@
1
+
2
+ # IndicatorResolved
3
+
4
+ What the platform runs for an indicator alert (set at create, read-only: a value sent in a request is ignored).
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `script_version_id` | string
11
+ `inputs` | { [key: string]: any; }
12
+ `evaluation` | string
13
+ `summary` | string
14
+ `threshold` | [IndicatorResolvedThreshold](IndicatorResolvedThreshold.md)
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import type { IndicatorResolved } from '@invinite-org/data-api-client'
20
+
21
+ // TODO: Update the object below with actual values
22
+ const example = {
23
+ "script_version_id": null,
24
+ "inputs": null,
25
+ "evaluation": null,
26
+ "summary": null,
27
+ "threshold": null,
28
+ } satisfies IndicatorResolved
29
+
30
+ console.log(example)
31
+
32
+ // Convert the instance to a JSON string
33
+ const exampleJSON: string = JSON.stringify(example)
34
+ console.log(exampleJSON)
35
+
36
+ // Parse the JSON string back to an object
37
+ const exampleParsed = JSON.parse(exampleJSON) as IndicatorResolved
38
+ console.log(exampleParsed)
39
+ ```
40
+
41
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
42
+
43
+
@@ -0,0 +1,37 @@
1
+
2
+ # IndicatorResolvedThreshold
3
+
4
+ shared: the crossed constant
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `comparator` | string
11
+ `value` | number
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import type { IndicatorResolvedThreshold } from '@invinite-org/data-api-client'
17
+
18
+ // TODO: Update the object below with actual values
19
+ const example = {
20
+ "comparator": null,
21
+ "value": null,
22
+ } satisfies IndicatorResolvedThreshold
23
+
24
+ console.log(example)
25
+
26
+ // Convert the instance to a JSON string
27
+ const exampleJSON: string = JSON.stringify(example)
28
+ console.log(exampleJSON)
29
+
30
+ // Parse the JSON string back to an object
31
+ const exampleParsed = JSON.parse(exampleJSON) as IndicatorResolvedThreshold
32
+ console.log(exampleParsed)
33
+ ```
34
+
35
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
36
+
37
+
@@ -0,0 +1,39 @@
1
+
2
+ # IndicatorTemplateRef
3
+
4
+ A built-in template (`GET /v1/alert-templates`) and its inputs.
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `key` | string
11
+ `version` | number
12
+ `inputs` | { [key: string]: any; }
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import type { IndicatorTemplateRef } from '@invinite-org/data-api-client'
18
+
19
+ // TODO: Update the object below with actual values
20
+ const example = {
21
+ "key": null,
22
+ "version": null,
23
+ "inputs": null,
24
+ } satisfies IndicatorTemplateRef
25
+
26
+ console.log(example)
27
+
28
+ // Convert the instance to a JSON string
29
+ const exampleJSON: string = JSON.stringify(example)
30
+ console.log(exampleJSON)
31
+
32
+ // Parse the JSON string back to an object
33
+ const exampleParsed = JSON.parse(exampleJSON) as IndicatorTemplateRef
34
+ console.log(exampleParsed)
35
+ ```
36
+
37
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
38
+
39
+
@@ -118,7 +118,7 @@ async function example() {
118
118
  const api = new InsiderTradesApi(config);
119
119
 
120
120
  const body = {
121
- // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The 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.
121
+ // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer.
122
122
  company: AAPL,
123
123
  // 'buy' | 'sell' | buy = acquired, sell = disposed (optional)
124
124
  side: buy,
@@ -163,7 +163,7 @@ example().catch(console.error);
163
163
 
164
164
  | Name | Type | Description | Notes |
165
165
  |------------- | ------------- | ------------- | -------------|
166
- | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [Defaults to `undefined`] |
166
+ | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Defaults to `undefined`] |
167
167
  | **side** | `buy`, `sell` | buy = acquired, sell = disposed | [Optional] [Defaults to `undefined`] [Enum: buy, sell] |
168
168
  | **filedAtGte** | `Date` | `filed_at` on or after this value | [Optional] [Defaults to `undefined`] |
169
169
  | **filedAtGt** | `Date` | `filed_at` after this value | [Optional] [Defaults to `undefined`] |
@@ -119,7 +119,7 @@ async function example() {
119
119
  const api = new InvestorDocumentsApi(config);
120
120
 
121
121
  const body = {
122
- // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. 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)
122
+ // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on 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)
123
123
  company: AAPL,
124
124
  // string | Event id (optional)
125
125
  event: evt_01JC8M2X,
@@ -156,7 +156,7 @@ example().catch(console.error);
156
156
 
157
157
  | Name | Type | Description | Notes |
158
158
  |------------- | ------------- | ------------- | -------------|
159
- | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [Optional] [Defaults to `undefined`] |
159
+ | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Optional] [Defaults to `undefined`] |
160
160
  | **event** | `string` | Event id | [Optional] [Defaults to `undefined`] |
161
161
  | **category** | `string` | Categories, comma list | [Optional] [Defaults to `undefined`] |
162
162
  | **kind** | `string` | Kinds, comma list | [Optional] [Defaults to `undefined`] |
@@ -225,7 +225,7 @@ async function example() {
225
225
  const body = {
226
226
  // string | Query
227
227
  q: capital allocation,
228
- // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. 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)
228
+ // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on 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)
229
229
  company: AAPL,
230
230
  // string | Kinds, comma list (optional)
231
231
  kind: investor_presentation,
@@ -255,7 +255,7 @@ example().catch(console.error);
255
255
  | Name | Type | Description | Notes |
256
256
  |------------- | ------------- | ------------- | -------------|
257
257
  | **q** | `string` | Query | [Defaults to `undefined`] |
258
- | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [Optional] [Defaults to `undefined`] |
258
+ | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Optional] [Defaults to `undefined`] |
259
259
  | **kind** | `string` | Kinds, comma list | [Optional] [Defaults to `undefined`] |
260
260
  | **mode** | `lexical`, `literal` | Mode | [Optional] [Defaults to `'lexical'`] [Enum: lexical, literal] |
261
261
  | **limit** | `number` | Rows per page (default 25, max 200) | [Optional] [Defaults to `25`] |
@@ -0,0 +1,41 @@
1
+
2
+ # ListAlertTemplates200Response
3
+
4
+ A page of AlertTemplate rows (the list envelope, R3)
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `data` | [Array<AlertTemplate>](AlertTemplate.md)
11
+ `has_more` | boolean
12
+ `next_cursor` | string
13
+ `meta` | [ListCompanies200ResponseMeta](ListCompanies200ResponseMeta.md)
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import type { ListAlertTemplates200Response } from '@invinite-org/data-api-client'
19
+
20
+ // TODO: Update the object below with actual values
21
+ const example = {
22
+ "data": null,
23
+ "has_more": null,
24
+ "next_cursor": null,
25
+ "meta": null,
26
+ } satisfies ListAlertTemplates200Response
27
+
28
+ console.log(example)
29
+
30
+ // Convert the instance to a JSON string
31
+ const exampleJSON: string = JSON.stringify(example)
32
+ console.log(exampleJSON)
33
+
34
+ // Parse the JSON string back to an object
35
+ const exampleParsed = JSON.parse(exampleJSON) as ListAlertTemplates200Response
36
+ console.log(exampleParsed)
37
+ ```
38
+
39
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
40
+
41
+
@@ -0,0 +1,41 @@
1
+
2
+ # ListScriptVersions200Response
3
+
4
+ A page of ScriptVersion rows (the list envelope, R3)
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `data` | [Array<ScriptVersion>](ScriptVersion.md)
11
+ `has_more` | boolean
12
+ `next_cursor` | string
13
+ `meta` | [ListCompanies200ResponseMeta](ListCompanies200ResponseMeta.md)
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import type { ListScriptVersions200Response } from '@invinite-org/data-api-client'
19
+
20
+ // TODO: Update the object below with actual values
21
+ const example = {
22
+ "data": null,
23
+ "has_more": null,
24
+ "next_cursor": null,
25
+ "meta": null,
26
+ } satisfies ListScriptVersions200Response
27
+
28
+ console.log(example)
29
+
30
+ // Convert the instance to a JSON string
31
+ const exampleJSON: string = JSON.stringify(example)
32
+ console.log(exampleJSON)
33
+
34
+ // Parse the JSON string back to an object
35
+ const exampleParsed = JSON.parse(exampleJSON) as ListScriptVersions200Response
36
+ console.log(exampleParsed)
37
+ ```
38
+
39
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
40
+
41
+
@@ -0,0 +1,41 @@
1
+
2
+ # ListScripts200Response
3
+
4
+ A page of Script rows (the list envelope, R3)
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `data` | [Array<Script>](Script.md)
11
+ `has_more` | boolean
12
+ `next_cursor` | string
13
+ `meta` | [ListCompanies200ResponseMeta](ListCompanies200ResponseMeta.md)
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import type { ListScripts200Response } from '@invinite-org/data-api-client'
19
+
20
+ // TODO: Update the object below with actual values
21
+ const example = {
22
+ "data": null,
23
+ "has_more": null,
24
+ "next_cursor": null,
25
+ "meta": null,
26
+ } satisfies ListScripts200Response
27
+
28
+ console.log(example)
29
+
30
+ // Convert the instance to a JSON string
31
+ const exampleJSON: string = JSON.stringify(example)
32
+ console.log(exampleJSON)
33
+
34
+ // Parse the JSON string back to an object
35
+ const exampleParsed = JSON.parse(exampleJSON) as ListScripts200Response
36
+ console.log(exampleParsed)
37
+ ```
38
+
39
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
40
+
41
+
@@ -125,7 +125,7 @@ async function example() {
125
125
  const api = new MetricsApi(config);
126
126
 
127
127
  const body = {
128
- // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. 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.
128
+ // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on 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.
129
129
  company: AAPL,
130
130
  // 'annual' | 'quarterly' | 'ytd' | 'ttm' | Period type
131
131
  period: annual,
@@ -166,7 +166,7 @@ example().catch(console.error);
166
166
 
167
167
  | Name | Type | Description | Notes |
168
168
  |------------- | ------------- | ------------- | -------------|
169
- | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [Defaults to `undefined`] |
169
+ | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Defaults to `undefined`] |
170
170
  | **period** | `annual`, `quarterly`, `ytd`, `ttm` | Period type | [Defaults to `undefined`] [Enum: annual, quarterly, ytd, ttm] |
171
171
  | **horizon** | `3`, `5`, `10` | Years spanned | [Optional] [Defaults to `undefined`] [Enum: 3, 5, 10] |
172
172
  | **fiscalYearGte** | `number` | `fiscal_year` on or after this value | [Optional] [Defaults to `undefined`] |
@@ -235,7 +235,7 @@ async function example() {
235
235
  const api = new MetricsApi(config);
236
236
 
237
237
  const body = {
238
- // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. 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.
238
+ // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on 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.
239
239
  company: AAPL,
240
240
  // 'annual' | 'quarterly' | 'ytd' | 'ttm' | Period type
241
241
  period: annual,
@@ -276,7 +276,7 @@ example().catch(console.error);
276
276
 
277
277
  | Name | Type | Description | Notes |
278
278
  |------------- | ------------- | ------------- | -------------|
279
- | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [Defaults to `undefined`] |
279
+ | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Defaults to `undefined`] |
280
280
  | **period** | `annual`, `quarterly`, `ytd`, `ttm` | Period type | [Defaults to `undefined`] [Enum: annual, quarterly, ytd, ttm] |
281
281
  | **basis** | `yoy`, `qoq` | Comparison basis | [Optional] [Defaults to `'yoy'`] [Enum: yoy, qoq] |
282
282
  | **fiscalYearGte** | `number` | `fiscal_year` on or after this value | [Optional] [Defaults to `undefined`] |
@@ -345,7 +345,7 @@ async function example() {
345
345
  const api = new MetricsApi(config);
346
346
 
347
347
  const body = {
348
- // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. 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.
348
+ // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on 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.
349
349
  company: AAPL,
350
350
  // 'annual' | 'quarterly' | 'ytd' | 'ttm' | Period type
351
351
  period: annual,
@@ -386,7 +386,7 @@ example().catch(console.error);
386
386
 
387
387
  | Name | Type | Description | Notes |
388
388
  |------------- | ------------- | ------------- | -------------|
389
- | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [Defaults to `undefined`] |
389
+ | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Defaults to `undefined`] |
390
390
  | **period** | `annual`, `quarterly`, `ytd`, `ttm` | Period type | [Defaults to `undefined`] [Enum: annual, quarterly, ytd, ttm] |
391
391
  | **category** | `string` | Ratio categories — any of `profitability`, `liquidity`, `leverage`, `efficiency`, `valuation`, comma-separated | [Optional] [Defaults to `undefined`] |
392
392
  | **fiscalYearGte** | `number` | `fiscal_year` on or after this value | [Optional] [Defaults to `undefined`] |
@@ -455,7 +455,7 @@ async function example() {
455
455
  const api = new MetricsApi(config);
456
456
 
457
457
  const body = {
458
- // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. 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.
458
+ // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on 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.
459
459
  company: AAPL,
460
460
  // 'annual' | 'quarterly' | 'ytd' | 'ttm' | Period type
461
461
  period: annual,
@@ -498,7 +498,7 @@ example().catch(console.error);
498
498
 
499
499
  | Name | Type | Description | Notes |
500
500
  |------------- | ------------- | ------------- | -------------|
501
- | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [Defaults to `undefined`] |
501
+ | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Defaults to `undefined`] |
502
502
  | **period** | `annual`, `quarterly`, `ytd`, `ttm` | Period type | [Defaults to `undefined`] [Enum: annual, quarterly, ytd, ttm] |
503
503
  | **metric** | `string` | Metric id, comma list | [Optional] [Defaults to `undefined`] |
504
504
  | **axis** | `string` | XBRL axis, comma list | [Optional] [Defaults to `undefined`] |
@@ -568,7 +568,7 @@ async function example() {
568
568
  const api = new MetricsApi(config);
569
569
 
570
570
  const body = {
571
- // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. 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.
571
+ // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on 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.
572
572
  company: AAPL,
573
573
  // 'annual' | 'quarterly' | 'ytd' | 'ttm' | Period type
574
574
  period: annual,
@@ -611,7 +611,7 @@ example().catch(console.error);
611
611
 
612
612
  | Name | Type | Description | Notes |
613
613
  |------------- | ------------- | ------------- | -------------|
614
- | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [Defaults to `undefined`] |
614
+ | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). Required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Defaults to `undefined`] |
615
615
  | **period** | `annual`, `quarterly`, `ytd`, `ttm` | Period type | [Defaults to `undefined`] [Enum: annual, quarterly, ytd, ttm] |
616
616
  | **metric** | `string` | Metric id, comma list | [Optional] [Defaults to `undefined`] |
617
617
  | **axis** | `string` | XBRL axis, comma list | [Optional] [Defaults to `undefined`] |
package/docs/NewsApi.md CHANGED
@@ -207,7 +207,7 @@ async function example() {
207
207
  const api = new NewsApi(config);
208
208
 
209
209
  const body = {
210
- // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. 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)
210
+ // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on 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)
211
211
  company: AAPL,
212
212
  // string | Topics, comma list (optional)
213
213
  topic: product_launch,
@@ -252,7 +252,7 @@ example().catch(console.error);
252
252
 
253
253
  | Name | Type | Description | Notes |
254
254
  |------------- | ------------- | ------------- | -------------|
255
- | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [Optional] [Defaults to `undefined`] |
255
+ | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Optional] [Defaults to `undefined`] |
256
256
  | **topic** | `string` | Topics, comma list | [Optional] [Defaults to `undefined`] |
257
257
  | **item** | `string` | News item id | [Optional] [Defaults to `undefined`] |
258
258
  | **announcedAtGte** | `Date` | `announced_at` on or after this value | [Optional] [Defaults to `undefined`] |
@@ -323,7 +323,7 @@ async function example() {
323
323
  const api = new NewsApi(config);
324
324
 
325
325
  const body = {
326
- // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. 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)
326
+ // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on 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)
327
327
  company: AAPL,
328
328
  // string | Event id (optional)
329
329
  event: evt_01JC8M2X,
@@ -366,7 +366,7 @@ example().catch(console.error);
366
366
 
367
367
  | Name | Type | Description | Notes |
368
368
  |------------- | ------------- | ------------- | -------------|
369
- | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [Optional] [Defaults to `undefined`] |
369
+ | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Optional] [Defaults to `undefined`] |
370
370
  | **event** | `string` | Event id | [Optional] [Defaults to `undefined`] |
371
371
  | **kind** | `string` | Kinds, comma list | [Optional] [Defaults to `undefined`] |
372
372
  | **topic** | `string` | Topics, comma list | [Optional] [Defaults to `undefined`] |
@@ -438,7 +438,7 @@ async function example() {
438
438
  const body = {
439
439
  // string | Query
440
440
  q: buyback,
441
- // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. 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)
441
+ // string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on 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)
442
442
  company: AAPL,
443
443
  // 'title' | 'lede' | 'summary' | 'any' | Field searched (optional)
444
444
  field: any,
@@ -476,7 +476,7 @@ example().catch(console.error);
476
476
  | Name | Type | Description | Notes |
477
477
  |------------- | ------------- | ------------- | -------------|
478
478
  | **q** | `string` | Query | [Defaults to `undefined`] |
479
- | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The company-only families (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs) answer one 404 `not_covered` naming the ETF (\"TQQQ is an ETF: … exists only for companies\"); on the other lists a series ETF such as TQQQ is not a known company. | [Optional] [Defaults to `undefined`] |
479
+ | **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Optional] [Defaults to `undefined`] |
480
480
  | **field** | `title`, `lede`, `summary`, `any` | Field searched | [Optional] [Defaults to `'any'`] [Enum: title, lede, summary, any] |
481
481
  | **mode** | `lexical`, `literal` | Mode | [Optional] [Defaults to `'lexical'`] [Enum: lexical, literal] |
482
482
  | **publishedAtGte** | `Date` | `published_at` on or after this value | [Optional] [Defaults to `undefined`] |