@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
package/.openapi-generator/FILES
CHANGED
|
@@ -288,6 +288,12 @@ docs/ReferenceApi.md
|
|
|
288
288
|
docs/ReviewChain.md
|
|
289
289
|
docs/Script.md
|
|
290
290
|
docs/ScriptDiagnostic.md
|
|
291
|
+
docs/ScriptEvaluation.md
|
|
292
|
+
docs/ScriptEvaluationInput.md
|
|
293
|
+
docs/ScriptNode.md
|
|
294
|
+
docs/ScriptNodeInput.md
|
|
295
|
+
docs/ScriptSeriesInput.md
|
|
296
|
+
docs/ScriptSeriesInputInput.md
|
|
291
297
|
docs/ScriptVersion.md
|
|
292
298
|
docs/ScriptsApi.md
|
|
293
299
|
docs/SearchCoverage.md
|
|
@@ -631,6 +637,12 @@ src/models/RatioPeriod.ts
|
|
|
631
637
|
src/models/ReviewChain.ts
|
|
632
638
|
src/models/Script.ts
|
|
633
639
|
src/models/ScriptDiagnostic.ts
|
|
640
|
+
src/models/ScriptEvaluation.ts
|
|
641
|
+
src/models/ScriptEvaluationInput.ts
|
|
642
|
+
src/models/ScriptNode.ts
|
|
643
|
+
src/models/ScriptNodeInput.ts
|
|
644
|
+
src/models/ScriptSeriesInput.ts
|
|
645
|
+
src/models/ScriptSeriesInputInput.ts
|
|
634
646
|
src/models/ScriptVersion.ts
|
|
635
647
|
src/models/SearchCoverage.ts
|
|
636
648
|
src/models/SearchCoverageLeg.ts
|
|
@@ -54,12 +54,12 @@ export declare class InsiderTradesApi extends runtime.BaseAPI {
|
|
|
54
54
|
*/
|
|
55
55
|
listInsiderTradesRequestOpts(requestParameters: ListInsiderTradesRequest): Promise<runtime.RequestOpts>;
|
|
56
56
|
/**
|
|
57
|
-
*
|
|
57
|
+
* 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.
|
|
58
58
|
* List insider trades
|
|
59
59
|
*/
|
|
60
60
|
listInsiderTradesRaw(requestParameters: ListInsiderTradesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListInsiderTrades200Response>>;
|
|
61
61
|
/**
|
|
62
|
-
*
|
|
62
|
+
* 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.
|
|
63
63
|
* List insider trades
|
|
64
64
|
*/
|
|
65
65
|
listInsiderTrades(requestParameters: ListInsiderTradesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListInsiderTrades200Response>;
|
|
@@ -147,7 +147,7 @@ class InsiderTradesApi extends runtime.BaseAPI {
|
|
|
147
147
|
});
|
|
148
148
|
}
|
|
149
149
|
/**
|
|
150
|
-
*
|
|
150
|
+
* 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.
|
|
151
151
|
* List insider trades
|
|
152
152
|
*/
|
|
153
153
|
listInsiderTradesRaw(requestParameters, initOverrides) {
|
|
@@ -158,7 +158,7 @@ class InsiderTradesApi extends runtime.BaseAPI {
|
|
|
158
158
|
});
|
|
159
159
|
}
|
|
160
160
|
/**
|
|
161
|
-
*
|
|
161
|
+
* 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.
|
|
162
162
|
* List insider trades
|
|
163
163
|
*/
|
|
164
164
|
listInsiderTrades(requestParameters, initOverrides) {
|
|
@@ -54,12 +54,12 @@ export declare class InsiderTradesApi extends runtime.BaseAPI {
|
|
|
54
54
|
*/
|
|
55
55
|
listInsiderTradesRequestOpts(requestParameters: ListInsiderTradesRequest): Promise<runtime.RequestOpts>;
|
|
56
56
|
/**
|
|
57
|
-
*
|
|
57
|
+
* 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.
|
|
58
58
|
* List insider trades
|
|
59
59
|
*/
|
|
60
60
|
listInsiderTradesRaw(requestParameters: ListInsiderTradesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListInsiderTrades200Response>>;
|
|
61
61
|
/**
|
|
62
|
-
*
|
|
62
|
+
* 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.
|
|
63
63
|
* List insider trades
|
|
64
64
|
*/
|
|
65
65
|
listInsiderTrades(requestParameters: ListInsiderTradesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListInsiderTrades200Response>;
|
|
@@ -144,7 +144,7 @@ export class InsiderTradesApi extends runtime.BaseAPI {
|
|
|
144
144
|
});
|
|
145
145
|
}
|
|
146
146
|
/**
|
|
147
|
-
*
|
|
147
|
+
* 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.
|
|
148
148
|
* List insider trades
|
|
149
149
|
*/
|
|
150
150
|
listInsiderTradesRaw(requestParameters, initOverrides) {
|
|
@@ -155,7 +155,7 @@ export class InsiderTradesApi extends runtime.BaseAPI {
|
|
|
155
155
|
});
|
|
156
156
|
}
|
|
157
157
|
/**
|
|
158
|
-
*
|
|
158
|
+
* 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.
|
|
159
159
|
* List insider trades
|
|
160
160
|
*/
|
|
161
161
|
listInsiderTrades(requestParameters, initOverrides) {
|
|
@@ -11,9 +11,12 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { IndicatorFilters } from './IndicatorFilters';
|
|
13
13
|
import type { AlertConditionAmountChange } from './AlertConditionAmountChange';
|
|
14
|
+
import type { ScriptSeriesInput } from './ScriptSeriesInput';
|
|
14
15
|
import type { AlertConditionMentionDeltaRule } from './AlertConditionMentionDeltaRule';
|
|
15
16
|
import type { IndicatorTemplateRef } from './IndicatorTemplateRef';
|
|
17
|
+
import type { ScriptEvaluation } from './ScriptEvaluation';
|
|
16
18
|
import type { AlertConditionRulesInner } from './AlertConditionRulesInner';
|
|
19
|
+
import type { ScriptNode } from './ScriptNode';
|
|
17
20
|
import type { IndicatorResolved } from './IndicatorResolved';
|
|
18
21
|
import type { AlertConditionYieldRule } from './AlertConditionYieldRule';
|
|
19
22
|
import type { AlertConditionYoyRulesInner } from './AlertConditionYoyRulesInner';
|
|
@@ -43,7 +46,7 @@ export interface AlertCondition {
|
|
|
43
46
|
*/
|
|
44
47
|
cik?: string;
|
|
45
48
|
/**
|
|
46
|
-
* The company (or, for the types that take ETFs, the US ETF) by ticker. Same types as `cik`; price types, script and indicator: the instrument (a US stock / ETF ticker,
|
|
49
|
+
* The company (or, for the types that take ETFs, the US ETF) by ticker. Same types as `cik`; price types, script and indicator: the instrument (a US stock / ETF ticker, a crypto slug / ticker, or a commodity `XAUUSD` / `XAGUSD`)
|
|
47
50
|
* @type {string}
|
|
48
51
|
* @memberof AlertCondition
|
|
49
52
|
*/
|
|
@@ -223,7 +226,7 @@ export interface AlertCondition {
|
|
|
223
226
|
*/
|
|
224
227
|
notify_on_date_change?: boolean;
|
|
225
228
|
/**
|
|
226
|
-
* The instrument's market: `us_stock` (US stocks and ETFs)
|
|
229
|
+
* The instrument's market: `us_stock` (US stocks and ETFs), `crypto` (coins by CoinGecko slug or ticker) or `commodity` (`XAUUSD` / `XAGUSD`, only when named). Absent at create = a stock first, then a coin; stored resolved. price, price_move, volume_spike, price_reminder, script, indicator
|
|
227
230
|
* @type {AlertConditionAssetClassEnum}
|
|
228
231
|
* @memberof AlertCondition
|
|
229
232
|
*/
|
|
@@ -271,7 +274,7 @@ export interface AlertCondition {
|
|
|
271
274
|
*/
|
|
272
275
|
mode?: AlertConditionModeEnum;
|
|
273
276
|
/**
|
|
274
|
-
* The bar evaluated at its close. volume_spike (1h, 1d, 1w, 1mo); script and indicator (1m, 5m, 15m, 30m, 1h, 4h, 1d; the plan's shortest: FREE / LITE 1h, STANDARD 5m, PRO 1m)
|
|
277
|
+
* The bar evaluated at its close. volume_spike (1m, 5m, 15m, 30m, 1h, 1d, 1w, 1mo; every closed bar); script and indicator (1m, 5m, 15m, 30m, 1h, 4h, 1d, 1w, 1mo; the plan's shortest: FREE / LITE 1h, STANDARD 5m, PRO 1m)
|
|
275
278
|
* @type {AlertConditionIntervalEnum}
|
|
276
279
|
* @memberof AlertCondition
|
|
277
280
|
*/
|
|
@@ -307,7 +310,7 @@ export interface AlertCondition {
|
|
|
307
310
|
*/
|
|
308
311
|
price_direction?: AlertConditionPriceDirectionEnum;
|
|
309
312
|
/**
|
|
310
|
-
* price_reminder: when the reminder fires โ once at `at`, on the hour, daily or weekly at `time_of_day_minutes`. script: when the script's alerts deliver โ `once_per_bar_close` (default) at most once per alert id and closed bar, `once_per_bar` the same, `every_time` every evaluation, `once` the first evaluation only. indicator: the same (`once` = this alert's first fire only). price_reminder, script, indicator
|
|
313
|
+
* price_reminder: when the reminder fires โ once at `at`, on the hour, daily or weekly at `time_of_day_minutes`. script: when the script's alerts deliver โ `once_per_bar_close` (default) at most once per alert id and closed bar, `once_per_bar` the same, `every_time` every evaluation, `once` the first evaluation only. indicator: the same (`once` = this alert's first fire only). With `evaluation` pre_close: one delivery per alert id and session (`every_time`: every signal of the pass; `once`: the first only). price_reminder, script, indicator
|
|
311
314
|
* @type {AlertConditionFrequencyEnum}
|
|
312
315
|
* @memberof AlertCondition
|
|
313
316
|
*/
|
|
@@ -344,12 +347,32 @@ export interface AlertCondition {
|
|
|
344
347
|
inputs?: {
|
|
345
348
|
[key: string]: any;
|
|
346
349
|
};
|
|
350
|
+
/**
|
|
351
|
+
* A script chain: what feeds each of the script's `input.externalSeries` inputs, by its input key (every such input must be bound; โค 4 `builtin_indicator`, โค 16 in the plan). script
|
|
352
|
+
* @type {{ [key: string]: ScriptSeriesInput; }}
|
|
353
|
+
* @memberof AlertCondition
|
|
354
|
+
*/
|
|
355
|
+
series_inputs?: {
|
|
356
|
+
[key: string]: ScriptSeriesInput;
|
|
357
|
+
};
|
|
358
|
+
/**
|
|
359
|
+
* The producer scripts `script_output` series inputs read, producers before the nodes that read them (โค 8 dependencies, โค 16,384 bytes with series_inputs). script
|
|
360
|
+
* @type {Array<ScriptNode>}
|
|
361
|
+
* @memberof AlertCondition
|
|
362
|
+
*/
|
|
363
|
+
nodes?: Array<ScriptNode>;
|
|
347
364
|
/**
|
|
348
365
|
* Only these of the script's alerts (its version's `alert_ids`); empty = all. script
|
|
349
366
|
* @type {Array<string>}
|
|
350
367
|
* @memberof AlertCondition
|
|
351
368
|
*/
|
|
352
369
|
alert_ids?: Array<string>;
|
|
370
|
+
/**
|
|
371
|
+
*
|
|
372
|
+
* @type {ScriptEvaluation}
|
|
373
|
+
* @memberof AlertCondition
|
|
374
|
+
*/
|
|
375
|
+
evaluation?: ScriptEvaluation;
|
|
353
376
|
/**
|
|
354
377
|
*
|
|
355
378
|
* @type {IndicatorTemplateRef}
|
|
@@ -495,6 +518,7 @@ export type AlertConditionEventEnum = typeof AlertConditionEventEnum[keyof typeo
|
|
|
495
518
|
export declare const AlertConditionAssetClassEnum: {
|
|
496
519
|
readonly UsStock: "us_stock";
|
|
497
520
|
readonly Crypto: "crypto";
|
|
521
|
+
readonly Commodity: "commodity";
|
|
498
522
|
};
|
|
499
523
|
export type AlertConditionAssetClassEnum = typeof AlertConditionAssetClassEnum[keyof typeof AlertConditionAssetClassEnum] | (string & {});
|
|
500
524
|
/**
|
|
@@ -11,11 +11,15 @@
|
|
|
11
11
|
* https://openapi-generator.tech
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
|
+
import { mapValues } from '../runtime';
|
|
14
15
|
import { IndicatorFiltersFromJSON, IndicatorFiltersToJSON, } from './IndicatorFilters';
|
|
15
16
|
import { AlertConditionAmountChangeFromJSON, AlertConditionAmountChangeToJSON, } from './AlertConditionAmountChange';
|
|
17
|
+
import { ScriptSeriesInputFromJSON, ScriptSeriesInputToJSON, } from './ScriptSeriesInput';
|
|
16
18
|
import { AlertConditionMentionDeltaRuleFromJSON, AlertConditionMentionDeltaRuleToJSON, } from './AlertConditionMentionDeltaRule';
|
|
17
19
|
import { IndicatorTemplateRefFromJSON, IndicatorTemplateRefToJSON, } from './IndicatorTemplateRef';
|
|
20
|
+
import { ScriptEvaluationFromJSON, ScriptEvaluationToJSON, } from './ScriptEvaluation';
|
|
18
21
|
import { AlertConditionRulesInnerFromJSON, AlertConditionRulesInnerToJSON, } from './AlertConditionRulesInner';
|
|
22
|
+
import { ScriptNodeFromJSON, ScriptNodeToJSON, } from './ScriptNode';
|
|
19
23
|
import { IndicatorResolvedFromJSON, IndicatorResolvedToJSON, } from './IndicatorResolved';
|
|
20
24
|
import { AlertConditionYieldRuleFromJSON, AlertConditionYieldRuleToJSON, } from './AlertConditionYieldRule';
|
|
21
25
|
import { AlertConditionYoyRulesInnerFromJSON, AlertConditionYoyRulesInnerToJSON, } from './AlertConditionYoyRulesInner';
|
|
@@ -129,7 +133,8 @@ export const AlertConditionEventEnum = {
|
|
|
129
133
|
*/
|
|
130
134
|
export const AlertConditionAssetClassEnum = {
|
|
131
135
|
UsStock: 'us_stock',
|
|
132
|
-
Crypto: 'crypto'
|
|
136
|
+
Crypto: 'crypto',
|
|
137
|
+
Commodity: 'commodity'
|
|
133
138
|
};
|
|
134
139
|
/**
|
|
135
140
|
* @export
|
|
@@ -276,7 +281,10 @@ export function AlertConditionFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
276
281
|
'days': json['days'] == null ? undefined : json['days'],
|
|
277
282
|
'script_version_id': json['script_version_id'] == null ? undefined : json['script_version_id'],
|
|
278
283
|
'inputs': json['inputs'] == null ? undefined : json['inputs'],
|
|
284
|
+
'series_inputs': json['series_inputs'] == null ? undefined : (mapValues(json['series_inputs'], ScriptSeriesInputFromJSON)),
|
|
285
|
+
'nodes': json['nodes'] == null ? undefined : (json['nodes'].map(ScriptNodeFromJSON)),
|
|
279
286
|
'alert_ids': json['alert_ids'] == null ? undefined : json['alert_ids'],
|
|
287
|
+
'evaluation': json['evaluation'] == null ? undefined : ScriptEvaluationFromJSON(json['evaluation']),
|
|
280
288
|
'template': json['template'] == null ? undefined : IndicatorTemplateRefFromJSON(json['template']),
|
|
281
289
|
'condition': json['condition'] == null ? undefined : IndicatorConditionFromJSON(json['condition']),
|
|
282
290
|
'filters': json['filters'] == null ? undefined : IndicatorFiltersFromJSON(json['filters']),
|
|
@@ -344,7 +352,10 @@ export function AlertConditionToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
344
352
|
'days': value['days'],
|
|
345
353
|
'script_version_id': value['script_version_id'],
|
|
346
354
|
'inputs': value['inputs'],
|
|
355
|
+
'series_inputs': value['series_inputs'] == null ? undefined : (mapValues(value['series_inputs'], ScriptSeriesInputToJSON)),
|
|
356
|
+
'nodes': value['nodes'] == null ? undefined : (value['nodes'].map(ScriptNodeToJSON)),
|
|
347
357
|
'alert_ids': value['alert_ids'],
|
|
358
|
+
'evaluation': ScriptEvaluationToJSON(value['evaluation']),
|
|
348
359
|
'template': IndicatorTemplateRefToJSON(value['template']),
|
|
349
360
|
'condition': IndicatorConditionToJSON(value['condition']),
|
|
350
361
|
'filters': IndicatorFiltersToJSON(value['filters']),
|
|
@@ -11,12 +11,15 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { AlertConditionInputAmountChange } from './AlertConditionInputAmountChange';
|
|
13
13
|
import type { AlertConditionInputMentionDeltaRule } from './AlertConditionInputMentionDeltaRule';
|
|
14
|
+
import type { ScriptSeriesInputInput } from './ScriptSeriesInputInput';
|
|
14
15
|
import type { IndicatorTemplateRef } from './IndicatorTemplateRef';
|
|
15
16
|
import type { IndicatorConditionInput } from './IndicatorConditionInput';
|
|
16
17
|
import type { AlertConditionInputYoyRulesInner } from './AlertConditionInputYoyRulesInner';
|
|
18
|
+
import type { ScriptEvaluationInput } from './ScriptEvaluationInput';
|
|
17
19
|
import type { AlertConditionInputRulesInner } from './AlertConditionInputRulesInner';
|
|
18
20
|
import type { AlertConditionInputYieldRule } from './AlertConditionInputYieldRule';
|
|
19
21
|
import type { IndicatorFiltersInput } from './IndicatorFiltersInput';
|
|
22
|
+
import type { ScriptNodeInput } from './ScriptNodeInput';
|
|
20
23
|
/**
|
|
21
24
|
* What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Price types (`price`, `price_move`, `volume_spike`, `price_reminder`), `script` and `indicator` watch ONE instrument: `symbol` + `asset_class`. An `indicator` alert takes a built-in `template` (`GET /v1/alert-templates`) or a structured `condition` (+ optional `filters`) on `symbol` / `interval`; alerts crossing a constant on the same indicator, instrument and interval share one evaluation whatever the threshold. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls. (request form) US ETFs: `dividend`, `event_countdown` (`ex_dividend` / `dividend_payment`), `filing` and `filing_keyword` take an ETF ticker (SPY or a trust series such as TQQQ; a series ETF is stored by symbol and fires only on events that name it, never on another series' filing of its trust); `earnings_call`, `earnings_call_keyword`, `earnings_results`, `fundamental_metric`, `news`, `news_keyword` and an `earnings_call` countdown refuse an ETF of either identity (its ticker or a fund registrant's CIK) by name (400 `invalid_parameter`).
|
|
22
25
|
* @export
|
|
@@ -42,7 +45,7 @@ export interface AlertConditionInput {
|
|
|
42
45
|
*/
|
|
43
46
|
cik?: string;
|
|
44
47
|
/**
|
|
45
|
-
* The company (or, for the types that take ETFs, the US ETF) by ticker. Same types as `cik`; price types, script and indicator: the instrument (a US stock / ETF ticker,
|
|
48
|
+
* The company (or, for the types that take ETFs, the US ETF) by ticker. Same types as `cik`; price types, script and indicator: the instrument (a US stock / ETF ticker, a crypto slug / ticker, or a commodity `XAUUSD` / `XAGUSD`)
|
|
46
49
|
* @type {string}
|
|
47
50
|
* @memberof AlertConditionInput
|
|
48
51
|
*/
|
|
@@ -222,7 +225,7 @@ export interface AlertConditionInput {
|
|
|
222
225
|
*/
|
|
223
226
|
notify_on_date_change?: boolean;
|
|
224
227
|
/**
|
|
225
|
-
* The instrument's market: `us_stock` (US stocks and ETFs)
|
|
228
|
+
* The instrument's market: `us_stock` (US stocks and ETFs), `crypto` (coins by CoinGecko slug or ticker) or `commodity` (`XAUUSD` / `XAGUSD`, only when named). Absent at create = a stock first, then a coin; stored resolved. price, price_move, volume_spike, price_reminder, script, indicator
|
|
226
229
|
* @type {AlertConditionInputAssetClassEnum}
|
|
227
230
|
* @memberof AlertConditionInput
|
|
228
231
|
*/
|
|
@@ -270,7 +273,7 @@ export interface AlertConditionInput {
|
|
|
270
273
|
*/
|
|
271
274
|
mode?: AlertConditionInputModeEnum;
|
|
272
275
|
/**
|
|
273
|
-
* The bar evaluated at its close. volume_spike (1h, 1d, 1w, 1mo); script and indicator (1m, 5m, 15m, 30m, 1h, 4h, 1d; the plan's shortest: FREE / LITE 1h, STANDARD 5m, PRO 1m)
|
|
276
|
+
* The bar evaluated at its close. volume_spike (1m, 5m, 15m, 30m, 1h, 1d, 1w, 1mo; every closed bar); script and indicator (1m, 5m, 15m, 30m, 1h, 4h, 1d, 1w, 1mo; the plan's shortest: FREE / LITE 1h, STANDARD 5m, PRO 1m)
|
|
274
277
|
* @type {AlertConditionInputIntervalEnum}
|
|
275
278
|
* @memberof AlertConditionInput
|
|
276
279
|
*/
|
|
@@ -306,7 +309,7 @@ export interface AlertConditionInput {
|
|
|
306
309
|
*/
|
|
307
310
|
price_direction?: AlertConditionInputPriceDirectionEnum;
|
|
308
311
|
/**
|
|
309
|
-
* price_reminder: when the reminder fires โ once at `at`, on the hour, daily or weekly at `time_of_day_minutes`. script: when the script's alerts deliver โ `once_per_bar_close` (default) at most once per alert id and closed bar, `once_per_bar` the same, `every_time` every evaluation, `once` the first evaluation only. indicator: the same (`once` = this alert's first fire only). price_reminder, script, indicator
|
|
312
|
+
* price_reminder: when the reminder fires โ once at `at`, on the hour, daily or weekly at `time_of_day_minutes`. script: when the script's alerts deliver โ `once_per_bar_close` (default) at most once per alert id and closed bar, `once_per_bar` the same, `every_time` every evaluation, `once` the first evaluation only. indicator: the same (`once` = this alert's first fire only). With `evaluation` pre_close: one delivery per alert id and session (`every_time`: every signal of the pass; `once`: the first only). price_reminder, script, indicator
|
|
310
313
|
* @type {AlertConditionInputFrequencyEnum}
|
|
311
314
|
* @memberof AlertConditionInput
|
|
312
315
|
*/
|
|
@@ -343,12 +346,32 @@ export interface AlertConditionInput {
|
|
|
343
346
|
inputs?: {
|
|
344
347
|
[key: string]: any;
|
|
345
348
|
};
|
|
349
|
+
/**
|
|
350
|
+
* A script chain: what feeds each of the script's `input.externalSeries` inputs, by its input key (every such input must be bound; โค 4 `builtin_indicator`, โค 16 in the plan). script
|
|
351
|
+
* @type {{ [key: string]: ScriptSeriesInputInput; }}
|
|
352
|
+
* @memberof AlertConditionInput
|
|
353
|
+
*/
|
|
354
|
+
series_inputs?: {
|
|
355
|
+
[key: string]: ScriptSeriesInputInput;
|
|
356
|
+
};
|
|
357
|
+
/**
|
|
358
|
+
* The producer scripts `script_output` series inputs read, producers before the nodes that read them (โค 8 dependencies, โค 16,384 bytes with series_inputs). script
|
|
359
|
+
* @type {Array<ScriptNodeInput>}
|
|
360
|
+
* @memberof AlertConditionInput
|
|
361
|
+
*/
|
|
362
|
+
nodes?: Array<ScriptNodeInput>;
|
|
346
363
|
/**
|
|
347
364
|
* Only these of the script's alerts (its version's `alert_ids`); empty = all. script
|
|
348
365
|
* @type {Array<string>}
|
|
349
366
|
* @memberof AlertConditionInput
|
|
350
367
|
*/
|
|
351
368
|
alert_ids?: Array<string>;
|
|
369
|
+
/**
|
|
370
|
+
*
|
|
371
|
+
* @type {ScriptEvaluationInput}
|
|
372
|
+
* @memberof AlertConditionInput
|
|
373
|
+
*/
|
|
374
|
+
evaluation?: ScriptEvaluationInput;
|
|
352
375
|
/**
|
|
353
376
|
*
|
|
354
377
|
* @type {IndicatorTemplateRef}
|
|
@@ -488,6 +511,7 @@ export type AlertConditionInputEventEnum = typeof AlertConditionInputEventEnum[k
|
|
|
488
511
|
export declare const AlertConditionInputAssetClassEnum: {
|
|
489
512
|
readonly UsStock: "us_stock";
|
|
490
513
|
readonly Crypto: "crypto";
|
|
514
|
+
readonly Commodity: "commodity";
|
|
491
515
|
};
|
|
492
516
|
export type AlertConditionInputAssetClassEnum = typeof AlertConditionInputAssetClassEnum[keyof typeof AlertConditionInputAssetClassEnum];
|
|
493
517
|
/**
|
|
@@ -11,14 +11,18 @@
|
|
|
11
11
|
* https://openapi-generator.tech
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
|
+
import { mapValues } from '../runtime';
|
|
14
15
|
import { AlertConditionInputAmountChangeFromJSON, AlertConditionInputAmountChangeToJSON, } from './AlertConditionInputAmountChange';
|
|
15
16
|
import { AlertConditionInputMentionDeltaRuleFromJSON, AlertConditionInputMentionDeltaRuleToJSON, } from './AlertConditionInputMentionDeltaRule';
|
|
17
|
+
import { ScriptSeriesInputInputFromJSON, ScriptSeriesInputInputToJSON, } from './ScriptSeriesInputInput';
|
|
16
18
|
import { IndicatorTemplateRefFromJSON, IndicatorTemplateRefToJSON, } from './IndicatorTemplateRef';
|
|
17
19
|
import { IndicatorConditionInputFromJSON, IndicatorConditionInputToJSON, } from './IndicatorConditionInput';
|
|
18
20
|
import { AlertConditionInputYoyRulesInnerFromJSON, AlertConditionInputYoyRulesInnerToJSON, } from './AlertConditionInputYoyRulesInner';
|
|
21
|
+
import { ScriptEvaluationInputFromJSON, ScriptEvaluationInputToJSON, } from './ScriptEvaluationInput';
|
|
19
22
|
import { AlertConditionInputRulesInnerFromJSON, AlertConditionInputRulesInnerToJSON, } from './AlertConditionInputRulesInner';
|
|
20
23
|
import { AlertConditionInputYieldRuleFromJSON, AlertConditionInputYieldRuleToJSON, } from './AlertConditionInputYieldRule';
|
|
21
24
|
import { IndicatorFiltersInputFromJSON, IndicatorFiltersInputToJSON, } from './IndicatorFiltersInput';
|
|
25
|
+
import { ScriptNodeInputFromJSON, ScriptNodeInputToJSON, } from './ScriptNodeInput';
|
|
22
26
|
/**
|
|
23
27
|
* @export
|
|
24
28
|
*/
|
|
@@ -128,7 +132,8 @@ export const AlertConditionInputEventEnum = {
|
|
|
128
132
|
*/
|
|
129
133
|
export const AlertConditionInputAssetClassEnum = {
|
|
130
134
|
UsStock: 'us_stock',
|
|
131
|
-
Crypto: 'crypto'
|
|
135
|
+
Crypto: 'crypto',
|
|
136
|
+
Commodity: 'commodity'
|
|
132
137
|
};
|
|
133
138
|
/**
|
|
134
139
|
* @export
|
|
@@ -275,7 +280,10 @@ export function AlertConditionInputFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
275
280
|
'days': json['days'] == null ? undefined : json['days'],
|
|
276
281
|
'script_version_id': json['script_version_id'] == null ? undefined : json['script_version_id'],
|
|
277
282
|
'inputs': json['inputs'] == null ? undefined : json['inputs'],
|
|
283
|
+
'series_inputs': json['series_inputs'] == null ? undefined : (mapValues(json['series_inputs'], ScriptSeriesInputInputFromJSON)),
|
|
284
|
+
'nodes': json['nodes'] == null ? undefined : (json['nodes'].map(ScriptNodeInputFromJSON)),
|
|
278
285
|
'alert_ids': json['alert_ids'] == null ? undefined : json['alert_ids'],
|
|
286
|
+
'evaluation': json['evaluation'] == null ? undefined : ScriptEvaluationInputFromJSON(json['evaluation']),
|
|
279
287
|
'template': json['template'] == null ? undefined : IndicatorTemplateRefFromJSON(json['template']),
|
|
280
288
|
'condition': json['condition'] == null ? undefined : IndicatorConditionInputFromJSON(json['condition']),
|
|
281
289
|
'filters': json['filters'] == null ? undefined : IndicatorFiltersInputFromJSON(json['filters']),
|
|
@@ -342,7 +350,10 @@ export function AlertConditionInputToJSONTyped(value, ignoreDiscriminator = fals
|
|
|
342
350
|
'days': value['days'],
|
|
343
351
|
'script_version_id': value['script_version_id'],
|
|
344
352
|
'inputs': value['inputs'],
|
|
353
|
+
'series_inputs': value['series_inputs'] == null ? undefined : (mapValues(value['series_inputs'], ScriptSeriesInputInputToJSON)),
|
|
354
|
+
'nodes': value['nodes'] == null ? undefined : (value['nodes'].map(ScriptNodeInputToJSON)),
|
|
345
355
|
'alert_ids': value['alert_ids'],
|
|
356
|
+
'evaluation': ScriptEvaluationInputToJSON(value['evaluation']),
|
|
346
357
|
'template': IndicatorTemplateRefToJSON(value['template']),
|
|
347
358
|
'condition': IndicatorConditionInputToJSON(value['condition']),
|
|
348
359
|
'filters': IndicatorFiltersInputToJSON(value['filters']),
|
|
@@ -23,13 +23,13 @@ export interface AlertTrigger {
|
|
|
23
23
|
*/
|
|
24
24
|
mode?: AlertTriggerModeEnum;
|
|
25
25
|
/**
|
|
26
|
-
* Minimum seconds between fires
|
|
26
|
+
* Minimum seconds between fires (at most 366 days)
|
|
27
27
|
* @type {number}
|
|
28
28
|
* @memberof AlertTrigger
|
|
29
29
|
*/
|
|
30
30
|
cooldown_seconds?: number;
|
|
31
31
|
/**
|
|
32
|
-
* Minimum bars between fires (script / indicator types), counted like chartlang: the bar of a fire must start at least cooldown_bars ร the interval after the bar of the last fire, so a night or a weekend counts as time
|
|
32
|
+
* Minimum bars between fires (script / indicator types), counted like chartlang: the bar of a fire must start at least cooldown_bars ร the interval after the bar of the last fire, so a night or a weekend counts as time (half a bar of slack: a calendar `1mo` / `1w` / `1d` bar shorter than the nominal interval, a February or a DST day, still counts as a whole bar)
|
|
33
33
|
* @type {number}
|
|
34
34
|
* @memberof AlertTrigger
|
|
35
35
|
*/
|
|
@@ -23,13 +23,13 @@ export interface AlertTriggerInput {
|
|
|
23
23
|
*/
|
|
24
24
|
mode?: AlertTriggerInputModeEnum;
|
|
25
25
|
/**
|
|
26
|
-
* Minimum seconds between fires
|
|
26
|
+
* Minimum seconds between fires (at most 366 days)
|
|
27
27
|
* @type {number}
|
|
28
28
|
* @memberof AlertTriggerInput
|
|
29
29
|
*/
|
|
30
30
|
cooldown_seconds?: number;
|
|
31
31
|
/**
|
|
32
|
-
* Minimum bars between fires (script / indicator types), counted like chartlang: the bar of a fire must start at least cooldown_bars ร the interval after the bar of the last fire, so a night or a weekend counts as time
|
|
32
|
+
* Minimum bars between fires (script / indicator types), counted like chartlang: the bar of a fire must start at least cooldown_bars ร the interval after the bar of the last fire, so a night or a weekend counts as time (half a bar of slack: a calendar `1mo` / `1w` / `1d` bar shorter than the nominal interval, a February or a DST day, still counts as a whole bar)
|
|
33
33
|
* @type {number}
|
|
34
34
|
* @memberof AlertTriggerInput
|
|
35
35
|
*/
|
|
@@ -60,7 +60,10 @@ export declare const IndicatorFilterConditionIntervalEnum: {
|
|
|
60
60
|
readonly _15m: "15m";
|
|
61
61
|
readonly _30m: "30m";
|
|
62
62
|
readonly _1h: "1h";
|
|
63
|
+
readonly _4h: "4h";
|
|
63
64
|
readonly _1d: "1d";
|
|
65
|
+
readonly _1w: "1w";
|
|
66
|
+
readonly _1mo: "1mo";
|
|
64
67
|
};
|
|
65
68
|
export type IndicatorFilterConditionIntervalEnum = typeof IndicatorFilterConditionIntervalEnum[keyof typeof IndicatorFilterConditionIntervalEnum] | (string & {});
|
|
66
69
|
/**
|
|
@@ -30,7 +30,10 @@ export const IndicatorFilterConditionIntervalEnum = {
|
|
|
30
30
|
_15m: '15m',
|
|
31
31
|
_30m: '30m',
|
|
32
32
|
_1h: '1h',
|
|
33
|
-
|
|
33
|
+
_4h: '4h',
|
|
34
|
+
_1d: '1d',
|
|
35
|
+
_1w: '1w',
|
|
36
|
+
_1mo: '1mo'
|
|
34
37
|
};
|
|
35
38
|
/**
|
|
36
39
|
* Check if a given object implements the IndicatorFilterCondition interface.
|
|
@@ -60,7 +60,10 @@ export declare const IndicatorFilterConditionInputIntervalEnum: {
|
|
|
60
60
|
readonly _15m: "15m";
|
|
61
61
|
readonly _30m: "30m";
|
|
62
62
|
readonly _1h: "1h";
|
|
63
|
+
readonly _4h: "4h";
|
|
63
64
|
readonly _1d: "1d";
|
|
65
|
+
readonly _1w: "1w";
|
|
66
|
+
readonly _1mo: "1mo";
|
|
64
67
|
};
|
|
65
68
|
export type IndicatorFilterConditionInputIntervalEnum = typeof IndicatorFilterConditionInputIntervalEnum[keyof typeof IndicatorFilterConditionInputIntervalEnum];
|
|
66
69
|
/**
|
|
@@ -30,7 +30,10 @@ export const IndicatorFilterConditionInputIntervalEnum = {
|
|
|
30
30
|
_15m: '15m',
|
|
31
31
|
_30m: '30m',
|
|
32
32
|
_1h: '1h',
|
|
33
|
-
|
|
33
|
+
_4h: '4h',
|
|
34
|
+
_1d: '1d',
|
|
35
|
+
_1w: '1w',
|
|
36
|
+
_1mo: '1mo'
|
|
34
37
|
};
|
|
35
38
|
/**
|
|
36
39
|
* Check if a given object implements the IndicatorFilterConditionInput interface.
|
|
@@ -0,0 +1,65 @@
|
|
|
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
|
+
* 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`.
|
|
14
|
+
* @export
|
|
15
|
+
* @interface ScriptEvaluation
|
|
16
|
+
*/
|
|
17
|
+
export interface ScriptEvaluation {
|
|
18
|
+
/**
|
|
19
|
+
* `bar_close` at each bar close, `pre_close` before the session close
|
|
20
|
+
* @type {ScriptEvaluationKindEnum}
|
|
21
|
+
* @memberof ScriptEvaluation
|
|
22
|
+
*/
|
|
23
|
+
kind: ScriptEvaluationKindEnum;
|
|
24
|
+
/**
|
|
25
|
+
* pre_close: minutes before the session close (1โ720; any interval)
|
|
26
|
+
* @type {number}
|
|
27
|
+
* @memberof ScriptEvaluation
|
|
28
|
+
*/
|
|
29
|
+
offset_minutes?: number;
|
|
30
|
+
/**
|
|
31
|
+
* 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
|
|
32
|
+
* @type {ScriptEvaluationExchangeEnum}
|
|
33
|
+
* @memberof ScriptEvaluation
|
|
34
|
+
*/
|
|
35
|
+
exchange?: ScriptEvaluationExchangeEnum;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* @export
|
|
39
|
+
*/
|
|
40
|
+
export declare const ScriptEvaluationKindEnum: {
|
|
41
|
+
readonly BarClose: "bar_close";
|
|
42
|
+
readonly PreClose: "pre_close";
|
|
43
|
+
};
|
|
44
|
+
export type ScriptEvaluationKindEnum = typeof ScriptEvaluationKindEnum[keyof typeof ScriptEvaluationKindEnum] | (string & {});
|
|
45
|
+
/**
|
|
46
|
+
* @export
|
|
47
|
+
*/
|
|
48
|
+
export declare const ScriptEvaluationExchangeEnum: {
|
|
49
|
+
readonly Nyse: "NYSE";
|
|
50
|
+
readonly Nasdaq: "NASDAQ";
|
|
51
|
+
readonly Amex: "AMEX";
|
|
52
|
+
readonly Nysearca: "NYSEARCA";
|
|
53
|
+
readonly Nysemkt: "NYSEMKT";
|
|
54
|
+
readonly Bats: "BATS";
|
|
55
|
+
readonly Cboe: "CBOE";
|
|
56
|
+
};
|
|
57
|
+
export type ScriptEvaluationExchangeEnum = typeof ScriptEvaluationExchangeEnum[keyof typeof ScriptEvaluationExchangeEnum] | (string & {});
|
|
58
|
+
/**
|
|
59
|
+
* Check if a given object implements the ScriptEvaluation interface.
|
|
60
|
+
*/
|
|
61
|
+
export declare function instanceOfScriptEvaluation(value: object): value is ScriptEvaluation;
|
|
62
|
+
export declare function ScriptEvaluationFromJSON(json: any): ScriptEvaluation;
|
|
63
|
+
export declare function ScriptEvaluationFromJSONTyped(json: any, ignoreDiscriminator: boolean): ScriptEvaluation;
|
|
64
|
+
export declare function ScriptEvaluationToJSON(json: any): ScriptEvaluation;
|
|
65
|
+
export declare function ScriptEvaluationToJSONTyped(value?: ScriptEvaluation | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,66 @@
|
|
|
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
|
+
* @export
|
|
16
|
+
*/
|
|
17
|
+
export const ScriptEvaluationKindEnum = {
|
|
18
|
+
BarClose: 'bar_close',
|
|
19
|
+
PreClose: 'pre_close'
|
|
20
|
+
};
|
|
21
|
+
/**
|
|
22
|
+
* @export
|
|
23
|
+
*/
|
|
24
|
+
export const ScriptEvaluationExchangeEnum = {
|
|
25
|
+
Nyse: 'NYSE',
|
|
26
|
+
Nasdaq: 'NASDAQ',
|
|
27
|
+
Amex: 'AMEX',
|
|
28
|
+
Nysearca: 'NYSEARCA',
|
|
29
|
+
Nysemkt: 'NYSEMKT',
|
|
30
|
+
Bats: 'BATS',
|
|
31
|
+
Cboe: 'CBOE'
|
|
32
|
+
};
|
|
33
|
+
/**
|
|
34
|
+
* Check if a given object implements the ScriptEvaluation interface.
|
|
35
|
+
*/
|
|
36
|
+
export function instanceOfScriptEvaluation(value) {
|
|
37
|
+
if (!('kind' in value) || value['kind'] === undefined)
|
|
38
|
+
return false;
|
|
39
|
+
return true;
|
|
40
|
+
}
|
|
41
|
+
export function ScriptEvaluationFromJSON(json) {
|
|
42
|
+
return ScriptEvaluationFromJSONTyped(json, false);
|
|
43
|
+
}
|
|
44
|
+
export function ScriptEvaluationFromJSONTyped(json, ignoreDiscriminator) {
|
|
45
|
+
if (json == null) {
|
|
46
|
+
return json;
|
|
47
|
+
}
|
|
48
|
+
return {
|
|
49
|
+
'kind': json['kind'],
|
|
50
|
+
'offset_minutes': json['offset_minutes'] == null ? undefined : json['offset_minutes'],
|
|
51
|
+
'exchange': json['exchange'] == null ? undefined : json['exchange'],
|
|
52
|
+
};
|
|
53
|
+
}
|
|
54
|
+
export function ScriptEvaluationToJSON(json) {
|
|
55
|
+
return ScriptEvaluationToJSONTyped(json, false);
|
|
56
|
+
}
|
|
57
|
+
export function ScriptEvaluationToJSONTyped(value, ignoreDiscriminator = false) {
|
|
58
|
+
if (value == null) {
|
|
59
|
+
return value;
|
|
60
|
+
}
|
|
61
|
+
return {
|
|
62
|
+
'kind': value['kind'],
|
|
63
|
+
'offset_minutes': value['offset_minutes'],
|
|
64
|
+
'exchange': value['exchange'],
|
|
65
|
+
};
|
|
66
|
+
}
|