@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.
- package/.openapi-generator/FILES +52 -0
- package/dist/apis/ScriptsApi.d.ts +148 -0
- package/dist/apis/ScriptsApi.js +396 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/ScriptsApi.d.ts +148 -0
- package/dist/esm/apis/ScriptsApi.js +392 -0
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/Alert.d.ts +6 -0
- package/dist/esm/models/Alert.js +4 -0
- package/dist/esm/models/AlertCondition.d.ts +61 -5
- package/dist/esm/models/AlertCondition.js +27 -1
- package/dist/esm/models/AlertConditionInput.d.ts +54 -5
- package/dist/esm/models/AlertConditionInput.js +24 -1
- package/dist/esm/models/AlertTemplate.d.ts +83 -0
- package/dist/esm/models/AlertTemplate.js +79 -0
- package/dist/esm/models/AlertTemplateInput.d.ts +78 -0
- package/dist/esm/models/AlertTemplateInput.js +70 -0
- package/dist/esm/models/AlertTrigger.d.ts +1 -1
- package/dist/esm/models/AlertTriggerInput.d.ts +1 -1
- package/dist/esm/models/Company.d.ts +6 -6
- package/dist/esm/models/CreateScriptRequest.d.ts +44 -0
- package/dist/esm/models/CreateScriptRequest.js +49 -0
- package/dist/esm/models/CreateScriptVersionRequest.d.ts +32 -0
- package/dist/esm/models/CreateScriptVersionRequest.js +43 -0
- package/dist/esm/models/IndicatorCondition.d.ts +56 -0
- package/dist/esm/models/IndicatorCondition.js +62 -0
- package/dist/esm/models/IndicatorConditionInput.d.ts +56 -0
- package/dist/esm/models/IndicatorConditionInput.js +62 -0
- package/dist/esm/models/IndicatorFilterChild.d.ts +68 -0
- package/dist/esm/models/IndicatorFilterChild.js +65 -0
- package/dist/esm/models/IndicatorFilterChildInput.d.ts +68 -0
- package/dist/esm/models/IndicatorFilterChildInput.js +65 -0
- package/dist/esm/models/IndicatorFilterCondition.d.ts +73 -0
- package/dist/esm/models/IndicatorFilterCondition.js +74 -0
- package/dist/esm/models/IndicatorFilterConditionInput.d.ts +73 -0
- package/dist/esm/models/IndicatorFilterConditionInput.js +74 -0
- package/dist/esm/models/IndicatorFilterLeaf.d.ts +46 -0
- package/dist/esm/models/IndicatorFilterLeaf.js +54 -0
- package/dist/esm/models/IndicatorFilterLeafInput.d.ts +46 -0
- package/dist/esm/models/IndicatorFilterLeafInput.js +56 -0
- package/dist/esm/models/IndicatorFilters.d.ts +47 -0
- package/dist/esm/models/IndicatorFilters.js +55 -0
- package/dist/esm/models/IndicatorFiltersInput.d.ts +47 -0
- package/dist/esm/models/IndicatorFiltersInput.js +55 -0
- package/dist/esm/models/IndicatorOperand.d.ts +91 -0
- package/dist/esm/models/IndicatorOperand.js +74 -0
- package/dist/esm/models/IndicatorOperandInput.d.ts +91 -0
- package/dist/esm/models/IndicatorOperandInput.js +74 -0
- package/dist/esm/models/IndicatorResolved.d.ts +67 -0
- package/dist/esm/models/IndicatorResolved.js +65 -0
- package/dist/esm/models/IndicatorResolvedThreshold.d.ts +47 -0
- package/dist/esm/models/IndicatorResolvedThreshold.js +55 -0
- package/dist/esm/models/IndicatorTemplateRef.d.ts +46 -0
- package/dist/esm/models/IndicatorTemplateRef.js +47 -0
- package/dist/esm/models/ListAlertTemplates200Response.d.ts +52 -0
- package/dist/esm/models/ListAlertTemplates200Response.js +57 -0
- package/dist/esm/models/ListScriptVersions200Response.d.ts +52 -0
- package/dist/esm/models/ListScriptVersions200Response.js +57 -0
- package/dist/esm/models/ListScripts200Response.d.ts +52 -0
- package/dist/esm/models/ListScripts200Response.js +57 -0
- package/dist/esm/models/Script.d.ts +69 -0
- package/dist/esm/models/Script.js +68 -0
- package/dist/esm/models/ScriptDiagnostic.d.ts +64 -0
- package/dist/esm/models/ScriptDiagnostic.js +66 -0
- package/dist/esm/models/ScriptVersion.d.ts +103 -0
- package/dist/esm/models/ScriptVersion.js +91 -0
- package/dist/esm/models/index.d.ts +25 -0
- package/dist/esm/models/index.js +25 -0
- package/dist/models/Alert.d.ts +6 -0
- package/dist/models/Alert.js +4 -0
- package/dist/models/AlertCondition.d.ts +61 -5
- package/dist/models/AlertCondition.js +27 -1
- package/dist/models/AlertConditionInput.d.ts +54 -5
- package/dist/models/AlertConditionInput.js +24 -1
- package/dist/models/AlertTemplate.d.ts +83 -0
- package/dist/models/AlertTemplate.js +87 -0
- package/dist/models/AlertTemplateInput.d.ts +78 -0
- package/dist/models/AlertTemplateInput.js +78 -0
- package/dist/models/AlertTrigger.d.ts +1 -1
- package/dist/models/AlertTriggerInput.d.ts +1 -1
- package/dist/models/Company.d.ts +6 -6
- package/dist/models/CreateScriptRequest.d.ts +44 -0
- package/dist/models/CreateScriptRequest.js +56 -0
- package/dist/models/CreateScriptVersionRequest.d.ts +32 -0
- package/dist/models/CreateScriptVersionRequest.js +50 -0
- package/dist/models/IndicatorCondition.d.ts +56 -0
- package/dist/models/IndicatorCondition.js +70 -0
- package/dist/models/IndicatorConditionInput.d.ts +56 -0
- package/dist/models/IndicatorConditionInput.js +70 -0
- package/dist/models/IndicatorFilterChild.d.ts +68 -0
- package/dist/models/IndicatorFilterChild.js +73 -0
- package/dist/models/IndicatorFilterChildInput.d.ts +68 -0
- package/dist/models/IndicatorFilterChildInput.js +73 -0
- package/dist/models/IndicatorFilterCondition.d.ts +73 -0
- package/dist/models/IndicatorFilterCondition.js +82 -0
- package/dist/models/IndicatorFilterConditionInput.d.ts +73 -0
- package/dist/models/IndicatorFilterConditionInput.js +82 -0
- package/dist/models/IndicatorFilterLeaf.d.ts +46 -0
- package/dist/models/IndicatorFilterLeaf.js +62 -0
- package/dist/models/IndicatorFilterLeafInput.d.ts +46 -0
- package/dist/models/IndicatorFilterLeafInput.js +64 -0
- package/dist/models/IndicatorFilters.d.ts +47 -0
- package/dist/models/IndicatorFilters.js +63 -0
- package/dist/models/IndicatorFiltersInput.d.ts +47 -0
- package/dist/models/IndicatorFiltersInput.js +63 -0
- package/dist/models/IndicatorOperand.d.ts +91 -0
- package/dist/models/IndicatorOperand.js +82 -0
- package/dist/models/IndicatorOperandInput.d.ts +91 -0
- package/dist/models/IndicatorOperandInput.js +82 -0
- package/dist/models/IndicatorResolved.d.ts +67 -0
- package/dist/models/IndicatorResolved.js +73 -0
- package/dist/models/IndicatorResolvedThreshold.d.ts +47 -0
- package/dist/models/IndicatorResolvedThreshold.js +63 -0
- package/dist/models/IndicatorTemplateRef.d.ts +46 -0
- package/dist/models/IndicatorTemplateRef.js +54 -0
- package/dist/models/ListAlertTemplates200Response.d.ts +52 -0
- package/dist/models/ListAlertTemplates200Response.js +64 -0
- package/dist/models/ListScriptVersions200Response.d.ts +52 -0
- package/dist/models/ListScriptVersions200Response.js +64 -0
- package/dist/models/ListScripts200Response.d.ts +52 -0
- package/dist/models/ListScripts200Response.js +64 -0
- package/dist/models/Script.d.ts +69 -0
- package/dist/models/Script.js +75 -0
- package/dist/models/ScriptDiagnostic.d.ts +64 -0
- package/dist/models/ScriptDiagnostic.js +74 -0
- package/dist/models/ScriptVersion.d.ts +103 -0
- package/dist/models/ScriptVersion.js +99 -0
- package/dist/models/index.d.ts +25 -0
- package/dist/models/index.js +25 -0
- package/docs/Alert.md +2 -0
- package/docs/AlertCondition.md +15 -1
- package/docs/AlertConditionInput.md +13 -1
- package/docs/AlertTemplate.md +49 -0
- package/docs/AlertTemplateInput.md +47 -0
- package/docs/CompaniesApi.md +4 -4
- package/docs/CreateScriptRequest.md +38 -0
- package/docs/CreateScriptVersionRequest.md +34 -0
- package/docs/EventsApi.md +2 -2
- package/docs/FilingsApi.md +4 -4
- package/docs/FinancialsApi.md +12 -12
- package/docs/GuidanceApi.md +4 -4
- package/docs/HoldingsApi.md +8 -8
- package/docs/IPOsApi.md +4 -4
- package/docs/IndicatorCondition.md +39 -0
- package/docs/IndicatorConditionInput.md +39 -0
- package/docs/IndicatorFilterChild.md +41 -0
- package/docs/IndicatorFilterChildInput.md +41 -0
- package/docs/IndicatorFilterCondition.md +41 -0
- package/docs/IndicatorFilterConditionInput.md +41 -0
- package/docs/IndicatorFilterLeaf.md +37 -0
- package/docs/IndicatorFilterLeafInput.md +37 -0
- package/docs/IndicatorFilters.md +37 -0
- package/docs/IndicatorFiltersInput.md +37 -0
- package/docs/IndicatorOperand.md +47 -0
- package/docs/IndicatorOperandInput.md +47 -0
- package/docs/IndicatorResolved.md +43 -0
- package/docs/IndicatorResolvedThreshold.md +37 -0
- package/docs/IndicatorTemplateRef.md +39 -0
- package/docs/InsiderTradesApi.md +2 -2
- package/docs/InvestorDocumentsApi.md +4 -4
- package/docs/ListAlertTemplates200Response.md +41 -0
- package/docs/ListScriptVersions200Response.md +41 -0
- package/docs/ListScripts200Response.md +41 -0
- package/docs/MetricsApi.md +10 -10
- package/docs/NewsApi.md +6 -6
- package/docs/ReferenceApi.md +6 -6
- package/docs/Script.md +46 -0
- package/docs/ScriptDiagnostic.md +42 -0
- package/docs/ScriptVersion.md +54 -0
- package/docs/ScriptsApi.md +588 -0
- package/docs/TranscriptsApi.md +2 -2
- package/package.json +1 -1
- package/src/apis/ScriptsApi.ts +504 -0
- package/src/apis/index.ts +1 -0
- package/src/models/Alert.ts +9 -0
- package/src/models/AlertCondition.ts +98 -6
- package/src/models/AlertConditionInput.ts +83 -6
- package/src/models/AlertTemplate.ts +148 -0
- package/src/models/AlertTemplateInput.ts +130 -0
- package/src/models/AlertTrigger.ts +1 -1
- package/src/models/AlertTriggerInput.ts +1 -1
- package/src/models/Company.ts +6 -6
- package/src/models/CreateScriptRequest.ts +83 -0
- package/src/models/CreateScriptVersionRequest.ts +66 -0
- package/src/models/IndicatorCondition.ts +106 -0
- package/src/models/IndicatorConditionInput.ts +106 -0
- package/src/models/IndicatorFilterChild.ts +125 -0
- package/src/models/IndicatorFilterChildInput.ts +125 -0
- package/src/models/IndicatorFilterCondition.ts +126 -0
- package/src/models/IndicatorFilterConditionInput.ts +126 -0
- package/src/models/IndicatorFilterLeaf.ts +93 -0
- package/src/models/IndicatorFilterLeafInput.ts +95 -0
- package/src/models/IndicatorFilters.ts +94 -0
- package/src/models/IndicatorFiltersInput.ts +94 -0
- package/src/models/IndicatorOperand.ts +139 -0
- package/src/models/IndicatorOperandInput.ts +139 -0
- package/src/models/IndicatorResolved.ts +120 -0
- package/src/models/IndicatorResolvedThreshold.ts +87 -0
- package/src/models/IndicatorTemplateRef.ts +82 -0
- package/src/models/ListAlertTemplates200Response.ts +108 -0
- package/src/models/ListScriptVersions200Response.ts +108 -0
- package/src/models/ListScripts200Response.ts +108 -0
- package/src/models/Script.ts +128 -0
- package/src/models/ScriptDiagnostic.ts +113 -0
- package/src/models/ScriptVersion.ts +175 -0
- package/src/models/index.ts +25 -0
package/docs/HoldingsApi.md
CHANGED
|
@@ -40,7 +40,7 @@ async function example() {
|
|
|
40
40
|
const body = {
|
|
41
41
|
// string | ETF ticker: the fund\'s freshest composition (one ETF) (optional)
|
|
42
42
|
etf: SPY,
|
|
43
|
-
// string | Ticker (`NVDA`) or CIK of ONE company: the ETFs holding it (from the ETFs\' issuer files). Exactly one of `etf` or `company` is required. (optional)
|
|
43
|
+
// string | Ticker (`NVDA`) or CIK of ONE company: the ETFs holding it (from the ETFs\' issuer files). Exactly one of `etf` or `company` is required. A US ETF that is its own registrant (SPY) is found by its CIK; a series of a multi-series trust (TQQQ) answers one 404 `not_covered` naming it (holders are found by issuer CIK, which would mix its trust\'s other series). (optional)
|
|
44
44
|
company: NVDA,
|
|
45
45
|
// Date | With etf=: the composition stored on or before this date (issuer files about 30 days back, older dates from the N-PORT report); default the freshest (optional)
|
|
46
46
|
asOf: 2026-11-12,
|
|
@@ -72,7 +72,7 @@ example().catch(console.error);
|
|
|
72
72
|
| Name | Type | Description | Notes |
|
|
73
73
|
|------------- | ------------- | ------------- | -------------|
|
|
74
74
|
| **etf** | `string` | ETF ticker: the fund\'s freshest composition (one ETF) | [Optional] [Defaults to `undefined`] |
|
|
75
|
-
| **company** | `string` | Ticker (`NVDA`) or CIK of ONE company: the ETFs holding it (from the ETFs\' issuer files). Exactly one of `etf` or `company` is required. | [Optional] [Defaults to `undefined`] |
|
|
75
|
+
| **company** | `string` | Ticker (`NVDA`) or CIK of ONE company: the ETFs holding it (from the ETFs\' issuer files). Exactly one of `etf` or `company` is required. A US ETF that is its own registrant (SPY) is found by its CIK; a series of a multi-series trust (TQQQ) answers one 404 `not_covered` naming it (holders are found by issuer CIK, which would mix its trust\'s other series). | [Optional] [Defaults to `undefined`] |
|
|
76
76
|
| **asOf** | `Date` | With etf=: the composition stored on or before this date (issuer files about 30 days back, older dates from the N-PORT report); default the freshest | [Optional] [Defaults to `undefined`] |
|
|
77
77
|
| **sort** | `-weight_pct`, `-market_value_usd` | Sort field: `-weight_pct` with etf= (default), `-market_value_usd` with company= (default); the only orders the store serves | [Optional] [Defaults to `undefined`] [Enum: -weight_pct, -market_value_usd] |
|
|
78
78
|
| **fields** | `string` | Comma list of root-level fields to keep (R7) | [Optional] [Defaults to `undefined`] |
|
|
@@ -231,7 +231,7 @@ async function example() {
|
|
|
231
231
|
const api = new HoldingsApi(config);
|
|
232
232
|
|
|
233
233
|
const body = {
|
|
234
|
-
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
234
|
+
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. (optional)
|
|
235
235
|
company: AAPL,
|
|
236
236
|
// string | Fund registrant CIK (one): its fund portfolio (optional)
|
|
237
237
|
filer: 0000036405,
|
|
@@ -268,7 +268,7 @@ example().catch(console.error);
|
|
|
268
268
|
|
|
269
269
|
| Name | Type | Description | Notes |
|
|
270
270
|
|------------- | ------------- | ------------- | -------------|
|
|
271
|
-
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
271
|
+
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Optional] [Defaults to `undefined`] |
|
|
272
272
|
| **filer** | `string` | Fund registrant CIK (one): its fund portfolio | [Optional] [Defaults to `undefined`] |
|
|
273
273
|
| **series** | `string` | SEC series id of one fund (S + 9 digits; a unit investment trust without a series: cik:<registrant CIK>); with filer=, required when the registrant files for more than one fund | [Optional] [Defaults to `undefined`] |
|
|
274
274
|
| **accession** | `string` | NPORT-P filing: its reported holdings as filed | [Optional] [Defaults to `undefined`] |
|
|
@@ -335,7 +335,7 @@ async function example() {
|
|
|
335
335
|
const api = new HoldingsApi(config);
|
|
336
336
|
|
|
337
337
|
const body = {
|
|
338
|
-
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
338
|
+
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. (optional)
|
|
339
339
|
company: AAPL,
|
|
340
340
|
// string | Manager CIK, comma list (optional)
|
|
341
341
|
filer: 0000102909,
|
|
@@ -370,7 +370,7 @@ example().catch(console.error);
|
|
|
370
370
|
|
|
371
371
|
| Name | Type | Description | Notes |
|
|
372
372
|
|------------- | ------------- | ------------- | -------------|
|
|
373
|
-
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
373
|
+
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Optional] [Defaults to `undefined`] |
|
|
374
374
|
| **filer** | `string` | Manager CIK, comma list | [Optional] [Defaults to `undefined`] |
|
|
375
375
|
| **periodEnd** | `Date` | Quarter end | [Optional] [Defaults to `undefined`] |
|
|
376
376
|
| **priorPeriodEnd** | `Date` | Quarter compared against (default the previous one) | [Optional] [Defaults to `undefined`] |
|
|
@@ -436,7 +436,7 @@ async function example() {
|
|
|
436
436
|
const api = new HoldingsApi(config);
|
|
437
437
|
|
|
438
438
|
const body = {
|
|
439
|
-
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
439
|
+
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. (optional)
|
|
440
440
|
company: AAPL,
|
|
441
441
|
// string | Manager CIK, comma list (optional)
|
|
442
442
|
filer: 0000102909,
|
|
@@ -473,7 +473,7 @@ example().catch(console.error);
|
|
|
473
473
|
|
|
474
474
|
| Name | Type | Description | Notes |
|
|
475
475
|
|------------- | ------------- | ------------- | -------------|
|
|
476
|
-
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
476
|
+
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Optional] [Defaults to `undefined`] |
|
|
477
477
|
| **filer** | `string` | Manager CIK, comma list | [Optional] [Defaults to `undefined`] |
|
|
478
478
|
| **accession** | `string` | 13F filing | [Optional] [Defaults to `undefined`] |
|
|
479
479
|
| **periodEnd** | `Date` | Quarter end | [Optional] [Defaults to `undefined`] |
|
package/docs/IPOsApi.md
CHANGED
|
@@ -215,7 +215,7 @@ async function example() {
|
|
|
215
215
|
listingDateLte: 2026-01-01,
|
|
216
216
|
// Date | `listing_date` before this value (optional)
|
|
217
217
|
listingDateLt: 2026-01-01,
|
|
218
|
-
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
218
|
+
// string | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. (optional)
|
|
219
219
|
company: AAPL,
|
|
220
220
|
// 'listing_date' | '-listing_date' | 'first_public_at' | '-first_public_at' | Sort field (`-` = descending); the id tiebreaker is always appended. Default `-listing_date` (optional)
|
|
221
221
|
sort: -listing_date,
|
|
@@ -250,7 +250,7 @@ example().catch(console.error);
|
|
|
250
250
|
| **listingDateGt** | `Date` | `listing_date` after this value | [Optional] [Defaults to `undefined`] |
|
|
251
251
|
| **listingDateLte** | `Date` | `listing_date` on or before this value | [Optional] [Defaults to `undefined`] |
|
|
252
252
|
| **listingDateLt** | `Date` | `listing_date` before this value | [Optional] [Defaults to `undefined`] |
|
|
253
|
-
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on `/v1/dividends`, `/v1/splits` and `/v1/filings` (a trust series\' filings are the accessions naming its series; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link). The
|
|
253
|
+
| **company** | `string` | Ticker (`AAPL`) or CIK (all digits, any padding); a comma list of 1–50 reads several companies in one request (R2). One of the scope filters of this list is required. US ETFs: a fund registrant such as SPY and a series of a multi-series trust such as TQQQ both resolve on every list, and ETF data is served where it exists: `/v1/dividends`, `/v1/splits`, `/v1/filings` and `/v1/search/filings` (a trust series\' filings are the accessions naming its series, and such a series is searched alone; an ETF that is its own registrant lists its registrant\'s; a row\'s `company.cik` is the trust\'s CIK, empty for an ETF without a registrant link), and the 13F, ETF and fund holder lists (holdings, holding changes, ETF / fund holdings) for an ETF that is its own registrant such as SPY (a trust series such as TQQQ answers one 404 `not_covered` naming it: holders are found by issuer CIK, which would mix its trust\'s other series). The families without ETF data (financials, metrics, segments, fiscal periods, insider trades, events, transcripts, guidance, people, investor documents, IPOs, news and announcements) answer one 404 `not_covered` naming the ETF, the same for SPY and TQQQ (\"TQQQ is an ETF: … exists only for companies\"); in a mixed list the companies answer. | [Optional] [Defaults to `undefined`] |
|
|
254
254
|
| **sort** | `listing_date`, `-listing_date`, `first_public_at`, `-first_public_at` | Sort field (`-` = descending); the id tiebreaker is always appended. Default `-listing_date` | [Optional] [Defaults to `'-listing_date'`] [Enum: listing_date, -listing_date, first_public_at, -first_public_at] |
|
|
255
255
|
| **fields** | `string` | Comma list of root-level fields to keep (R7) | [Optional] [Defaults to `undefined`] |
|
|
256
256
|
| **limit** | `number` | Rows per page (default 25, max 200) | [Optional] [Defaults to `25`] |
|
|
@@ -312,7 +312,7 @@ async function example() {
|
|
|
312
312
|
const api = new IPOsApi(config);
|
|
313
313
|
|
|
314
314
|
const body = {
|
|
315
|
-
// string | Issuer: a CIK (all digits, any padding; any Form D issuer, listed or not) or the ticker of a listed company — ONE value; matches the primary issuer and co-issuers. Without it: every offering (optional)
|
|
315
|
+
// string | Issuer: a CIK (all digits, any padding; any Form D issuer, listed or not) or the ticker of a listed company — ONE value; matches the primary issuer and co-issuers. Without it: every offering. A US ETF ticker of either identity (SPY, TQQQ) answers one 404 `not_covered` naming it: no Form D data exists for a fund (an ETF registrant\'s CIK still reads the door) (optional)
|
|
316
316
|
company: 0001991882,
|
|
317
317
|
// Date | Latest filing on or after this date (optional)
|
|
318
318
|
filedAtGte: 2026-01-01,
|
|
@@ -353,7 +353,7 @@ example().catch(console.error);
|
|
|
353
353
|
|
|
354
354
|
| Name | Type | Description | Notes |
|
|
355
355
|
|------------- | ------------- | ------------- | -------------|
|
|
356
|
-
| **company** | `string` | Issuer: a CIK (all digits, any padding; any Form D issuer, listed or not) or the ticker of a listed company — ONE value; matches the primary issuer and co-issuers. Without it: every offering | [Optional] [Defaults to `undefined`] |
|
|
356
|
+
| **company** | `string` | Issuer: a CIK (all digits, any padding; any Form D issuer, listed or not) or the ticker of a listed company — ONE value; matches the primary issuer and co-issuers. Without it: every offering. A US ETF ticker of either identity (SPY, TQQQ) answers one 404 `not_covered` naming it: no Form D data exists for a fund (an ETF registrant\'s CIK still reads the door) | [Optional] [Defaults to `undefined`] |
|
|
357
357
|
| **filedAtGte** | `Date` | Latest filing on or after this date | [Optional] [Defaults to `undefined`] |
|
|
358
358
|
| **filedAtLte** | `Date` | Latest filing on or before this date | [Optional] [Defaults to `undefined`] |
|
|
359
359
|
| **exemption** | `string` | Offerings claiming this exemption, as filed (06b, 06c, 04, 3C.7, …) | [Optional] [Defaults to `undefined`] |
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
|
|
2
|
+
# IndicatorCondition
|
|
3
|
+
|
|
4
|
+
A structured trigger `lhs <comparator> rhs`, evaluated at each bar close. The crossings take any right side but a zone; `entering` / `exiting` only a rectangle zone (`indicator_id: rectangle`, `series_key: band`).
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`lhs` | [IndicatorOperand](IndicatorOperand.md)
|
|
11
|
+
`comparator` | string
|
|
12
|
+
`rhs` | [IndicatorOperand](IndicatorOperand.md)
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { IndicatorCondition } from '@invinite-org/data-api-client'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"lhs": null,
|
|
22
|
+
"comparator": null,
|
|
23
|
+
"rhs": null,
|
|
24
|
+
} satisfies IndicatorCondition
|
|
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 IndicatorCondition
|
|
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
|
+
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
|
|
2
|
+
# IndicatorConditionInput
|
|
3
|
+
|
|
4
|
+
A structured trigger `lhs <comparator> rhs`, evaluated at each bar close. The crossings take any right side but a zone; `entering` / `exiting` only a rectangle zone (`indicator_id: rectangle`, `series_key: band`). (request form)
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`lhs` | [IndicatorOperandInput](IndicatorOperandInput.md)
|
|
11
|
+
`comparator` | string
|
|
12
|
+
`rhs` | [IndicatorOperandInput](IndicatorOperandInput.md)
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { IndicatorConditionInput } from '@invinite-org/data-api-client'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"lhs": null,
|
|
22
|
+
"comparator": null,
|
|
23
|
+
"rhs": null,
|
|
24
|
+
} satisfies IndicatorConditionInput
|
|
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 IndicatorConditionInput
|
|
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
|
+
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
|
|
2
|
+
# IndicatorFilterChild
|
|
3
|
+
|
|
4
|
+
A filter leaf (`kind: condition` + `condition`) or one nested group (`kind: group` + `op` + `children` of leaves).
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`kind` | string
|
|
11
|
+
`condition` | [IndicatorFilterCondition](IndicatorFilterCondition.md)
|
|
12
|
+
`op` | string
|
|
13
|
+
`children` | [Array<IndicatorFilterLeaf>](IndicatorFilterLeaf.md)
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import type { IndicatorFilterChild } from '@invinite-org/data-api-client'
|
|
19
|
+
|
|
20
|
+
// TODO: Update the object below with actual values
|
|
21
|
+
const example = {
|
|
22
|
+
"kind": null,
|
|
23
|
+
"condition": null,
|
|
24
|
+
"op": null,
|
|
25
|
+
"children": null,
|
|
26
|
+
} satisfies IndicatorFilterChild
|
|
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 IndicatorFilterChild
|
|
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
|
+
# IndicatorFilterChildInput
|
|
3
|
+
|
|
4
|
+
A filter leaf (`kind: condition` + `condition`) or one nested group (`kind: group` + `op` + `children` of leaves). (request form)
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`kind` | string
|
|
11
|
+
`condition` | [IndicatorFilterConditionInput](IndicatorFilterConditionInput.md)
|
|
12
|
+
`op` | string
|
|
13
|
+
`children` | [Array<IndicatorFilterLeafInput>](IndicatorFilterLeafInput.md)
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import type { IndicatorFilterChildInput } from '@invinite-org/data-api-client'
|
|
19
|
+
|
|
20
|
+
// TODO: Update the object below with actual values
|
|
21
|
+
const example = {
|
|
22
|
+
"kind": null,
|
|
23
|
+
"condition": null,
|
|
24
|
+
"op": null,
|
|
25
|
+
"children": null,
|
|
26
|
+
} satisfies IndicatorFilterChildInput
|
|
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 IndicatorFilterChildInput
|
|
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
|
+
# IndicatorFilterCondition
|
|
3
|
+
|
|
4
|
+
A state comparison that must hold on the trigger bar.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`lhs` | [IndicatorOperand](IndicatorOperand.md)
|
|
11
|
+
`comparator` | string
|
|
12
|
+
`rhs` | [IndicatorOperand](IndicatorOperand.md)
|
|
13
|
+
`interval` | string
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import type { IndicatorFilterCondition } from '@invinite-org/data-api-client'
|
|
19
|
+
|
|
20
|
+
// TODO: Update the object below with actual values
|
|
21
|
+
const example = {
|
|
22
|
+
"lhs": null,
|
|
23
|
+
"comparator": null,
|
|
24
|
+
"rhs": null,
|
|
25
|
+
"interval": null,
|
|
26
|
+
} satisfies IndicatorFilterCondition
|
|
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 IndicatorFilterCondition
|
|
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
|
+
# IndicatorFilterConditionInput
|
|
3
|
+
|
|
4
|
+
A state comparison that must hold on the trigger bar. (request form)
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`lhs` | [IndicatorOperandInput](IndicatorOperandInput.md)
|
|
11
|
+
`comparator` | string
|
|
12
|
+
`rhs` | [IndicatorOperandInput](IndicatorOperandInput.md)
|
|
13
|
+
`interval` | string
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import type { IndicatorFilterConditionInput } from '@invinite-org/data-api-client'
|
|
19
|
+
|
|
20
|
+
// TODO: Update the object below with actual values
|
|
21
|
+
const example = {
|
|
22
|
+
"lhs": null,
|
|
23
|
+
"comparator": null,
|
|
24
|
+
"rhs": null,
|
|
25
|
+
"interval": null,
|
|
26
|
+
} satisfies IndicatorFilterConditionInput
|
|
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 IndicatorFilterConditionInput
|
|
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,37 @@
|
|
|
1
|
+
|
|
2
|
+
# IndicatorFilterLeaf
|
|
3
|
+
|
|
4
|
+
One filter comparison.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`kind` | string
|
|
11
|
+
`condition` | [IndicatorFilterCondition](IndicatorFilterCondition.md)
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { IndicatorFilterLeaf } from '@invinite-org/data-api-client'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"kind": null,
|
|
21
|
+
"condition": null,
|
|
22
|
+
} satisfies IndicatorFilterLeaf
|
|
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 IndicatorFilterLeaf
|
|
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,37 @@
|
|
|
1
|
+
|
|
2
|
+
# IndicatorFilterLeafInput
|
|
3
|
+
|
|
4
|
+
One filter comparison. (request form)
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`kind` | string
|
|
11
|
+
`condition` | [IndicatorFilterConditionInput](IndicatorFilterConditionInput.md)
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { IndicatorFilterLeafInput } from '@invinite-org/data-api-client'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"kind": null,
|
|
21
|
+
"condition": null,
|
|
22
|
+
} satisfies IndicatorFilterLeafInput
|
|
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 IndicatorFilterLeafInput
|
|
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,37 @@
|
|
|
1
|
+
|
|
2
|
+
# IndicatorFilters
|
|
3
|
+
|
|
4
|
+
State filters that gate the trigger (at most 4 comparisons in all, two levels).
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`op` | string
|
|
11
|
+
`children` | [Array<IndicatorFilterChild>](IndicatorFilterChild.md)
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { IndicatorFilters } from '@invinite-org/data-api-client'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"op": null,
|
|
21
|
+
"children": null,
|
|
22
|
+
} satisfies IndicatorFilters
|
|
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 IndicatorFilters
|
|
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,37 @@
|
|
|
1
|
+
|
|
2
|
+
# IndicatorFiltersInput
|
|
3
|
+
|
|
4
|
+
State filters that gate the trigger (at most 4 comparisons in all, two levels). (request form)
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`op` | string
|
|
11
|
+
`children` | [Array<IndicatorFilterChildInput>](IndicatorFilterChildInput.md)
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { IndicatorFiltersInput } from '@invinite-org/data-api-client'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"op": null,
|
|
21
|
+
"children": null,
|
|
22
|
+
} satisfies IndicatorFiltersInput
|
|
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 IndicatorFiltersInput
|
|
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,47 @@
|
|
|
1
|
+
|
|
2
|
+
# IndicatorOperand
|
|
3
|
+
|
|
4
|
+
One side of an indicator condition (invinite\'s chart-condition operand): an indicator series, a price field, volume, or a constant (`value`, right side only).
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`kind` | string
|
|
11
|
+
`indicator_id` | string
|
|
12
|
+
`series_key` | string
|
|
13
|
+
`params` | { [key: string]: any; }
|
|
14
|
+
`label` | string
|
|
15
|
+
`source` | string
|
|
16
|
+
`value` | number
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import type { IndicatorOperand } from '@invinite-org/data-api-client'
|
|
22
|
+
|
|
23
|
+
// TODO: Update the object below with actual values
|
|
24
|
+
const example = {
|
|
25
|
+
"kind": null,
|
|
26
|
+
"indicator_id": null,
|
|
27
|
+
"series_key": null,
|
|
28
|
+
"params": null,
|
|
29
|
+
"label": null,
|
|
30
|
+
"source": null,
|
|
31
|
+
"value": null,
|
|
32
|
+
} satisfies IndicatorOperand
|
|
33
|
+
|
|
34
|
+
console.log(example)
|
|
35
|
+
|
|
36
|
+
// Convert the instance to a JSON string
|
|
37
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
38
|
+
console.log(exampleJSON)
|
|
39
|
+
|
|
40
|
+
// Parse the JSON string back to an object
|
|
41
|
+
const exampleParsed = JSON.parse(exampleJSON) as IndicatorOperand
|
|
42
|
+
console.log(exampleParsed)
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
46
|
+
|
|
47
|
+
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
|
|
2
|
+
# IndicatorOperandInput
|
|
3
|
+
|
|
4
|
+
One side of an indicator condition (invinite\'s chart-condition operand): an indicator series, a price field, volume, or a constant (`value`, right side only). (request form)
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`kind` | string
|
|
11
|
+
`indicator_id` | string
|
|
12
|
+
`series_key` | string
|
|
13
|
+
`params` | { [key: string]: any; }
|
|
14
|
+
`label` | string
|
|
15
|
+
`source` | string
|
|
16
|
+
`value` | number
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import type { IndicatorOperandInput } from '@invinite-org/data-api-client'
|
|
22
|
+
|
|
23
|
+
// TODO: Update the object below with actual values
|
|
24
|
+
const example = {
|
|
25
|
+
"kind": null,
|
|
26
|
+
"indicator_id": null,
|
|
27
|
+
"series_key": null,
|
|
28
|
+
"params": null,
|
|
29
|
+
"label": null,
|
|
30
|
+
"source": null,
|
|
31
|
+
"value": null,
|
|
32
|
+
} satisfies IndicatorOperandInput
|
|
33
|
+
|
|
34
|
+
console.log(example)
|
|
35
|
+
|
|
36
|
+
// Convert the instance to a JSON string
|
|
37
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
38
|
+
console.log(exampleJSON)
|
|
39
|
+
|
|
40
|
+
// Parse the JSON string back to an object
|
|
41
|
+
const exampleParsed = JSON.parse(exampleJSON) as IndicatorOperandInput
|
|
42
|
+
console.log(exampleParsed)
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
46
|
+
|
|
47
|
+
|