@invinite-org/data-api-client 6.3.1 → 6.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +12 -0
- package/dist/apis/InsiderTradesApi.d.ts +2 -2
- package/dist/apis/InsiderTradesApi.js +2 -2
- package/dist/esm/apis/InsiderTradesApi.d.ts +2 -2
- package/dist/esm/apis/InsiderTradesApi.js +2 -2
- package/dist/esm/models/AlertCondition.d.ts +28 -4
- package/dist/esm/models/AlertCondition.js +12 -1
- package/dist/esm/models/AlertConditionInput.d.ts +28 -4
- package/dist/esm/models/AlertConditionInput.js +12 -1
- package/dist/esm/models/AlertTrigger.d.ts +2 -2
- package/dist/esm/models/AlertTriggerInput.d.ts +2 -2
- package/dist/esm/models/IndicatorFilterCondition.d.ts +3 -0
- package/dist/esm/models/IndicatorFilterCondition.js +4 -1
- package/dist/esm/models/IndicatorFilterConditionInput.d.ts +3 -0
- package/dist/esm/models/IndicatorFilterConditionInput.js +4 -1
- package/dist/esm/models/ScriptEvaluation.d.ts +65 -0
- package/dist/esm/models/ScriptEvaluation.js +66 -0
- package/dist/esm/models/ScriptEvaluationInput.d.ts +65 -0
- package/dist/esm/models/ScriptEvaluationInput.js +66 -0
- package/dist/esm/models/ScriptNode.d.ts +55 -0
- package/dist/esm/models/ScriptNode.js +53 -0
- package/dist/esm/models/ScriptNodeInput.d.ts +55 -0
- package/dist/esm/models/ScriptNodeInput.js +53 -0
- package/dist/esm/models/ScriptSeriesInput.d.ts +99 -0
- package/dist/esm/models/ScriptSeriesInput.js +78 -0
- package/dist/esm/models/ScriptSeriesInputInput.d.ts +93 -0
- package/dist/esm/models/ScriptSeriesInputInput.js +76 -0
- package/dist/esm/models/index.d.ts +6 -0
- package/dist/esm/models/index.js +6 -0
- package/dist/models/AlertCondition.d.ts +28 -4
- package/dist/models/AlertCondition.js +12 -1
- package/dist/models/AlertConditionInput.d.ts +28 -4
- package/dist/models/AlertConditionInput.js +12 -1
- package/dist/models/AlertTrigger.d.ts +2 -2
- package/dist/models/AlertTriggerInput.d.ts +2 -2
- package/dist/models/IndicatorFilterCondition.d.ts +3 -0
- package/dist/models/IndicatorFilterCondition.js +4 -1
- package/dist/models/IndicatorFilterConditionInput.d.ts +3 -0
- package/dist/models/IndicatorFilterConditionInput.js +4 -1
- package/dist/models/ScriptEvaluation.d.ts +65 -0
- package/dist/models/ScriptEvaluation.js +74 -0
- package/dist/models/ScriptEvaluationInput.d.ts +65 -0
- package/dist/models/ScriptEvaluationInput.js +74 -0
- package/dist/models/ScriptNode.d.ts +55 -0
- package/dist/models/ScriptNode.js +60 -0
- package/dist/models/ScriptNodeInput.d.ts +55 -0
- package/dist/models/ScriptNodeInput.js +60 -0
- package/dist/models/ScriptSeriesInput.d.ts +99 -0
- package/dist/models/ScriptSeriesInput.js +86 -0
- package/dist/models/ScriptSeriesInputInput.d.ts +93 -0
- package/dist/models/ScriptSeriesInputInput.js +84 -0
- package/dist/models/index.d.ts +6 -0
- package/dist/models/index.js +6 -0
- package/docs/AlertCondition.md +6 -0
- package/docs/AlertConditionInput.md +6 -0
- package/docs/IPOsApi.md +2 -2
- package/docs/InsiderTradesApi.md +3 -3
- package/docs/ScriptEvaluation.md +39 -0
- package/docs/ScriptEvaluationInput.md +39 -0
- package/docs/ScriptNode.md +41 -0
- package/docs/ScriptNodeInput.md +41 -0
- package/docs/ScriptSeriesInput.md +49 -0
- package/docs/ScriptSeriesInputInput.md +47 -0
- package/package.json +1 -1
- package/src/apis/InsiderTradesApi.ts +2 -2
- package/src/models/AlertCondition.ts +51 -5
- package/src/models/AlertConditionInput.ts +51 -5
- package/src/models/AlertTrigger.ts +2 -2
- package/src/models/AlertTriggerInput.ts +2 -2
- package/src/models/IndicatorFilterCondition.ts +4 -1
- package/src/models/IndicatorFilterConditionInput.ts +4 -1
- package/src/models/ScriptEvaluation.ts +107 -0
- package/src/models/ScriptEvaluationInput.ts +107 -0
- package/src/models/ScriptNode.ts +99 -0
- package/src/models/ScriptNodeInput.ts +99 -0
- package/src/models/ScriptSeriesInput.ts +149 -0
- package/src/models/ScriptSeriesInputInput.ts +141 -0
- package/src/models/index.ts +6 -0
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Invinite API
|
|
3
|
+
* Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Alerts (`POST /v1/alerts`) deliver their events to your destinations (`POST /v1/destinations`) as [Standard Webhooks](https://github.com/standard-webhooks/standard-webhooks/blob/main/spec/standard-webhooks.md): `alert.fired`, `alert.fired.batch`, `alert.status_changed`, `destination.disabled`, `destination.test`, `account.fire_cap_reached`; see `x-webhooks` for each `data` object. Every event is also on the pull feed `GET /v1/alert-events`. Every delivery is a `POST` with `Content-Type: application/json`, the body `{type, timestamp, data}` (or the destination\'s `body_template`) and the headers `webhook-id` (the event id; a batch: its `bat_…` id), `webhook-timestamp` (unix seconds) and `webhook-signature`: space-separated `v1,<base64 HMAC-SHA256 of <webhook-id>.<webhook-timestamp>.<raw body>>`, keyed with the base64-DECODED bytes of the destination\'s `whsec_…` secret — any Standard Webhooks library verifies it. After `POST /v1/destinations/{id}:rotate-secret` the old secret keeps signing beside the new one for 24 h (two `v1` entries). Reject a timestamp older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed; a body above 256 KB is not sent. A failed attempt is retried after [0, 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 10 h, 10 h, 34 h] (attempt n waits the n-th step) plus up to 10 % jitter; the delivery is dead after attempt 10. A 410 disables the destination at once; so do 72 h of nothing but failures with at least 10 failed attempts in a row (a `destination.disabled` event on the feed and a mail; `PATCH` with `status: active` re-enables it). Delivery is at-least-once and unordered: dedupe on `webhook-id`, order by `timestamp`. A `batch_webhook` destination receives `alert.fired.batch` with the pending events in `data.events[]` (dedupe on each `data.event_id`). Fires and deliveries cost no credits; two fair-use caps apply instead: at most 60 fires per alert per rolling hour (beyond: suppressed and counted in the next fire\'s `suppressed_since_last`) and per account and UTC day FREE 100 · LITE 5,000 · STANDARD 50,000 · PRO 500,000 fires (beyond: written to the feed with `delivery_skipped: fire_cap`, not delivered; one `account.fire_cap_reached` per day). ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account, Alerts.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2026-11-13
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* What feeds one `input.externalSeries` input of a script (a script chain), one value per bar on the alert's symbol, interval and bars; a value the producer does not give that bar reads NaN.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface ScriptSeriesInput
|
|
16
|
+
*/
|
|
17
|
+
export interface ScriptSeriesInput {
|
|
18
|
+
/**
|
|
19
|
+
* What feeds the input every bar: `ohlc` a bar field, `builtin_indicator` a built-in indicator's series, `script_output` a plot of a node of `nodes`
|
|
20
|
+
* @type {ScriptSeriesInputKindEnum}
|
|
21
|
+
* @memberof ScriptSeriesInput
|
|
22
|
+
*/
|
|
23
|
+
kind: ScriptSeriesInputKindEnum;
|
|
24
|
+
/**
|
|
25
|
+
* ohlc: the bar field (`hl2` = (high + low) / 2, `hlc3`, `ohlc4`, `hlcc4` = (high + low + 2 × close) / 4; no volume)
|
|
26
|
+
* @type {ScriptSeriesInputFieldEnum}
|
|
27
|
+
* @memberof ScriptSeriesInput
|
|
28
|
+
*/
|
|
29
|
+
field?: ScriptSeriesInputFieldEnum;
|
|
30
|
+
/**
|
|
31
|
+
* builtin_indicator: the built-in indicator (`rsi`, `sma`, `ema`, `macd`, `bb`, …; the indicator condition's ids)
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof ScriptSeriesInput
|
|
34
|
+
*/
|
|
35
|
+
indicator_id?: string;
|
|
36
|
+
/**
|
|
37
|
+
* builtin_indicator: which output series (`rsi`, `macd` / `signal` / `histogram`, `upper` / `basis` / `lower`, …)
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof ScriptSeriesInput
|
|
40
|
+
*/
|
|
41
|
+
series_key?: string;
|
|
42
|
+
/**
|
|
43
|
+
* builtin_indicator: the indicator's parameters (`length`, `source`, …; absent = its defaults)
|
|
44
|
+
* @type {{ [key: string]: any; }}
|
|
45
|
+
* @memberof ScriptSeriesInput
|
|
46
|
+
*/
|
|
47
|
+
params?: {
|
|
48
|
+
[key: string]: any;
|
|
49
|
+
};
|
|
50
|
+
/**
|
|
51
|
+
* builtin_indicator, set by the platform (read-only: a value sent in a request is ignored): the system script version the series was compiled to
|
|
52
|
+
* @type {string}
|
|
53
|
+
* @memberof ScriptSeriesInput
|
|
54
|
+
*/
|
|
55
|
+
resolved_script_version_id?: string;
|
|
56
|
+
/**
|
|
57
|
+
* script_output: the `node_key` of the producing node
|
|
58
|
+
* @type {string}
|
|
59
|
+
* @memberof ScriptSeriesInput
|
|
60
|
+
*/
|
|
61
|
+
node_key?: string;
|
|
62
|
+
/**
|
|
63
|
+
* script_output: the plot slot of the node's script version (its `manifest.plots[].slotId`)
|
|
64
|
+
* @type {string}
|
|
65
|
+
* @memberof ScriptSeriesInput
|
|
66
|
+
*/
|
|
67
|
+
slot_id?: string;
|
|
68
|
+
}
|
|
69
|
+
/**
|
|
70
|
+
* @export
|
|
71
|
+
*/
|
|
72
|
+
export declare const ScriptSeriesInputKindEnum: {
|
|
73
|
+
readonly Ohlc: "ohlc";
|
|
74
|
+
readonly BuiltinIndicator: "builtin_indicator";
|
|
75
|
+
readonly ScriptOutput: "script_output";
|
|
76
|
+
};
|
|
77
|
+
export type ScriptSeriesInputKindEnum = typeof ScriptSeriesInputKindEnum[keyof typeof ScriptSeriesInputKindEnum] | (string & {});
|
|
78
|
+
/**
|
|
79
|
+
* @export
|
|
80
|
+
*/
|
|
81
|
+
export declare const ScriptSeriesInputFieldEnum: {
|
|
82
|
+
readonly Open: "open";
|
|
83
|
+
readonly High: "high";
|
|
84
|
+
readonly Low: "low";
|
|
85
|
+
readonly Close: "close";
|
|
86
|
+
readonly Hl2: "hl2";
|
|
87
|
+
readonly Hlc3: "hlc3";
|
|
88
|
+
readonly Ohlc4: "ohlc4";
|
|
89
|
+
readonly Hlcc4: "hlcc4";
|
|
90
|
+
};
|
|
91
|
+
export type ScriptSeriesInputFieldEnum = typeof ScriptSeriesInputFieldEnum[keyof typeof ScriptSeriesInputFieldEnum] | (string & {});
|
|
92
|
+
/**
|
|
93
|
+
* Check if a given object implements the ScriptSeriesInput interface.
|
|
94
|
+
*/
|
|
95
|
+
export declare function instanceOfScriptSeriesInput(value: object): value is ScriptSeriesInput;
|
|
96
|
+
export declare function ScriptSeriesInputFromJSON(json: any): ScriptSeriesInput;
|
|
97
|
+
export declare function ScriptSeriesInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptSeriesInput;
|
|
98
|
+
export declare function ScriptSeriesInputToJSON(json: any): ScriptSeriesInput;
|
|
99
|
+
export declare function ScriptSeriesInputToJSONTyped(value?: ScriptSeriesInput | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Invinite API
|
|
6
|
+
* Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Alerts (`POST /v1/alerts`) deliver their events to your destinations (`POST /v1/destinations`) as [Standard Webhooks](https://github.com/standard-webhooks/standard-webhooks/blob/main/spec/standard-webhooks.md): `alert.fired`, `alert.fired.batch`, `alert.status_changed`, `destination.disabled`, `destination.test`, `account.fire_cap_reached`; see `x-webhooks` for each `data` object. Every event is also on the pull feed `GET /v1/alert-events`. Every delivery is a `POST` with `Content-Type: application/json`, the body `{type, timestamp, data}` (or the destination\'s `body_template`) and the headers `webhook-id` (the event id; a batch: its `bat_…` id), `webhook-timestamp` (unix seconds) and `webhook-signature`: space-separated `v1,<base64 HMAC-SHA256 of <webhook-id>.<webhook-timestamp>.<raw body>>`, keyed with the base64-DECODED bytes of the destination\'s `whsec_…` secret — any Standard Webhooks library verifies it. After `POST /v1/destinations/{id}:rotate-secret` the old secret keeps signing beside the new one for 24 h (two `v1` entries). Reject a timestamp older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed; a body above 256 KB is not sent. A failed attempt is retried after [0, 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 10 h, 10 h, 34 h] (attempt n waits the n-th step) plus up to 10 % jitter; the delivery is dead after attempt 10. A 410 disables the destination at once; so do 72 h of nothing but failures with at least 10 failed attempts in a row (a `destination.disabled` event on the feed and a mail; `PATCH` with `status: active` re-enables it). Delivery is at-least-once and unordered: dedupe on `webhook-id`, order by `timestamp`. A `batch_webhook` destination receives `alert.fired.batch` with the pending events in `data.events[]` (dedupe on each `data.event_id`). Fires and deliveries cost no credits; two fair-use caps apply instead: at most 60 fires per alert per rolling hour (beyond: suppressed and counted in the next fire\'s `suppressed_since_last`) and per account and UTC day FREE 100 · LITE 5,000 · STANDARD 50,000 · PRO 500,000 fires (beyond: written to the feed with `delivery_skipped: fire_cap`, not delivered; one `account.fire_cap_reached` per day). ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account, Alerts.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 2026-11-13
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.ScriptSeriesInputFieldEnum = exports.ScriptSeriesInputKindEnum = void 0;
|
|
17
|
+
exports.instanceOfScriptSeriesInput = instanceOfScriptSeriesInput;
|
|
18
|
+
exports.ScriptSeriesInputFromJSON = ScriptSeriesInputFromJSON;
|
|
19
|
+
exports.ScriptSeriesInputFromJSONTyped = ScriptSeriesInputFromJSONTyped;
|
|
20
|
+
exports.ScriptSeriesInputToJSON = ScriptSeriesInputToJSON;
|
|
21
|
+
exports.ScriptSeriesInputToJSONTyped = ScriptSeriesInputToJSONTyped;
|
|
22
|
+
/**
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
exports.ScriptSeriesInputKindEnum = {
|
|
26
|
+
Ohlc: 'ohlc',
|
|
27
|
+
BuiltinIndicator: 'builtin_indicator',
|
|
28
|
+
ScriptOutput: 'script_output'
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* @export
|
|
32
|
+
*/
|
|
33
|
+
exports.ScriptSeriesInputFieldEnum = {
|
|
34
|
+
Open: 'open',
|
|
35
|
+
High: 'high',
|
|
36
|
+
Low: 'low',
|
|
37
|
+
Close: 'close',
|
|
38
|
+
Hl2: 'hl2',
|
|
39
|
+
Hlc3: 'hlc3',
|
|
40
|
+
Ohlc4: 'ohlc4',
|
|
41
|
+
Hlcc4: 'hlcc4'
|
|
42
|
+
};
|
|
43
|
+
/**
|
|
44
|
+
* Check if a given object implements the ScriptSeriesInput interface.
|
|
45
|
+
*/
|
|
46
|
+
function instanceOfScriptSeriesInput(value) {
|
|
47
|
+
if (!('kind' in value) || value['kind'] === undefined)
|
|
48
|
+
return false;
|
|
49
|
+
return true;
|
|
50
|
+
}
|
|
51
|
+
function ScriptSeriesInputFromJSON(json) {
|
|
52
|
+
return ScriptSeriesInputFromJSONTyped(json, false);
|
|
53
|
+
}
|
|
54
|
+
function ScriptSeriesInputFromJSONTyped(json, ignoreDiscriminator) {
|
|
55
|
+
if (json == null) {
|
|
56
|
+
return json;
|
|
57
|
+
}
|
|
58
|
+
return {
|
|
59
|
+
'kind': json['kind'],
|
|
60
|
+
'field': json['field'] == null ? undefined : json['field'],
|
|
61
|
+
'indicator_id': json['indicator_id'] == null ? undefined : json['indicator_id'],
|
|
62
|
+
'series_key': json['series_key'] == null ? undefined : json['series_key'],
|
|
63
|
+
'params': json['params'] == null ? undefined : json['params'],
|
|
64
|
+
'resolved_script_version_id': json['resolved_script_version_id'] == null ? undefined : json['resolved_script_version_id'],
|
|
65
|
+
'node_key': json['node_key'] == null ? undefined : json['node_key'],
|
|
66
|
+
'slot_id': json['slot_id'] == null ? undefined : json['slot_id'],
|
|
67
|
+
};
|
|
68
|
+
}
|
|
69
|
+
function ScriptSeriesInputToJSON(json) {
|
|
70
|
+
return ScriptSeriesInputToJSONTyped(json, false);
|
|
71
|
+
}
|
|
72
|
+
function ScriptSeriesInputToJSONTyped(value, ignoreDiscriminator = false) {
|
|
73
|
+
if (value == null) {
|
|
74
|
+
return value;
|
|
75
|
+
}
|
|
76
|
+
return {
|
|
77
|
+
'kind': value['kind'],
|
|
78
|
+
'field': value['field'],
|
|
79
|
+
'indicator_id': value['indicator_id'],
|
|
80
|
+
'series_key': value['series_key'],
|
|
81
|
+
'params': value['params'],
|
|
82
|
+
'resolved_script_version_id': value['resolved_script_version_id'],
|
|
83
|
+
'node_key': value['node_key'],
|
|
84
|
+
'slot_id': value['slot_id'],
|
|
85
|
+
};
|
|
86
|
+
}
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Invinite API
|
|
3
|
+
* Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Alerts (`POST /v1/alerts`) deliver their events to your destinations (`POST /v1/destinations`) as [Standard Webhooks](https://github.com/standard-webhooks/standard-webhooks/blob/main/spec/standard-webhooks.md): `alert.fired`, `alert.fired.batch`, `alert.status_changed`, `destination.disabled`, `destination.test`, `account.fire_cap_reached`; see `x-webhooks` for each `data` object. Every event is also on the pull feed `GET /v1/alert-events`. Every delivery is a `POST` with `Content-Type: application/json`, the body `{type, timestamp, data}` (or the destination\'s `body_template`) and the headers `webhook-id` (the event id; a batch: its `bat_…` id), `webhook-timestamp` (unix seconds) and `webhook-signature`: space-separated `v1,<base64 HMAC-SHA256 of <webhook-id>.<webhook-timestamp>.<raw body>>`, keyed with the base64-DECODED bytes of the destination\'s `whsec_…` secret — any Standard Webhooks library verifies it. After `POST /v1/destinations/{id}:rotate-secret` the old secret keeps signing beside the new one for 24 h (two `v1` entries). Reject a timestamp older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed; a body above 256 KB is not sent. A failed attempt is retried after [0, 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 10 h, 10 h, 34 h] (attempt n waits the n-th step) plus up to 10 % jitter; the delivery is dead after attempt 10. A 410 disables the destination at once; so do 72 h of nothing but failures with at least 10 failed attempts in a row (a `destination.disabled` event on the feed and a mail; `PATCH` with `status: active` re-enables it). Delivery is at-least-once and unordered: dedupe on `webhook-id`, order by `timestamp`. A `batch_webhook` destination receives `alert.fired.batch` with the pending events in `data.events[]` (dedupe on each `data.event_id`). Fires and deliveries cost no credits; two fair-use caps apply instead: at most 60 fires per alert per rolling hour (beyond: suppressed and counted in the next fire\'s `suppressed_since_last`) and per account and UTC day FREE 100 · LITE 5,000 · STANDARD 50,000 · PRO 500,000 fires (beyond: written to the feed with `delivery_skipped: fire_cap`, not delivered; one `account.fire_cap_reached` per day). ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account, Alerts.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2026-11-13
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
* What feeds one `input.externalSeries` input of a script (a script chain), one value per bar on the alert's symbol, interval and bars; a value the producer does not give that bar reads NaN. (request form)
|
|
14
|
+
* @export
|
|
15
|
+
* @interface ScriptSeriesInputInput
|
|
16
|
+
*/
|
|
17
|
+
export interface ScriptSeriesInputInput {
|
|
18
|
+
/**
|
|
19
|
+
* What feeds the input every bar: `ohlc` a bar field, `builtin_indicator` a built-in indicator's series, `script_output` a plot of a node of `nodes`
|
|
20
|
+
* @type {ScriptSeriesInputInputKindEnum}
|
|
21
|
+
* @memberof ScriptSeriesInputInput
|
|
22
|
+
*/
|
|
23
|
+
kind: ScriptSeriesInputInputKindEnum;
|
|
24
|
+
/**
|
|
25
|
+
* ohlc: the bar field (`hl2` = (high + low) / 2, `hlc3`, `ohlc4`, `hlcc4` = (high + low + 2 × close) / 4; no volume)
|
|
26
|
+
* @type {ScriptSeriesInputInputFieldEnum}
|
|
27
|
+
* @memberof ScriptSeriesInputInput
|
|
28
|
+
*/
|
|
29
|
+
field?: ScriptSeriesInputInputFieldEnum;
|
|
30
|
+
/**
|
|
31
|
+
* builtin_indicator: the built-in indicator (`rsi`, `sma`, `ema`, `macd`, `bb`, …; the indicator condition's ids)
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof ScriptSeriesInputInput
|
|
34
|
+
*/
|
|
35
|
+
indicator_id?: string;
|
|
36
|
+
/**
|
|
37
|
+
* builtin_indicator: which output series (`rsi`, `macd` / `signal` / `histogram`, `upper` / `basis` / `lower`, …)
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof ScriptSeriesInputInput
|
|
40
|
+
*/
|
|
41
|
+
series_key?: string;
|
|
42
|
+
/**
|
|
43
|
+
* builtin_indicator: the indicator's parameters (`length`, `source`, …; absent = its defaults)
|
|
44
|
+
* @type {{ [key: string]: any; }}
|
|
45
|
+
* @memberof ScriptSeriesInputInput
|
|
46
|
+
*/
|
|
47
|
+
params?: {
|
|
48
|
+
[key: string]: any;
|
|
49
|
+
};
|
|
50
|
+
/**
|
|
51
|
+
* script_output: the `node_key` of the producing node
|
|
52
|
+
* @type {string}
|
|
53
|
+
* @memberof ScriptSeriesInputInput
|
|
54
|
+
*/
|
|
55
|
+
node_key?: string;
|
|
56
|
+
/**
|
|
57
|
+
* script_output: the plot slot of the node's script version (its `manifest.plots[].slotId`)
|
|
58
|
+
* @type {string}
|
|
59
|
+
* @memberof ScriptSeriesInputInput
|
|
60
|
+
*/
|
|
61
|
+
slot_id?: string;
|
|
62
|
+
}
|
|
63
|
+
/**
|
|
64
|
+
* @export
|
|
65
|
+
*/
|
|
66
|
+
export declare const ScriptSeriesInputInputKindEnum: {
|
|
67
|
+
readonly Ohlc: "ohlc";
|
|
68
|
+
readonly BuiltinIndicator: "builtin_indicator";
|
|
69
|
+
readonly ScriptOutput: "script_output";
|
|
70
|
+
};
|
|
71
|
+
export type ScriptSeriesInputInputKindEnum = typeof ScriptSeriesInputInputKindEnum[keyof typeof ScriptSeriesInputInputKindEnum];
|
|
72
|
+
/**
|
|
73
|
+
* @export
|
|
74
|
+
*/
|
|
75
|
+
export declare const ScriptSeriesInputInputFieldEnum: {
|
|
76
|
+
readonly Open: "open";
|
|
77
|
+
readonly High: "high";
|
|
78
|
+
readonly Low: "low";
|
|
79
|
+
readonly Close: "close";
|
|
80
|
+
readonly Hl2: "hl2";
|
|
81
|
+
readonly Hlc3: "hlc3";
|
|
82
|
+
readonly Ohlc4: "ohlc4";
|
|
83
|
+
readonly Hlcc4: "hlcc4";
|
|
84
|
+
};
|
|
85
|
+
export type ScriptSeriesInputInputFieldEnum = typeof ScriptSeriesInputInputFieldEnum[keyof typeof ScriptSeriesInputInputFieldEnum];
|
|
86
|
+
/**
|
|
87
|
+
* Check if a given object implements the ScriptSeriesInputInput interface.
|
|
88
|
+
*/
|
|
89
|
+
export declare function instanceOfScriptSeriesInputInput(value: object): value is ScriptSeriesInputInput;
|
|
90
|
+
export declare function ScriptSeriesInputInputFromJSON(json: any): ScriptSeriesInputInput;
|
|
91
|
+
export declare function ScriptSeriesInputInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptSeriesInputInput;
|
|
92
|
+
export declare function ScriptSeriesInputInputToJSON(json: any): ScriptSeriesInputInput;
|
|
93
|
+
export declare function ScriptSeriesInputInputToJSONTyped(value?: ScriptSeriesInputInput | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* Invinite API
|
|
6
|
+
* Invinite financial data API. Each operation has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Remaining` what is left of the plan\'s included credits after it. A `304 Not Modified` costs nothing. `GET /v1/me/usage` returns your account\'s usage by day, product family and key (it costs no credits). **Coverage.** Financial data covers US SEC registrants and their US listings; a symbol that is not a US SEC registrant (or a crypto pair such as `X:BTCUSD`) is not a known company and answers 404. A known company with no data in a family (for example no statements yet) answers 404 with `code: not_covered`; an empty page of a covered company stays 200 with an empty list. `GET /v1/companies` lists every known company. ## Webhooks Alerts (`POST /v1/alerts`) deliver their events to your destinations (`POST /v1/destinations`) as [Standard Webhooks](https://github.com/standard-webhooks/standard-webhooks/blob/main/spec/standard-webhooks.md): `alert.fired`, `alert.fired.batch`, `alert.status_changed`, `destination.disabled`, `destination.test`, `account.fire_cap_reached`; see `x-webhooks` for each `data` object. Every event is also on the pull feed `GET /v1/alert-events`. Every delivery is a `POST` with `Content-Type: application/json`, the body `{type, timestamp, data}` (or the destination\'s `body_template`) and the headers `webhook-id` (the event id; a batch: its `bat_…` id), `webhook-timestamp` (unix seconds) and `webhook-signature`: space-separated `v1,<base64 HMAC-SHA256 of <webhook-id>.<webhook-timestamp>.<raw body>>`, keyed with the base64-DECODED bytes of the destination\'s `whsec_…` secret — any Standard Webhooks library verifies it. After `POST /v1/destinations/{id}:rotate-secret` the old secret keeps signing beside the new one for 24 h (two `v1` entries). Reject a timestamp older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed; a body above 256 KB is not sent. A failed attempt is retried after [0, 5 s, 5 min, 30 min, 2 h, 5 h, 10 h, 10 h, 10 h, 34 h] (attempt n waits the n-th step) plus up to 10 % jitter; the delivery is dead after attempt 10. A 410 disables the destination at once; so do 72 h of nothing but failures with at least 10 failed attempts in a row (a `destination.disabled` event on the feed and a mail; `PATCH` with `status: active` re-enables it). Delivery is at-least-once and unordered: dedupe on `webhook-id`, order by `timestamp`. A `batch_webhook` destination receives `alert.fired.batch` with the pending events in `data.events[]` (dedupe on each `data.event_id`). Fires and deliveries cost no credits; two fair-use caps apply instead: at most 60 fires per alert per rolling hour (beyond: suppressed and counted in the next fire\'s `suppressed_since_last`) and per account and UTC day FREE 100 · LITE 5,000 · STANDARD 50,000 · PRO 500,000 fires (beyond: written to the feed with `delivery_skipped: fire_cap`, not delivered; one `account.fire_cap_reached` per day). ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. News: News text is Invinite\'s own summary of the issuer\'s or the SEC\'s publication (the publisher\'s text and media are never served); the licensee shows the attribution (publisher, source URL and date) next to it; the resale rule applies. PDF documents: Branded PDFs of transcripts and news items are permanent URLs to one shared file per version. They may be shown, downloaded and forwarded unmodified with the notice page intact; the resale rule applies unchanged. News PDFs carry Invinite\'s summary of the issuer\'s or the SEC\'s publication under the attribution stated on their notice page; a PDF disappears when the item is taken down or its source\'s reuse is denied. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/me` and `/v1/me/usage` serve no licensed data and carry none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, News, WebSocket, Account, Alerts.
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 2026-11-13
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.ScriptSeriesInputInputFieldEnum = exports.ScriptSeriesInputInputKindEnum = void 0;
|
|
17
|
+
exports.instanceOfScriptSeriesInputInput = instanceOfScriptSeriesInputInput;
|
|
18
|
+
exports.ScriptSeriesInputInputFromJSON = ScriptSeriesInputInputFromJSON;
|
|
19
|
+
exports.ScriptSeriesInputInputFromJSONTyped = ScriptSeriesInputInputFromJSONTyped;
|
|
20
|
+
exports.ScriptSeriesInputInputToJSON = ScriptSeriesInputInputToJSON;
|
|
21
|
+
exports.ScriptSeriesInputInputToJSONTyped = ScriptSeriesInputInputToJSONTyped;
|
|
22
|
+
/**
|
|
23
|
+
* @export
|
|
24
|
+
*/
|
|
25
|
+
exports.ScriptSeriesInputInputKindEnum = {
|
|
26
|
+
Ohlc: 'ohlc',
|
|
27
|
+
BuiltinIndicator: 'builtin_indicator',
|
|
28
|
+
ScriptOutput: 'script_output'
|
|
29
|
+
};
|
|
30
|
+
/**
|
|
31
|
+
* @export
|
|
32
|
+
*/
|
|
33
|
+
exports.ScriptSeriesInputInputFieldEnum = {
|
|
34
|
+
Open: 'open',
|
|
35
|
+
High: 'high',
|
|
36
|
+
Low: 'low',
|
|
37
|
+
Close: 'close',
|
|
38
|
+
Hl2: 'hl2',
|
|
39
|
+
Hlc3: 'hlc3',
|
|
40
|
+
Ohlc4: 'ohlc4',
|
|
41
|
+
Hlcc4: 'hlcc4'
|
|
42
|
+
};
|
|
43
|
+
/**
|
|
44
|
+
* Check if a given object implements the ScriptSeriesInputInput interface.
|
|
45
|
+
*/
|
|
46
|
+
function instanceOfScriptSeriesInputInput(value) {
|
|
47
|
+
if (!('kind' in value) || value['kind'] === undefined)
|
|
48
|
+
return false;
|
|
49
|
+
return true;
|
|
50
|
+
}
|
|
51
|
+
function ScriptSeriesInputInputFromJSON(json) {
|
|
52
|
+
return ScriptSeriesInputInputFromJSONTyped(json, false);
|
|
53
|
+
}
|
|
54
|
+
function ScriptSeriesInputInputFromJSONTyped(json, ignoreDiscriminator) {
|
|
55
|
+
if (json == null) {
|
|
56
|
+
return json;
|
|
57
|
+
}
|
|
58
|
+
return {
|
|
59
|
+
'kind': json['kind'],
|
|
60
|
+
'field': json['field'] == null ? undefined : json['field'],
|
|
61
|
+
'indicator_id': json['indicator_id'] == null ? undefined : json['indicator_id'],
|
|
62
|
+
'series_key': json['series_key'] == null ? undefined : json['series_key'],
|
|
63
|
+
'params': json['params'] == null ? undefined : json['params'],
|
|
64
|
+
'node_key': json['node_key'] == null ? undefined : json['node_key'],
|
|
65
|
+
'slot_id': json['slot_id'] == null ? undefined : json['slot_id'],
|
|
66
|
+
};
|
|
67
|
+
}
|
|
68
|
+
function ScriptSeriesInputInputToJSON(json) {
|
|
69
|
+
return ScriptSeriesInputInputToJSONTyped(json, false);
|
|
70
|
+
}
|
|
71
|
+
function ScriptSeriesInputInputToJSONTyped(value, ignoreDiscriminator = false) {
|
|
72
|
+
if (value == null) {
|
|
73
|
+
return value;
|
|
74
|
+
}
|
|
75
|
+
return {
|
|
76
|
+
'kind': value['kind'],
|
|
77
|
+
'field': value['field'],
|
|
78
|
+
'indicator_id': value['indicator_id'],
|
|
79
|
+
'series_key': value['series_key'],
|
|
80
|
+
'params': value['params'],
|
|
81
|
+
'node_key': value['node_key'],
|
|
82
|
+
'slot_id': value['slot_id'],
|
|
83
|
+
};
|
|
84
|
+
}
|
package/dist/models/index.d.ts
CHANGED
|
@@ -265,6 +265,12 @@ export * from './RatioPeriod';
|
|
|
265
265
|
export * from './ReviewChain';
|
|
266
266
|
export * from './Script';
|
|
267
267
|
export * from './ScriptDiagnostic';
|
|
268
|
+
export * from './ScriptEvaluation';
|
|
269
|
+
export * from './ScriptEvaluationInput';
|
|
270
|
+
export * from './ScriptNode';
|
|
271
|
+
export * from './ScriptNodeInput';
|
|
272
|
+
export * from './ScriptSeriesInput';
|
|
273
|
+
export * from './ScriptSeriesInputInput';
|
|
268
274
|
export * from './ScriptVersion';
|
|
269
275
|
export * from './SearchCoverage';
|
|
270
276
|
export * from './SearchCoverageLeg';
|
package/dist/models/index.js
CHANGED
|
@@ -283,6 +283,12 @@ __exportStar(require("./RatioPeriod"), exports);
|
|
|
283
283
|
__exportStar(require("./ReviewChain"), exports);
|
|
284
284
|
__exportStar(require("./Script"), exports);
|
|
285
285
|
__exportStar(require("./ScriptDiagnostic"), exports);
|
|
286
|
+
__exportStar(require("./ScriptEvaluation"), exports);
|
|
287
|
+
__exportStar(require("./ScriptEvaluationInput"), exports);
|
|
288
|
+
__exportStar(require("./ScriptNode"), exports);
|
|
289
|
+
__exportStar(require("./ScriptNodeInput"), exports);
|
|
290
|
+
__exportStar(require("./ScriptSeriesInput"), exports);
|
|
291
|
+
__exportStar(require("./ScriptSeriesInputInput"), exports);
|
|
286
292
|
__exportStar(require("./ScriptVersion"), exports);
|
|
287
293
|
__exportStar(require("./SearchCoverage"), exports);
|
|
288
294
|
__exportStar(require("./SearchCoverageLeg"), exports);
|
package/docs/AlertCondition.md
CHANGED
|
@@ -60,7 +60,10 @@ Name | Type
|
|
|
60
60
|
`days` | Array<number>
|
|
61
61
|
`script_version_id` | string
|
|
62
62
|
`inputs` | { [key: string]: any; }
|
|
63
|
+
`series_inputs` | [{ [key: string]: ScriptSeriesInput; }](ScriptSeriesInput.md)
|
|
64
|
+
`nodes` | [Array<ScriptNode>](ScriptNode.md)
|
|
63
65
|
`alert_ids` | Array<string>
|
|
66
|
+
`evaluation` | [ScriptEvaluation](ScriptEvaluation.md)
|
|
64
67
|
`template` | [IndicatorTemplateRef](IndicatorTemplateRef.md)
|
|
65
68
|
`condition` | [IndicatorCondition](IndicatorCondition.md)
|
|
66
69
|
`filters` | [IndicatorFilters](IndicatorFilters.md)
|
|
@@ -126,7 +129,10 @@ const example = {
|
|
|
126
129
|
"days": null,
|
|
127
130
|
"script_version_id": null,
|
|
128
131
|
"inputs": null,
|
|
132
|
+
"series_inputs": null,
|
|
133
|
+
"nodes": null,
|
|
129
134
|
"alert_ids": null,
|
|
135
|
+
"evaluation": null,
|
|
130
136
|
"template": null,
|
|
131
137
|
"condition": null,
|
|
132
138
|
"filters": null,
|
|
@@ -60,7 +60,10 @@ Name | Type
|
|
|
60
60
|
`days` | Array<number>
|
|
61
61
|
`script_version_id` | string
|
|
62
62
|
`inputs` | { [key: string]: any; }
|
|
63
|
+
`series_inputs` | [{ [key: string]: ScriptSeriesInputInput; }](ScriptSeriesInputInput.md)
|
|
64
|
+
`nodes` | [Array<ScriptNodeInput>](ScriptNodeInput.md)
|
|
63
65
|
`alert_ids` | Array<string>
|
|
66
|
+
`evaluation` | [ScriptEvaluationInput](ScriptEvaluationInput.md)
|
|
64
67
|
`template` | [IndicatorTemplateRef](IndicatorTemplateRef.md)
|
|
65
68
|
`condition` | [IndicatorConditionInput](IndicatorConditionInput.md)
|
|
66
69
|
`filters` | [IndicatorFiltersInput](IndicatorFiltersInput.md)
|
|
@@ -125,7 +128,10 @@ const example = {
|
|
|
125
128
|
"days": null,
|
|
126
129
|
"script_version_id": null,
|
|
127
130
|
"inputs": null,
|
|
131
|
+
"series_inputs": null,
|
|
132
|
+
"nodes": null,
|
|
128
133
|
"alert_ids": null,
|
|
134
|
+
"evaluation": null,
|
|
129
135
|
"template": null,
|
|
130
136
|
"condition": null,
|
|
131
137
|
"filters": null,
|
package/docs/IPOsApi.md
CHANGED
|
@@ -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. A US ETF ticker of either identity (SPY, TQQQ)
|
|
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 answers one 404 `not_covered` naming it, whatever identifier names it — a ticker of either identity (SPY, TQQQ) or the CIK of an ETF that is its own registrant (SPY\'s): no Form D data exists for a fund. A CIK of no listed company (a private issuer) still reads the Form D data (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. A US ETF ticker of either identity (SPY, TQQQ)
|
|
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 answers one 404 `not_covered` naming it, whatever identifier names it — a ticker of either identity (SPY, TQQQ) or the CIK of an ETF that is its own registrant (SPY\'s): no Form D data exists for a fund. A CIK of no listed company (a private issuer) still reads the Form D data | [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`] |
|
package/docs/InsiderTradesApi.md
CHANGED
|
@@ -98,7 +98,7 @@ example().catch(console.error);
|
|
|
98
98
|
|
|
99
99
|
List insider trades
|
|
100
100
|
|
|
101
|
-
|
|
101
|
+
Insider transaction lines (Form 4; Forms 3 and 5 where the SEC insider data set supplies them), newest filing first. Since release 5.7 the default result includes derivative-security lines (options, RSUs, warrants; `is_derivative: true` on the row) beside the non-derivative ones. `is_derivative=false` restores the non-derivative-only result of the releases before 5.7, which is what a buy / sell aggregate wants.
|
|
102
102
|
|
|
103
103
|
### Example
|
|
104
104
|
|
|
@@ -134,7 +134,7 @@ async function example() {
|
|
|
134
134
|
transactionDateGte: 2025-01-01,
|
|
135
135
|
// Date | `transaction_date` on or before this value (rows without a transaction date are excluded) (optional)
|
|
136
136
|
transactionDateLte: 2025-01-01,
|
|
137
|
-
// boolean | true = only derivative-security lines; false = only non-derivative lines (optional)
|
|
137
|
+
// boolean | Omitted = derivative-security lines (options, RSUs, warrants) AND non-derivative lines, the default since release 5.7; true = only derivative-security lines; false = only non-derivative lines (the result of the releases before 5.7: use it for a buy / sell aggregate) (optional)
|
|
138
138
|
isDerivative: false,
|
|
139
139
|
// 'filed_at' | '-filed_at' | Sort field (`-` = descending); the id tiebreaker is always appended. Default `-filed_at` (optional)
|
|
140
140
|
sort: -filed_at,
|
|
@@ -171,7 +171,7 @@ example().catch(console.error);
|
|
|
171
171
|
| **filedAtLt** | `Date` | `filed_at` before this value | [Optional] [Defaults to `undefined`] |
|
|
172
172
|
| **transactionDateGte** | `Date` | `transaction_date` on or after this value (rows without a transaction date are excluded) | [Optional] [Defaults to `undefined`] |
|
|
173
173
|
| **transactionDateLte** | `Date` | `transaction_date` on or before this value (rows without a transaction date are excluded) | [Optional] [Defaults to `undefined`] |
|
|
174
|
-
| **isDerivative** | `boolean` | true = only derivative-security lines; false = only non-derivative lines | [Optional] [Defaults to `undefined`] |
|
|
174
|
+
| **isDerivative** | `boolean` | Omitted = derivative-security lines (options, RSUs, warrants) AND non-derivative lines, the default since release 5.7; true = only derivative-security lines; false = only non-derivative lines (the result of the releases before 5.7: use it for a buy / sell aggregate) | [Optional] [Defaults to `undefined`] |
|
|
175
175
|
| **sort** | `filed_at`, `-filed_at` | Sort field (`-` = descending); the id tiebreaker is always appended. Default `-filed_at` | [Optional] [Defaults to `'-filed_at'`] [Enum: filed_at, -filed_at] |
|
|
176
176
|
| **fields** | `string` | Comma list of root-level fields to keep (R7) | [Optional] [Defaults to `undefined`] |
|
|
177
177
|
| **limit** | `number` | Rows per page (default 25, max 200) | [Optional] [Defaults to `25`] |
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
|
|
2
|
+
# ScriptEvaluation
|
|
3
|
+
|
|
4
|
+
When a script / indicator alert evaluates: `bar_close` (default) at each close of its interval, or `pre_close` — `offset_minutes` before the US session close (16:00 New York, 13:00 on a half day, never on a weekend or market holiday) on the still-forming bar of its interval. A pre_close alert delivers ONLY its pre-close evaluations (its closed bars still advance the script; their events are not delivered), at most once per session; the fire\'s `reason.details` carry `phase: \"pre_close\"`, `offset_minutes` and `session_close`.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`kind` | string
|
|
11
|
+
`offset_minutes` | number
|
|
12
|
+
`exchange` | string
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { ScriptEvaluation } from '@invinite-org/data-api-client'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"kind": null,
|
|
22
|
+
"offset_minutes": null,
|
|
23
|
+
"exchange": null,
|
|
24
|
+
} satisfies ScriptEvaluation
|
|
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 ScriptEvaluation
|
|
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
|
+
# ScriptEvaluationInput
|
|
3
|
+
|
|
4
|
+
When a script / indicator alert evaluates: `bar_close` (default) at each close of its interval, or `pre_close` — `offset_minutes` before the US session close (16:00 New York, 13:00 on a half day, never on a weekend or market holiday) on the still-forming bar of its interval. A pre_close alert delivers ONLY its pre-close evaluations (its closed bars still advance the script; their events are not delivered), at most once per session; the fire\'s `reason.details` carry `phase: \"pre_close\"`, `offset_minutes` and `session_close`. (request form)
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`kind` | string
|
|
11
|
+
`offset_minutes` | number
|
|
12
|
+
`exchange` | string
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { ScriptEvaluationInput } from '@invinite-org/data-api-client'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"kind": null,
|
|
22
|
+
"offset_minutes": null,
|
|
23
|
+
"exchange": null,
|
|
24
|
+
} satisfies ScriptEvaluationInput
|
|
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 ScriptEvaluationInput
|
|
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
|
+
# ScriptNode
|
|
3
|
+
|
|
4
|
+
A producer script of a chain: evaluated on the alert\'s symbol, interval and bars before the scripts that read its plots.
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`node_key` | string
|
|
11
|
+
`script_version_id` | string
|
|
12
|
+
`inputs` | { [key: string]: any; }
|
|
13
|
+
`series_inputs` | [{ [key: string]: ScriptSeriesInput; }](ScriptSeriesInput.md)
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import type { ScriptNode } from '@invinite-org/data-api-client'
|
|
19
|
+
|
|
20
|
+
// TODO: Update the object below with actual values
|
|
21
|
+
const example = {
|
|
22
|
+
"node_key": null,
|
|
23
|
+
"script_version_id": null,
|
|
24
|
+
"inputs": null,
|
|
25
|
+
"series_inputs": null,
|
|
26
|
+
} satisfies ScriptNode
|
|
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 ScriptNode
|
|
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
|
+
|