@invinite-org/data-api-client 6.3.0 → 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 +29 -5
- package/dist/esm/models/AlertCondition.js +12 -1
- package/dist/esm/models/AlertConditionInput.d.ts +29 -5
- 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/Company.d.ts +6 -6
- 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 +29 -5
- package/dist/models/AlertCondition.js +12 -1
- package/dist/models/AlertConditionInput.d.ts +29 -5
- 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/Company.d.ts +6 -6
- 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 +7 -1
- package/docs/AlertConditionInput.md +7 -1
- package/docs/CompaniesApi.md +4 -4
- 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/InsiderTradesApi.md +5 -5
- package/docs/InvestorDocumentsApi.md +4 -4
- package/docs/MetricsApi.md +10 -10
- package/docs/NewsApi.md +6 -6
- package/docs/ReferenceApi.md +6 -6
- 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/docs/TranscriptsApi.md +2 -2
- package/package.json +1 -1
- package/src/apis/InsiderTradesApi.ts +2 -2
- package/src/models/AlertCondition.ts +52 -6
- package/src/models/AlertConditionInput.ts +52 -6
- package/src/models/AlertTrigger.ts +2 -2
- package/src/models/AlertTriggerInput.ts +2 -2
- package/src/models/Company.ts +6 -6
- 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,107 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Invinite API
|
|
5
|
+
* 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.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2026-11-13
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
/**
|
|
17
|
+
* 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)
|
|
18
|
+
* @export
|
|
19
|
+
* @interface ScriptEvaluationInput
|
|
20
|
+
*/
|
|
21
|
+
export interface ScriptEvaluationInput {
|
|
22
|
+
/**
|
|
23
|
+
* `bar_close` at each bar close, `pre_close` before the session close
|
|
24
|
+
* @type {ScriptEvaluationInputKindEnum}
|
|
25
|
+
* @memberof ScriptEvaluationInput
|
|
26
|
+
*/
|
|
27
|
+
kind: ScriptEvaluationInputKindEnum;
|
|
28
|
+
/**
|
|
29
|
+
* pre_close: minutes before the session close (1–720; any interval)
|
|
30
|
+
* @type {number}
|
|
31
|
+
* @memberof ScriptEvaluationInput
|
|
32
|
+
*/
|
|
33
|
+
offset_minutes?: number;
|
|
34
|
+
/**
|
|
35
|
+
* pre_close: the venue whose close anchors the evaluation (every US venue shares the 16:00 New York close and the US holiday calendar); optional for a US stock, required for crypto and commodities
|
|
36
|
+
* @type {ScriptEvaluationInputExchangeEnum}
|
|
37
|
+
* @memberof ScriptEvaluationInput
|
|
38
|
+
*/
|
|
39
|
+
exchange?: ScriptEvaluationInputExchangeEnum;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
/**
|
|
44
|
+
* @export
|
|
45
|
+
*/
|
|
46
|
+
export const ScriptEvaluationInputKindEnum = {
|
|
47
|
+
BarClose: 'bar_close',
|
|
48
|
+
PreClose: 'pre_close'
|
|
49
|
+
} as const;
|
|
50
|
+
export type ScriptEvaluationInputKindEnum = typeof ScriptEvaluationInputKindEnum[keyof typeof ScriptEvaluationInputKindEnum];
|
|
51
|
+
|
|
52
|
+
/**
|
|
53
|
+
* @export
|
|
54
|
+
*/
|
|
55
|
+
export const ScriptEvaluationInputExchangeEnum = {
|
|
56
|
+
Nyse: 'NYSE',
|
|
57
|
+
Nasdaq: 'NASDAQ',
|
|
58
|
+
Amex: 'AMEX',
|
|
59
|
+
Nysearca: 'NYSEARCA',
|
|
60
|
+
Nysemkt: 'NYSEMKT',
|
|
61
|
+
Bats: 'BATS',
|
|
62
|
+
Cboe: 'CBOE'
|
|
63
|
+
} as const;
|
|
64
|
+
export type ScriptEvaluationInputExchangeEnum = typeof ScriptEvaluationInputExchangeEnum[keyof typeof ScriptEvaluationInputExchangeEnum];
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
/**
|
|
68
|
+
* Check if a given object implements the ScriptEvaluationInput interface.
|
|
69
|
+
*/
|
|
70
|
+
export function instanceOfScriptEvaluationInput(value: object): value is ScriptEvaluationInput {
|
|
71
|
+
if (!('kind' in value) || value['kind'] === undefined) return false;
|
|
72
|
+
return true;
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
export function ScriptEvaluationInputFromJSON(json: any): ScriptEvaluationInput {
|
|
76
|
+
return ScriptEvaluationInputFromJSONTyped(json, false);
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
export function ScriptEvaluationInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptEvaluationInput {
|
|
80
|
+
if (json == null) {
|
|
81
|
+
return json;
|
|
82
|
+
}
|
|
83
|
+
return {
|
|
84
|
+
|
|
85
|
+
'kind': json['kind'],
|
|
86
|
+
'offset_minutes': json['offset_minutes'] == null ? undefined : json['offset_minutes'],
|
|
87
|
+
'exchange': json['exchange'] == null ? undefined : json['exchange'],
|
|
88
|
+
};
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
export function ScriptEvaluationInputToJSON(json: any): ScriptEvaluationInput {
|
|
92
|
+
return ScriptEvaluationInputToJSONTyped(json, false);
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
export function ScriptEvaluationInputToJSONTyped(value?: ScriptEvaluationInput | null, ignoreDiscriminator: boolean = false): any {
|
|
96
|
+
if (value == null) {
|
|
97
|
+
return value;
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
return {
|
|
101
|
+
|
|
102
|
+
'kind': value['kind'],
|
|
103
|
+
'offset_minutes': value['offset_minutes'],
|
|
104
|
+
'exchange': value['exchange'],
|
|
105
|
+
};
|
|
106
|
+
}
|
|
107
|
+
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Invinite API
|
|
5
|
+
* 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.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2026-11-13
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
import type { ScriptSeriesInput } from './ScriptSeriesInput';
|
|
17
|
+
import {
|
|
18
|
+
ScriptSeriesInputFromJSON,
|
|
19
|
+
ScriptSeriesInputFromJSONTyped,
|
|
20
|
+
ScriptSeriesInputToJSON,
|
|
21
|
+
ScriptSeriesInputToJSONTyped,
|
|
22
|
+
} from './ScriptSeriesInput';
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* A producer script of a chain: evaluated on the alert's symbol, interval and bars before the scripts that read its plots.
|
|
26
|
+
* @export
|
|
27
|
+
* @interface ScriptNode
|
|
28
|
+
*/
|
|
29
|
+
export interface ScriptNode {
|
|
30
|
+
/**
|
|
31
|
+
* The node's name in this plan (unique, not `root`), named by `script_output` series inputs
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof ScriptNode
|
|
34
|
+
*/
|
|
35
|
+
node_key: string;
|
|
36
|
+
/**
|
|
37
|
+
* The producer's script version (`scv_…`, status ok, of a script of this account)
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof ScriptNode
|
|
40
|
+
*/
|
|
41
|
+
script_version_id: string;
|
|
42
|
+
/**
|
|
43
|
+
* Values for the producer's declared inputs (absent = the defaults)
|
|
44
|
+
* @type {{ [key: string]: any; }}
|
|
45
|
+
* @memberof ScriptNode
|
|
46
|
+
*/
|
|
47
|
+
inputs?: { [key: string]: any; };
|
|
48
|
+
/**
|
|
49
|
+
* The producer's own `input.externalSeries` inputs (a built-in series, a bar field, or an earlier node's plot)
|
|
50
|
+
* @type {{ [key: string]: ScriptSeriesInput; }}
|
|
51
|
+
* @memberof ScriptNode
|
|
52
|
+
*/
|
|
53
|
+
series_inputs?: { [key: string]: ScriptSeriesInput; };
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
/**
|
|
57
|
+
* Check if a given object implements the ScriptNode interface.
|
|
58
|
+
*/
|
|
59
|
+
export function instanceOfScriptNode(value: object): value is ScriptNode {
|
|
60
|
+
if (!('node_key' in value) || value['node_key'] === undefined) return false;
|
|
61
|
+
if (!('script_version_id' in value) || value['script_version_id'] === undefined) return false;
|
|
62
|
+
return true;
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
export function ScriptNodeFromJSON(json: any): ScriptNode {
|
|
66
|
+
return ScriptNodeFromJSONTyped(json, false);
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
export function ScriptNodeFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptNode {
|
|
70
|
+
if (json == null) {
|
|
71
|
+
return json;
|
|
72
|
+
}
|
|
73
|
+
return {
|
|
74
|
+
|
|
75
|
+
'node_key': json['node_key'],
|
|
76
|
+
'script_version_id': json['script_version_id'],
|
|
77
|
+
'inputs': json['inputs'] == null ? undefined : json['inputs'],
|
|
78
|
+
'series_inputs': json['series_inputs'] == null ? undefined : (mapValues(json['series_inputs'], ScriptSeriesInputFromJSON)),
|
|
79
|
+
};
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
export function ScriptNodeToJSON(json: any): ScriptNode {
|
|
83
|
+
return ScriptNodeToJSONTyped(json, false);
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
export function ScriptNodeToJSONTyped(value?: ScriptNode | null, ignoreDiscriminator: boolean = false): any {
|
|
87
|
+
if (value == null) {
|
|
88
|
+
return value;
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
return {
|
|
92
|
+
|
|
93
|
+
'node_key': value['node_key'],
|
|
94
|
+
'script_version_id': value['script_version_id'],
|
|
95
|
+
'inputs': value['inputs'],
|
|
96
|
+
'series_inputs': value['series_inputs'] == null ? undefined : (mapValues(value['series_inputs'], ScriptSeriesInputToJSON)),
|
|
97
|
+
};
|
|
98
|
+
}
|
|
99
|
+
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Invinite API
|
|
5
|
+
* 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.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2026-11-13
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
import type { ScriptSeriesInputInput } from './ScriptSeriesInputInput';
|
|
17
|
+
import {
|
|
18
|
+
ScriptSeriesInputInputFromJSON,
|
|
19
|
+
ScriptSeriesInputInputFromJSONTyped,
|
|
20
|
+
ScriptSeriesInputInputToJSON,
|
|
21
|
+
ScriptSeriesInputInputToJSONTyped,
|
|
22
|
+
} from './ScriptSeriesInputInput';
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* A producer script of a chain: evaluated on the alert's symbol, interval and bars before the scripts that read its plots. (request form)
|
|
26
|
+
* @export
|
|
27
|
+
* @interface ScriptNodeInput
|
|
28
|
+
*/
|
|
29
|
+
export interface ScriptNodeInput {
|
|
30
|
+
/**
|
|
31
|
+
* The node's name in this plan (unique, not `root`), named by `script_output` series inputs
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof ScriptNodeInput
|
|
34
|
+
*/
|
|
35
|
+
node_key: string;
|
|
36
|
+
/**
|
|
37
|
+
* The producer's script version (`scv_…`, status ok, of a script of this account)
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof ScriptNodeInput
|
|
40
|
+
*/
|
|
41
|
+
script_version_id: string;
|
|
42
|
+
/**
|
|
43
|
+
* Values for the producer's declared inputs (absent = the defaults)
|
|
44
|
+
* @type {{ [key: string]: any; }}
|
|
45
|
+
* @memberof ScriptNodeInput
|
|
46
|
+
*/
|
|
47
|
+
inputs?: { [key: string]: any; };
|
|
48
|
+
/**
|
|
49
|
+
* The producer's own `input.externalSeries` inputs (a built-in series, a bar field, or an earlier node's plot)
|
|
50
|
+
* @type {{ [key: string]: ScriptSeriesInputInput; }}
|
|
51
|
+
* @memberof ScriptNodeInput
|
|
52
|
+
*/
|
|
53
|
+
series_inputs?: { [key: string]: ScriptSeriesInputInput; };
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
/**
|
|
57
|
+
* Check if a given object implements the ScriptNodeInput interface.
|
|
58
|
+
*/
|
|
59
|
+
export function instanceOfScriptNodeInput(value: object): value is ScriptNodeInput {
|
|
60
|
+
if (!('node_key' in value) || value['node_key'] === undefined) return false;
|
|
61
|
+
if (!('script_version_id' in value) || value['script_version_id'] === undefined) return false;
|
|
62
|
+
return true;
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
export function ScriptNodeInputFromJSON(json: any): ScriptNodeInput {
|
|
66
|
+
return ScriptNodeInputFromJSONTyped(json, false);
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
export function ScriptNodeInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptNodeInput {
|
|
70
|
+
if (json == null) {
|
|
71
|
+
return json;
|
|
72
|
+
}
|
|
73
|
+
return {
|
|
74
|
+
|
|
75
|
+
'node_key': json['node_key'],
|
|
76
|
+
'script_version_id': json['script_version_id'],
|
|
77
|
+
'inputs': json['inputs'] == null ? undefined : json['inputs'],
|
|
78
|
+
'series_inputs': json['series_inputs'] == null ? undefined : (mapValues(json['series_inputs'], ScriptSeriesInputInputFromJSON)),
|
|
79
|
+
};
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
export function ScriptNodeInputToJSON(json: any): ScriptNodeInput {
|
|
83
|
+
return ScriptNodeInputToJSONTyped(json, false);
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
export function ScriptNodeInputToJSONTyped(value?: ScriptNodeInput | null, ignoreDiscriminator: boolean = false): any {
|
|
87
|
+
if (value == null) {
|
|
88
|
+
return value;
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
return {
|
|
92
|
+
|
|
93
|
+
'node_key': value['node_key'],
|
|
94
|
+
'script_version_id': value['script_version_id'],
|
|
95
|
+
'inputs': value['inputs'],
|
|
96
|
+
'series_inputs': value['series_inputs'] == null ? undefined : (mapValues(value['series_inputs'], ScriptSeriesInputInputToJSON)),
|
|
97
|
+
};
|
|
98
|
+
}
|
|
99
|
+
|
|
@@ -0,0 +1,149 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Invinite API
|
|
5
|
+
* 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.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2026-11-13
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
/**
|
|
17
|
+
* 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.
|
|
18
|
+
* @export
|
|
19
|
+
* @interface ScriptSeriesInput
|
|
20
|
+
*/
|
|
21
|
+
export interface ScriptSeriesInput {
|
|
22
|
+
/**
|
|
23
|
+
* 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`
|
|
24
|
+
* @type {ScriptSeriesInputKindEnum}
|
|
25
|
+
* @memberof ScriptSeriesInput
|
|
26
|
+
*/
|
|
27
|
+
kind: ScriptSeriesInputKindEnum;
|
|
28
|
+
/**
|
|
29
|
+
* ohlc: the bar field (`hl2` = (high + low) / 2, `hlc3`, `ohlc4`, `hlcc4` = (high + low + 2 × close) / 4; no volume)
|
|
30
|
+
* @type {ScriptSeriesInputFieldEnum}
|
|
31
|
+
* @memberof ScriptSeriesInput
|
|
32
|
+
*/
|
|
33
|
+
field?: ScriptSeriesInputFieldEnum;
|
|
34
|
+
/**
|
|
35
|
+
* builtin_indicator: the built-in indicator (`rsi`, `sma`, `ema`, `macd`, `bb`, …; the indicator condition's ids)
|
|
36
|
+
* @type {string}
|
|
37
|
+
* @memberof ScriptSeriesInput
|
|
38
|
+
*/
|
|
39
|
+
indicator_id?: string;
|
|
40
|
+
/**
|
|
41
|
+
* builtin_indicator: which output series (`rsi`, `macd` / `signal` / `histogram`, `upper` / `basis` / `lower`, …)
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof ScriptSeriesInput
|
|
44
|
+
*/
|
|
45
|
+
series_key?: string;
|
|
46
|
+
/**
|
|
47
|
+
* builtin_indicator: the indicator's parameters (`length`, `source`, …; absent = its defaults)
|
|
48
|
+
* @type {{ [key: string]: any; }}
|
|
49
|
+
* @memberof ScriptSeriesInput
|
|
50
|
+
*/
|
|
51
|
+
params?: { [key: string]: any; };
|
|
52
|
+
/**
|
|
53
|
+
* 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
|
|
54
|
+
* @type {string}
|
|
55
|
+
* @memberof ScriptSeriesInput
|
|
56
|
+
*/
|
|
57
|
+
resolved_script_version_id?: string;
|
|
58
|
+
/**
|
|
59
|
+
* script_output: the `node_key` of the producing node
|
|
60
|
+
* @type {string}
|
|
61
|
+
* @memberof ScriptSeriesInput
|
|
62
|
+
*/
|
|
63
|
+
node_key?: string;
|
|
64
|
+
/**
|
|
65
|
+
* script_output: the plot slot of the node's script version (its `manifest.plots[].slotId`)
|
|
66
|
+
* @type {string}
|
|
67
|
+
* @memberof ScriptSeriesInput
|
|
68
|
+
*/
|
|
69
|
+
slot_id?: string;
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
/**
|
|
74
|
+
* @export
|
|
75
|
+
*/
|
|
76
|
+
export const ScriptSeriesInputKindEnum = {
|
|
77
|
+
Ohlc: 'ohlc',
|
|
78
|
+
BuiltinIndicator: 'builtin_indicator',
|
|
79
|
+
ScriptOutput: 'script_output'
|
|
80
|
+
} as const;
|
|
81
|
+
export type ScriptSeriesInputKindEnum = typeof ScriptSeriesInputKindEnum[keyof typeof ScriptSeriesInputKindEnum] | (string & {});
|
|
82
|
+
|
|
83
|
+
/**
|
|
84
|
+
* @export
|
|
85
|
+
*/
|
|
86
|
+
export const ScriptSeriesInputFieldEnum = {
|
|
87
|
+
Open: 'open',
|
|
88
|
+
High: 'high',
|
|
89
|
+
Low: 'low',
|
|
90
|
+
Close: 'close',
|
|
91
|
+
Hl2: 'hl2',
|
|
92
|
+
Hlc3: 'hlc3',
|
|
93
|
+
Ohlc4: 'ohlc4',
|
|
94
|
+
Hlcc4: 'hlcc4'
|
|
95
|
+
} as const;
|
|
96
|
+
export type ScriptSeriesInputFieldEnum = typeof ScriptSeriesInputFieldEnum[keyof typeof ScriptSeriesInputFieldEnum] | (string & {});
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
/**
|
|
100
|
+
* Check if a given object implements the ScriptSeriesInput interface.
|
|
101
|
+
*/
|
|
102
|
+
export function instanceOfScriptSeriesInput(value: object): value is ScriptSeriesInput {
|
|
103
|
+
if (!('kind' in value) || value['kind'] === undefined) return false;
|
|
104
|
+
return true;
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
export function ScriptSeriesInputFromJSON(json: any): ScriptSeriesInput {
|
|
108
|
+
return ScriptSeriesInputFromJSONTyped(json, false);
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
export function ScriptSeriesInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptSeriesInput {
|
|
112
|
+
if (json == null) {
|
|
113
|
+
return json;
|
|
114
|
+
}
|
|
115
|
+
return {
|
|
116
|
+
|
|
117
|
+
'kind': json['kind'],
|
|
118
|
+
'field': json['field'] == null ? undefined : json['field'],
|
|
119
|
+
'indicator_id': json['indicator_id'] == null ? undefined : json['indicator_id'],
|
|
120
|
+
'series_key': json['series_key'] == null ? undefined : json['series_key'],
|
|
121
|
+
'params': json['params'] == null ? undefined : json['params'],
|
|
122
|
+
'resolved_script_version_id': json['resolved_script_version_id'] == null ? undefined : json['resolved_script_version_id'],
|
|
123
|
+
'node_key': json['node_key'] == null ? undefined : json['node_key'],
|
|
124
|
+
'slot_id': json['slot_id'] == null ? undefined : json['slot_id'],
|
|
125
|
+
};
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
export function ScriptSeriesInputToJSON(json: any): ScriptSeriesInput {
|
|
129
|
+
return ScriptSeriesInputToJSONTyped(json, false);
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
export function ScriptSeriesInputToJSONTyped(value?: ScriptSeriesInput | null, ignoreDiscriminator: boolean = false): any {
|
|
133
|
+
if (value == null) {
|
|
134
|
+
return value;
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
return {
|
|
138
|
+
|
|
139
|
+
'kind': value['kind'],
|
|
140
|
+
'field': value['field'],
|
|
141
|
+
'indicator_id': value['indicator_id'],
|
|
142
|
+
'series_key': value['series_key'],
|
|
143
|
+
'params': value['params'],
|
|
144
|
+
'resolved_script_version_id': value['resolved_script_version_id'],
|
|
145
|
+
'node_key': value['node_key'],
|
|
146
|
+
'slot_id': value['slot_id'],
|
|
147
|
+
};
|
|
148
|
+
}
|
|
149
|
+
|
|
@@ -0,0 +1,141 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Invinite API
|
|
5
|
+
* 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.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2026-11-13
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
/**
|
|
17
|
+
* 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)
|
|
18
|
+
* @export
|
|
19
|
+
* @interface ScriptSeriesInputInput
|
|
20
|
+
*/
|
|
21
|
+
export interface ScriptSeriesInputInput {
|
|
22
|
+
/**
|
|
23
|
+
* 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`
|
|
24
|
+
* @type {ScriptSeriesInputInputKindEnum}
|
|
25
|
+
* @memberof ScriptSeriesInputInput
|
|
26
|
+
*/
|
|
27
|
+
kind: ScriptSeriesInputInputKindEnum;
|
|
28
|
+
/**
|
|
29
|
+
* ohlc: the bar field (`hl2` = (high + low) / 2, `hlc3`, `ohlc4`, `hlcc4` = (high + low + 2 × close) / 4; no volume)
|
|
30
|
+
* @type {ScriptSeriesInputInputFieldEnum}
|
|
31
|
+
* @memberof ScriptSeriesInputInput
|
|
32
|
+
*/
|
|
33
|
+
field?: ScriptSeriesInputInputFieldEnum;
|
|
34
|
+
/**
|
|
35
|
+
* builtin_indicator: the built-in indicator (`rsi`, `sma`, `ema`, `macd`, `bb`, …; the indicator condition's ids)
|
|
36
|
+
* @type {string}
|
|
37
|
+
* @memberof ScriptSeriesInputInput
|
|
38
|
+
*/
|
|
39
|
+
indicator_id?: string;
|
|
40
|
+
/**
|
|
41
|
+
* builtin_indicator: which output series (`rsi`, `macd` / `signal` / `histogram`, `upper` / `basis` / `lower`, …)
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof ScriptSeriesInputInput
|
|
44
|
+
*/
|
|
45
|
+
series_key?: string;
|
|
46
|
+
/**
|
|
47
|
+
* builtin_indicator: the indicator's parameters (`length`, `source`, …; absent = its defaults)
|
|
48
|
+
* @type {{ [key: string]: any; }}
|
|
49
|
+
* @memberof ScriptSeriesInputInput
|
|
50
|
+
*/
|
|
51
|
+
params?: { [key: string]: any; };
|
|
52
|
+
/**
|
|
53
|
+
* script_output: the `node_key` of the producing node
|
|
54
|
+
* @type {string}
|
|
55
|
+
* @memberof ScriptSeriesInputInput
|
|
56
|
+
*/
|
|
57
|
+
node_key?: string;
|
|
58
|
+
/**
|
|
59
|
+
* script_output: the plot slot of the node's script version (its `manifest.plots[].slotId`)
|
|
60
|
+
* @type {string}
|
|
61
|
+
* @memberof ScriptSeriesInputInput
|
|
62
|
+
*/
|
|
63
|
+
slot_id?: string;
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
/**
|
|
68
|
+
* @export
|
|
69
|
+
*/
|
|
70
|
+
export const ScriptSeriesInputInputKindEnum = {
|
|
71
|
+
Ohlc: 'ohlc',
|
|
72
|
+
BuiltinIndicator: 'builtin_indicator',
|
|
73
|
+
ScriptOutput: 'script_output'
|
|
74
|
+
} as const;
|
|
75
|
+
export type ScriptSeriesInputInputKindEnum = typeof ScriptSeriesInputInputKindEnum[keyof typeof ScriptSeriesInputInputKindEnum];
|
|
76
|
+
|
|
77
|
+
/**
|
|
78
|
+
* @export
|
|
79
|
+
*/
|
|
80
|
+
export const ScriptSeriesInputInputFieldEnum = {
|
|
81
|
+
Open: 'open',
|
|
82
|
+
High: 'high',
|
|
83
|
+
Low: 'low',
|
|
84
|
+
Close: 'close',
|
|
85
|
+
Hl2: 'hl2',
|
|
86
|
+
Hlc3: 'hlc3',
|
|
87
|
+
Ohlc4: 'ohlc4',
|
|
88
|
+
Hlcc4: 'hlcc4'
|
|
89
|
+
} as const;
|
|
90
|
+
export type ScriptSeriesInputInputFieldEnum = typeof ScriptSeriesInputInputFieldEnum[keyof typeof ScriptSeriesInputInputFieldEnum];
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
/**
|
|
94
|
+
* Check if a given object implements the ScriptSeriesInputInput interface.
|
|
95
|
+
*/
|
|
96
|
+
export function instanceOfScriptSeriesInputInput(value: object): value is ScriptSeriesInputInput {
|
|
97
|
+
if (!('kind' in value) || value['kind'] === undefined) return false;
|
|
98
|
+
return true;
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
export function ScriptSeriesInputInputFromJSON(json: any): ScriptSeriesInputInput {
|
|
102
|
+
return ScriptSeriesInputInputFromJSONTyped(json, false);
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
export function ScriptSeriesInputInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptSeriesInputInput {
|
|
106
|
+
if (json == null) {
|
|
107
|
+
return json;
|
|
108
|
+
}
|
|
109
|
+
return {
|
|
110
|
+
|
|
111
|
+
'kind': json['kind'],
|
|
112
|
+
'field': json['field'] == null ? undefined : json['field'],
|
|
113
|
+
'indicator_id': json['indicator_id'] == null ? undefined : json['indicator_id'],
|
|
114
|
+
'series_key': json['series_key'] == null ? undefined : json['series_key'],
|
|
115
|
+
'params': json['params'] == null ? undefined : json['params'],
|
|
116
|
+
'node_key': json['node_key'] == null ? undefined : json['node_key'],
|
|
117
|
+
'slot_id': json['slot_id'] == null ? undefined : json['slot_id'],
|
|
118
|
+
};
|
|
119
|
+
}
|
|
120
|
+
|
|
121
|
+
export function ScriptSeriesInputInputToJSON(json: any): ScriptSeriesInputInput {
|
|
122
|
+
return ScriptSeriesInputInputToJSONTyped(json, false);
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
export function ScriptSeriesInputInputToJSONTyped(value?: ScriptSeriesInputInput | null, ignoreDiscriminator: boolean = false): any {
|
|
126
|
+
if (value == null) {
|
|
127
|
+
return value;
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
return {
|
|
131
|
+
|
|
132
|
+
'kind': value['kind'],
|
|
133
|
+
'field': value['field'],
|
|
134
|
+
'indicator_id': value['indicator_id'],
|
|
135
|
+
'series_key': value['series_key'],
|
|
136
|
+
'params': value['params'],
|
|
137
|
+
'node_key': value['node_key'],
|
|
138
|
+
'slot_id': value['slot_id'],
|
|
139
|
+
};
|
|
140
|
+
}
|
|
141
|
+
|
package/src/models/index.ts
CHANGED
|
@@ -267,6 +267,12 @@ export * from './RatioPeriod';
|
|
|
267
267
|
export * from './ReviewChain';
|
|
268
268
|
export * from './Script';
|
|
269
269
|
export * from './ScriptDiagnostic';
|
|
270
|
+
export * from './ScriptEvaluation';
|
|
271
|
+
export * from './ScriptEvaluationInput';
|
|
272
|
+
export * from './ScriptNode';
|
|
273
|
+
export * from './ScriptNodeInput';
|
|
274
|
+
export * from './ScriptSeriesInput';
|
|
275
|
+
export * from './ScriptSeriesInputInput';
|
|
270
276
|
export * from './ScriptVersion';
|
|
271
277
|
export * from './SearchCoverage';
|
|
272
278
|
export * from './SearchCoverageLeg';
|