@invinite-org/data-api-client 6.1.0 → 6.3.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 +52 -0
- package/dist/apis/FilingsApi.d.ts +2 -2
- package/dist/apis/FilingsApi.js +2 -2
- package/dist/apis/ReferenceApi.d.ts +4 -4
- package/dist/apis/ReferenceApi.js +4 -4
- package/dist/apis/ScriptsApi.d.ts +148 -0
- package/dist/apis/ScriptsApi.js +396 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/FilingsApi.d.ts +2 -2
- package/dist/esm/apis/FilingsApi.js +2 -2
- package/dist/esm/apis/ReferenceApi.d.ts +4 -4
- package/dist/esm/apis/ReferenceApi.js +4 -4
- package/dist/esm/apis/ScriptsApi.d.ts +148 -0
- package/dist/esm/apis/ScriptsApi.js +392 -0
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/Alert.d.ts +6 -0
- package/dist/esm/models/Alert.js +4 -0
- package/dist/esm/models/AlertCondition.d.ts +62 -6
- package/dist/esm/models/AlertCondition.js +27 -1
- package/dist/esm/models/AlertConditionInput.d.ts +55 -6
- package/dist/esm/models/AlertConditionInput.js +24 -1
- package/dist/esm/models/AlertTemplate.d.ts +83 -0
- package/dist/esm/models/AlertTemplate.js +79 -0
- package/dist/esm/models/AlertTemplateInput.d.ts +78 -0
- package/dist/esm/models/AlertTemplateInput.js +70 -0
- package/dist/esm/models/AlertTrigger.d.ts +1 -1
- package/dist/esm/models/AlertTriggerInput.d.ts +1 -1
- package/dist/esm/models/Company.d.ts +8 -8
- package/dist/esm/models/CompanyListItem.d.ts +1 -1
- package/dist/esm/models/CompanyRef.d.ts +1 -1
- package/dist/esm/models/CreateScriptRequest.d.ts +44 -0
- package/dist/esm/models/CreateScriptRequest.js +49 -0
- package/dist/esm/models/CreateScriptVersionRequest.d.ts +32 -0
- package/dist/esm/models/CreateScriptVersionRequest.js +43 -0
- package/dist/esm/models/IndicatorCondition.d.ts +56 -0
- package/dist/esm/models/IndicatorCondition.js +62 -0
- package/dist/esm/models/IndicatorConditionInput.d.ts +56 -0
- package/dist/esm/models/IndicatorConditionInput.js +62 -0
- package/dist/esm/models/IndicatorFilterChild.d.ts +68 -0
- package/dist/esm/models/IndicatorFilterChild.js +65 -0
- package/dist/esm/models/IndicatorFilterChildInput.d.ts +68 -0
- package/dist/esm/models/IndicatorFilterChildInput.js +65 -0
- package/dist/esm/models/IndicatorFilterCondition.d.ts +73 -0
- package/dist/esm/models/IndicatorFilterCondition.js +74 -0
- package/dist/esm/models/IndicatorFilterConditionInput.d.ts +73 -0
- package/dist/esm/models/IndicatorFilterConditionInput.js +74 -0
- package/dist/esm/models/IndicatorFilterLeaf.d.ts +46 -0
- package/dist/esm/models/IndicatorFilterLeaf.js +54 -0
- package/dist/esm/models/IndicatorFilterLeafInput.d.ts +46 -0
- package/dist/esm/models/IndicatorFilterLeafInput.js +56 -0
- package/dist/esm/models/IndicatorFilters.d.ts +47 -0
- package/dist/esm/models/IndicatorFilters.js +55 -0
- package/dist/esm/models/IndicatorFiltersInput.d.ts +47 -0
- package/dist/esm/models/IndicatorFiltersInput.js +55 -0
- package/dist/esm/models/IndicatorOperand.d.ts +91 -0
- package/dist/esm/models/IndicatorOperand.js +74 -0
- package/dist/esm/models/IndicatorOperandInput.d.ts +91 -0
- package/dist/esm/models/IndicatorOperandInput.js +74 -0
- package/dist/esm/models/IndicatorResolved.d.ts +67 -0
- package/dist/esm/models/IndicatorResolved.js +65 -0
- package/dist/esm/models/IndicatorResolvedThreshold.d.ts +47 -0
- package/dist/esm/models/IndicatorResolvedThreshold.js +55 -0
- package/dist/esm/models/IndicatorTemplateRef.d.ts +46 -0
- package/dist/esm/models/IndicatorTemplateRef.js +47 -0
- package/dist/esm/models/ListAlertTemplates200Response.d.ts +52 -0
- package/dist/esm/models/ListAlertTemplates200Response.js +57 -0
- package/dist/esm/models/ListScriptVersions200Response.d.ts +52 -0
- package/dist/esm/models/ListScriptVersions200Response.js +57 -0
- package/dist/esm/models/ListScripts200Response.d.ts +52 -0
- package/dist/esm/models/ListScripts200Response.js +57 -0
- package/dist/esm/models/Script.d.ts +69 -0
- package/dist/esm/models/Script.js +68 -0
- package/dist/esm/models/ScriptDiagnostic.d.ts +64 -0
- package/dist/esm/models/ScriptDiagnostic.js +66 -0
- package/dist/esm/models/ScriptVersion.d.ts +103 -0
- package/dist/esm/models/ScriptVersion.js +91 -0
- package/dist/esm/models/index.d.ts +25 -0
- package/dist/esm/models/index.js +25 -0
- package/dist/models/Alert.d.ts +6 -0
- package/dist/models/Alert.js +4 -0
- package/dist/models/AlertCondition.d.ts +62 -6
- package/dist/models/AlertCondition.js +27 -1
- package/dist/models/AlertConditionInput.d.ts +55 -6
- package/dist/models/AlertConditionInput.js +24 -1
- package/dist/models/AlertTemplate.d.ts +83 -0
- package/dist/models/AlertTemplate.js +87 -0
- package/dist/models/AlertTemplateInput.d.ts +78 -0
- package/dist/models/AlertTemplateInput.js +78 -0
- package/dist/models/AlertTrigger.d.ts +1 -1
- package/dist/models/AlertTriggerInput.d.ts +1 -1
- package/dist/models/Company.d.ts +8 -8
- package/dist/models/CompanyListItem.d.ts +1 -1
- package/dist/models/CompanyRef.d.ts +1 -1
- package/dist/models/CreateScriptRequest.d.ts +44 -0
- package/dist/models/CreateScriptRequest.js +56 -0
- package/dist/models/CreateScriptVersionRequest.d.ts +32 -0
- package/dist/models/CreateScriptVersionRequest.js +50 -0
- package/dist/models/IndicatorCondition.d.ts +56 -0
- package/dist/models/IndicatorCondition.js +70 -0
- package/dist/models/IndicatorConditionInput.d.ts +56 -0
- package/dist/models/IndicatorConditionInput.js +70 -0
- package/dist/models/IndicatorFilterChild.d.ts +68 -0
- package/dist/models/IndicatorFilterChild.js +73 -0
- package/dist/models/IndicatorFilterChildInput.d.ts +68 -0
- package/dist/models/IndicatorFilterChildInput.js +73 -0
- package/dist/models/IndicatorFilterCondition.d.ts +73 -0
- package/dist/models/IndicatorFilterCondition.js +82 -0
- package/dist/models/IndicatorFilterConditionInput.d.ts +73 -0
- package/dist/models/IndicatorFilterConditionInput.js +82 -0
- package/dist/models/IndicatorFilterLeaf.d.ts +46 -0
- package/dist/models/IndicatorFilterLeaf.js +62 -0
- package/dist/models/IndicatorFilterLeafInput.d.ts +46 -0
- package/dist/models/IndicatorFilterLeafInput.js +64 -0
- package/dist/models/IndicatorFilters.d.ts +47 -0
- package/dist/models/IndicatorFilters.js +63 -0
- package/dist/models/IndicatorFiltersInput.d.ts +47 -0
- package/dist/models/IndicatorFiltersInput.js +63 -0
- package/dist/models/IndicatorOperand.d.ts +91 -0
- package/dist/models/IndicatorOperand.js +82 -0
- package/dist/models/IndicatorOperandInput.d.ts +91 -0
- package/dist/models/IndicatorOperandInput.js +82 -0
- package/dist/models/IndicatorResolved.d.ts +67 -0
- package/dist/models/IndicatorResolved.js +73 -0
- package/dist/models/IndicatorResolvedThreshold.d.ts +47 -0
- package/dist/models/IndicatorResolvedThreshold.js +63 -0
- package/dist/models/IndicatorTemplateRef.d.ts +46 -0
- package/dist/models/IndicatorTemplateRef.js +54 -0
- package/dist/models/ListAlertTemplates200Response.d.ts +52 -0
- package/dist/models/ListAlertTemplates200Response.js +64 -0
- package/dist/models/ListScriptVersions200Response.d.ts +52 -0
- package/dist/models/ListScriptVersions200Response.js +64 -0
- package/dist/models/ListScripts200Response.d.ts +52 -0
- package/dist/models/ListScripts200Response.js +64 -0
- package/dist/models/Script.d.ts +69 -0
- package/dist/models/Script.js +75 -0
- package/dist/models/ScriptDiagnostic.d.ts +64 -0
- package/dist/models/ScriptDiagnostic.js +74 -0
- package/dist/models/ScriptVersion.d.ts +103 -0
- package/dist/models/ScriptVersion.js +99 -0
- package/dist/models/index.d.ts +25 -0
- package/dist/models/index.js +25 -0
- package/docs/Alert.md +2 -0
- package/docs/AlertCondition.md +15 -1
- package/docs/AlertConditionInput.md +13 -1
- package/docs/AlertTemplate.md +49 -0
- package/docs/AlertTemplateInput.md +47 -0
- package/docs/CompaniesApi.md +2 -2
- package/docs/CreateScriptRequest.md +38 -0
- package/docs/CreateScriptVersionRequest.md +34 -0
- package/docs/EventsApi.md +2 -2
- package/docs/FilingsApi.md +5 -5
- package/docs/FinancialsApi.md +12 -12
- package/docs/GuidanceApi.md +4 -4
- package/docs/HoldingsApi.md +6 -6
- package/docs/IPOsApi.md +2 -2
- package/docs/IndicatorCondition.md +39 -0
- package/docs/IndicatorConditionInput.md +39 -0
- package/docs/IndicatorFilterChild.md +41 -0
- package/docs/IndicatorFilterChildInput.md +41 -0
- package/docs/IndicatorFilterCondition.md +41 -0
- package/docs/IndicatorFilterConditionInput.md +41 -0
- package/docs/IndicatorFilterLeaf.md +37 -0
- package/docs/IndicatorFilterLeafInput.md +37 -0
- package/docs/IndicatorFilters.md +37 -0
- package/docs/IndicatorFiltersInput.md +37 -0
- package/docs/IndicatorOperand.md +47 -0
- package/docs/IndicatorOperandInput.md +47 -0
- package/docs/IndicatorResolved.md +43 -0
- package/docs/IndicatorResolvedThreshold.md +37 -0
- package/docs/IndicatorTemplateRef.md +39 -0
- package/docs/InsiderTradesApi.md +2 -2
- package/docs/InvestorDocumentsApi.md +4 -4
- package/docs/ListAlertTemplates200Response.md +41 -0
- package/docs/ListScriptVersions200Response.md +41 -0
- package/docs/ListScripts200Response.md +41 -0
- package/docs/MetricsApi.md +10 -10
- package/docs/NewsApi.md +6 -6
- package/docs/ReferenceApi.md +8 -8
- package/docs/Script.md +46 -0
- package/docs/ScriptDiagnostic.md +42 -0
- package/docs/ScriptVersion.md +54 -0
- package/docs/ScriptsApi.md +588 -0
- package/docs/TranscriptsApi.md +2 -2
- package/package.json +1 -1
- package/src/apis/FilingsApi.ts +2 -2
- package/src/apis/ReferenceApi.ts +4 -4
- package/src/apis/ScriptsApi.ts +504 -0
- package/src/apis/index.ts +1 -0
- package/src/models/Alert.ts +9 -0
- package/src/models/AlertCondition.ts +99 -7
- package/src/models/AlertConditionInput.ts +84 -7
- package/src/models/AlertTemplate.ts +148 -0
- package/src/models/AlertTemplateInput.ts +130 -0
- package/src/models/AlertTrigger.ts +1 -1
- package/src/models/AlertTriggerInput.ts +1 -1
- package/src/models/Company.ts +8 -8
- package/src/models/CompanyListItem.ts +1 -1
- package/src/models/CompanyRef.ts +1 -1
- package/src/models/CreateScriptRequest.ts +83 -0
- package/src/models/CreateScriptVersionRequest.ts +66 -0
- package/src/models/IndicatorCondition.ts +106 -0
- package/src/models/IndicatorConditionInput.ts +106 -0
- package/src/models/IndicatorFilterChild.ts +125 -0
- package/src/models/IndicatorFilterChildInput.ts +125 -0
- package/src/models/IndicatorFilterCondition.ts +126 -0
- package/src/models/IndicatorFilterConditionInput.ts +126 -0
- package/src/models/IndicatorFilterLeaf.ts +93 -0
- package/src/models/IndicatorFilterLeafInput.ts +95 -0
- package/src/models/IndicatorFilters.ts +94 -0
- package/src/models/IndicatorFiltersInput.ts +94 -0
- package/src/models/IndicatorOperand.ts +139 -0
- package/src/models/IndicatorOperandInput.ts +139 -0
- package/src/models/IndicatorResolved.ts +120 -0
- package/src/models/IndicatorResolvedThreshold.ts +87 -0
- package/src/models/IndicatorTemplateRef.ts +82 -0
- package/src/models/ListAlertTemplates200Response.ts +108 -0
- package/src/models/ListScriptVersions200Response.ts +108 -0
- package/src/models/ListScripts200Response.ts +108 -0
- package/src/models/Script.ts +128 -0
- package/src/models/ScriptDiagnostic.ts +113 -0
- package/src/models/ScriptVersion.ts +175 -0
- package/src/models/index.ts +25 -0
|
@@ -9,13 +9,17 @@
|
|
|
9
9
|
* https://openapi-generator.tech
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
|
+
import type { IndicatorFilters } from './IndicatorFilters';
|
|
12
13
|
import type { AlertConditionAmountChange } from './AlertConditionAmountChange';
|
|
13
14
|
import type { AlertConditionMentionDeltaRule } from './AlertConditionMentionDeltaRule';
|
|
15
|
+
import type { IndicatorTemplateRef } from './IndicatorTemplateRef';
|
|
14
16
|
import type { AlertConditionRulesInner } from './AlertConditionRulesInner';
|
|
17
|
+
import type { IndicatorResolved } from './IndicatorResolved';
|
|
15
18
|
import type { AlertConditionYieldRule } from './AlertConditionYieldRule';
|
|
16
19
|
import type { AlertConditionYoyRulesInner } from './AlertConditionYoyRulesInner';
|
|
20
|
+
import type { IndicatorCondition } from './IndicatorCondition';
|
|
17
21
|
/**
|
|
18
|
-
* 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`) watch ONE instrument: `symbol` + `asset_class`. 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.
|
|
22
|
+
* 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`) and `script` watch ONE instrument: `symbol` + `asset_class`. A `script` alert runs a script version (`/v1/scripts`) at each close of `interval`; alerts with the same version, instrument, interval, inputs and frequency share one evaluation. 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. 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` and an `earnings_call` countdown refuse an ETF by name (400 `invalid_parameter`), `news` / `news_keyword` a series ETF.
|
|
19
23
|
* @export
|
|
20
24
|
* @interface AlertCondition
|
|
21
25
|
*/
|
|
@@ -27,7 +31,7 @@ export interface AlertCondition {
|
|
|
27
31
|
*/
|
|
28
32
|
ciks?: Array<string>;
|
|
29
33
|
/**
|
|
30
|
-
* Companies by ticker. Same types as `ciks
|
|
34
|
+
* Companies by ticker. Same types as `ciks`; a US ETF ticker for the types that take ETFs
|
|
31
35
|
* @type {Array<string>}
|
|
32
36
|
* @memberof AlertCondition
|
|
33
37
|
*/
|
|
@@ -39,7 +43,7 @@ export interface AlertCondition {
|
|
|
39
43
|
*/
|
|
40
44
|
cik?: string;
|
|
41
45
|
/**
|
|
42
|
-
* The company by ticker. Same types as `cik`; price types: the instrument (a US stock / ETF ticker, or a crypto slug / ticker)
|
|
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, or a crypto slug / ticker)
|
|
43
47
|
* @type {string}
|
|
44
48
|
* @memberof AlertCondition
|
|
45
49
|
*/
|
|
@@ -219,7 +223,7 @@ export interface AlertCondition {
|
|
|
219
223
|
*/
|
|
220
224
|
notify_on_date_change?: boolean;
|
|
221
225
|
/**
|
|
222
|
-
* The instrument's market: `us_stock` (US stocks and ETFs) or `crypto` (coins by CoinGecko slug or ticker). Absent at create = a stock first, then a coin; stored resolved. price, price_move, volume_spike, price_reminder
|
|
226
|
+
* The instrument's market: `us_stock` (US stocks and ETFs) or `crypto` (coins by CoinGecko slug or ticker). Absent at create = a stock first, then a coin; stored resolved. price, price_move, volume_spike, price_reminder, script, indicator
|
|
223
227
|
* @type {AlertConditionAssetClassEnum}
|
|
224
228
|
* @memberof AlertCondition
|
|
225
229
|
*/
|
|
@@ -267,7 +271,7 @@ export interface AlertCondition {
|
|
|
267
271
|
*/
|
|
268
272
|
mode?: AlertConditionModeEnum;
|
|
269
273
|
/**
|
|
270
|
-
* The bar evaluated at its close (
|
|
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)
|
|
271
275
|
* @type {AlertConditionIntervalEnum}
|
|
272
276
|
* @memberof AlertCondition
|
|
273
277
|
*/
|
|
@@ -303,7 +307,7 @@ export interface AlertCondition {
|
|
|
303
307
|
*/
|
|
304
308
|
price_direction?: AlertConditionPriceDirectionEnum;
|
|
305
309
|
/**
|
|
306
|
-
*
|
|
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
|
|
307
311
|
* @type {AlertConditionFrequencyEnum}
|
|
308
312
|
* @memberof AlertCondition
|
|
309
313
|
*/
|
|
@@ -326,6 +330,50 @@ export interface AlertCondition {
|
|
|
326
330
|
* @memberof AlertCondition
|
|
327
331
|
*/
|
|
328
332
|
days?: Array<number>;
|
|
333
|
+
/**
|
|
334
|
+
* The script version evaluated (`scv_…`, status ok, of a script of this account). script
|
|
335
|
+
* @type {string}
|
|
336
|
+
* @memberof AlertCondition
|
|
337
|
+
*/
|
|
338
|
+
script_version_id?: string;
|
|
339
|
+
/**
|
|
340
|
+
* Values for the script's declared inputs (checked against its manifest; absent = the defaults). script
|
|
341
|
+
* @type {{ [key: string]: any; }}
|
|
342
|
+
* @memberof AlertCondition
|
|
343
|
+
*/
|
|
344
|
+
inputs?: {
|
|
345
|
+
[key: string]: any;
|
|
346
|
+
};
|
|
347
|
+
/**
|
|
348
|
+
* Only these of the script's alerts (its version's `alert_ids`); empty = all. script
|
|
349
|
+
* @type {Array<string>}
|
|
350
|
+
* @memberof AlertCondition
|
|
351
|
+
*/
|
|
352
|
+
alert_ids?: Array<string>;
|
|
353
|
+
/**
|
|
354
|
+
*
|
|
355
|
+
* @type {IndicatorTemplateRef}
|
|
356
|
+
* @memberof AlertCondition
|
|
357
|
+
*/
|
|
358
|
+
template?: IndicatorTemplateRef;
|
|
359
|
+
/**
|
|
360
|
+
*
|
|
361
|
+
* @type {IndicatorCondition}
|
|
362
|
+
* @memberof AlertCondition
|
|
363
|
+
*/
|
|
364
|
+
condition?: IndicatorCondition;
|
|
365
|
+
/**
|
|
366
|
+
*
|
|
367
|
+
* @type {IndicatorFilters}
|
|
368
|
+
* @memberof AlertCondition
|
|
369
|
+
*/
|
|
370
|
+
filters?: IndicatorFilters;
|
|
371
|
+
/**
|
|
372
|
+
*
|
|
373
|
+
* @type {IndicatorResolved}
|
|
374
|
+
* @memberof AlertCondition
|
|
375
|
+
*/
|
|
376
|
+
resolved?: IndicatorResolved;
|
|
329
377
|
}
|
|
330
378
|
/**
|
|
331
379
|
* @export
|
|
@@ -493,7 +541,12 @@ export type AlertConditionModeEnum = typeof AlertConditionModeEnum[keyof typeof
|
|
|
493
541
|
* @export
|
|
494
542
|
*/
|
|
495
543
|
export declare const AlertConditionIntervalEnum: {
|
|
544
|
+
readonly _1m: "1m";
|
|
545
|
+
readonly _5m: "5m";
|
|
546
|
+
readonly _15m: "15m";
|
|
547
|
+
readonly _30m: "30m";
|
|
496
548
|
readonly _1h: "1h";
|
|
549
|
+
readonly _4h: "4h";
|
|
497
550
|
readonly _1d: "1d";
|
|
498
551
|
readonly _1w: "1w";
|
|
499
552
|
readonly _1mo: "1mo";
|
|
@@ -525,6 +578,9 @@ export declare const AlertConditionFrequencyEnum: {
|
|
|
525
578
|
readonly Hourly: "hourly";
|
|
526
579
|
readonly Daily: "daily";
|
|
527
580
|
readonly Weekly: "weekly";
|
|
581
|
+
readonly OncePerBar: "once_per_bar";
|
|
582
|
+
readonly OncePerBarClose: "once_per_bar_close";
|
|
583
|
+
readonly EveryTime: "every_time";
|
|
528
584
|
};
|
|
529
585
|
export type AlertConditionFrequencyEnum = typeof AlertConditionFrequencyEnum[keyof typeof AlertConditionFrequencyEnum] | (string & {});
|
|
530
586
|
/**
|
|
@@ -11,11 +11,15 @@
|
|
|
11
11
|
* https://openapi-generator.tech
|
|
12
12
|
* Do not edit the class manually.
|
|
13
13
|
*/
|
|
14
|
+
import { IndicatorFiltersFromJSON, IndicatorFiltersToJSON, } from './IndicatorFilters';
|
|
14
15
|
import { AlertConditionAmountChangeFromJSON, AlertConditionAmountChangeToJSON, } from './AlertConditionAmountChange';
|
|
15
16
|
import { AlertConditionMentionDeltaRuleFromJSON, AlertConditionMentionDeltaRuleToJSON, } from './AlertConditionMentionDeltaRule';
|
|
17
|
+
import { IndicatorTemplateRefFromJSON, IndicatorTemplateRefToJSON, } from './IndicatorTemplateRef';
|
|
16
18
|
import { AlertConditionRulesInnerFromJSON, AlertConditionRulesInnerToJSON, } from './AlertConditionRulesInner';
|
|
19
|
+
import { IndicatorResolvedFromJSON, IndicatorResolvedToJSON, } from './IndicatorResolved';
|
|
17
20
|
import { AlertConditionYieldRuleFromJSON, AlertConditionYieldRuleToJSON, } from './AlertConditionYieldRule';
|
|
18
21
|
import { AlertConditionYoyRulesInnerFromJSON, AlertConditionYoyRulesInnerToJSON, } from './AlertConditionYoyRulesInner';
|
|
22
|
+
import { IndicatorConditionFromJSON, IndicatorConditionToJSON, } from './IndicatorCondition';
|
|
19
23
|
/**
|
|
20
24
|
* @export
|
|
21
25
|
*/
|
|
@@ -167,7 +171,12 @@ export const AlertConditionModeEnum = {
|
|
|
167
171
|
* @export
|
|
168
172
|
*/
|
|
169
173
|
export const AlertConditionIntervalEnum = {
|
|
174
|
+
_1m: '1m',
|
|
175
|
+
_5m: '5m',
|
|
176
|
+
_15m: '15m',
|
|
177
|
+
_30m: '30m',
|
|
170
178
|
_1h: '1h',
|
|
179
|
+
_4h: '4h',
|
|
171
180
|
_1d: '1d',
|
|
172
181
|
_1w: '1w',
|
|
173
182
|
_1mo: '1mo'
|
|
@@ -195,7 +204,10 @@ export const AlertConditionFrequencyEnum = {
|
|
|
195
204
|
Once: 'once',
|
|
196
205
|
Hourly: 'hourly',
|
|
197
206
|
Daily: 'daily',
|
|
198
|
-
Weekly: 'weekly'
|
|
207
|
+
Weekly: 'weekly',
|
|
208
|
+
OncePerBar: 'once_per_bar',
|
|
209
|
+
OncePerBarClose: 'once_per_bar_close',
|
|
210
|
+
EveryTime: 'every_time'
|
|
199
211
|
};
|
|
200
212
|
/**
|
|
201
213
|
* Check if a given object implements the AlertCondition interface.
|
|
@@ -262,6 +274,13 @@ export function AlertConditionFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
262
274
|
'at': json['at'] == null ? undefined : (new Date(json['at'])),
|
|
263
275
|
'weekday': json['weekday'] == null ? undefined : json['weekday'],
|
|
264
276
|
'days': json['days'] == null ? undefined : json['days'],
|
|
277
|
+
'script_version_id': json['script_version_id'] == null ? undefined : json['script_version_id'],
|
|
278
|
+
'inputs': json['inputs'] == null ? undefined : json['inputs'],
|
|
279
|
+
'alert_ids': json['alert_ids'] == null ? undefined : json['alert_ids'],
|
|
280
|
+
'template': json['template'] == null ? undefined : IndicatorTemplateRefFromJSON(json['template']),
|
|
281
|
+
'condition': json['condition'] == null ? undefined : IndicatorConditionFromJSON(json['condition']),
|
|
282
|
+
'filters': json['filters'] == null ? undefined : IndicatorFiltersFromJSON(json['filters']),
|
|
283
|
+
'resolved': json['resolved'] == null ? undefined : IndicatorResolvedFromJSON(json['resolved']),
|
|
265
284
|
};
|
|
266
285
|
}
|
|
267
286
|
export function AlertConditionToJSON(json) {
|
|
@@ -323,5 +342,12 @@ export function AlertConditionToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
323
342
|
'at': value['at'] == null ? value['at'] : value['at'].toISOString(),
|
|
324
343
|
'weekday': value['weekday'],
|
|
325
344
|
'days': value['days'],
|
|
345
|
+
'script_version_id': value['script_version_id'],
|
|
346
|
+
'inputs': value['inputs'],
|
|
347
|
+
'alert_ids': value['alert_ids'],
|
|
348
|
+
'template': IndicatorTemplateRefToJSON(value['template']),
|
|
349
|
+
'condition': IndicatorConditionToJSON(value['condition']),
|
|
350
|
+
'filters': IndicatorFiltersToJSON(value['filters']),
|
|
351
|
+
'resolved': IndicatorResolvedToJSON(value['resolved']),
|
|
326
352
|
};
|
|
327
353
|
}
|
|
@@ -11,11 +11,14 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { AlertConditionInputAmountChange } from './AlertConditionInputAmountChange';
|
|
13
13
|
import type { AlertConditionInputMentionDeltaRule } from './AlertConditionInputMentionDeltaRule';
|
|
14
|
+
import type { IndicatorTemplateRef } from './IndicatorTemplateRef';
|
|
15
|
+
import type { IndicatorConditionInput } from './IndicatorConditionInput';
|
|
14
16
|
import type { AlertConditionInputYoyRulesInner } from './AlertConditionInputYoyRulesInner';
|
|
15
17
|
import type { AlertConditionInputRulesInner } from './AlertConditionInputRulesInner';
|
|
16
18
|
import type { AlertConditionInputYieldRule } from './AlertConditionInputYieldRule';
|
|
19
|
+
import type { IndicatorFiltersInput } from './IndicatorFiltersInput';
|
|
17
20
|
/**
|
|
18
|
-
* 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`) watch ONE instrument: `symbol` + `asset_class`. 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)
|
|
21
|
+
* 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` and an `earnings_call` countdown refuse an ETF by name (400 `invalid_parameter`), `news` / `news_keyword` a series ETF.
|
|
19
22
|
* @export
|
|
20
23
|
* @interface AlertConditionInput
|
|
21
24
|
*/
|
|
@@ -27,7 +30,7 @@ export interface AlertConditionInput {
|
|
|
27
30
|
*/
|
|
28
31
|
ciks?: Array<string>;
|
|
29
32
|
/**
|
|
30
|
-
* Companies by ticker. Same types as `ciks
|
|
33
|
+
* Companies by ticker. Same types as `ciks`; a US ETF ticker for the types that take ETFs
|
|
31
34
|
* @type {Array<string>}
|
|
32
35
|
* @memberof AlertConditionInput
|
|
33
36
|
*/
|
|
@@ -39,7 +42,7 @@ export interface AlertConditionInput {
|
|
|
39
42
|
*/
|
|
40
43
|
cik?: string;
|
|
41
44
|
/**
|
|
42
|
-
* The company by ticker. Same types as `cik`; price types: the instrument (a US stock / ETF ticker, or a crypto slug / ticker)
|
|
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, or a crypto slug / ticker)
|
|
43
46
|
* @type {string}
|
|
44
47
|
* @memberof AlertConditionInput
|
|
45
48
|
*/
|
|
@@ -219,7 +222,7 @@ export interface AlertConditionInput {
|
|
|
219
222
|
*/
|
|
220
223
|
notify_on_date_change?: boolean;
|
|
221
224
|
/**
|
|
222
|
-
* The instrument's market: `us_stock` (US stocks and ETFs) or `crypto` (coins by CoinGecko slug or ticker). Absent at create = a stock first, then a coin; stored resolved. price, price_move, volume_spike, price_reminder
|
|
225
|
+
* The instrument's market: `us_stock` (US stocks and ETFs) or `crypto` (coins by CoinGecko slug or ticker). Absent at create = a stock first, then a coin; stored resolved. price, price_move, volume_spike, price_reminder, script, indicator
|
|
223
226
|
* @type {AlertConditionInputAssetClassEnum}
|
|
224
227
|
* @memberof AlertConditionInput
|
|
225
228
|
*/
|
|
@@ -267,7 +270,7 @@ export interface AlertConditionInput {
|
|
|
267
270
|
*/
|
|
268
271
|
mode?: AlertConditionInputModeEnum;
|
|
269
272
|
/**
|
|
270
|
-
* The bar evaluated at its close (
|
|
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)
|
|
271
274
|
* @type {AlertConditionInputIntervalEnum}
|
|
272
275
|
* @memberof AlertConditionInput
|
|
273
276
|
*/
|
|
@@ -303,7 +306,7 @@ export interface AlertConditionInput {
|
|
|
303
306
|
*/
|
|
304
307
|
price_direction?: AlertConditionInputPriceDirectionEnum;
|
|
305
308
|
/**
|
|
306
|
-
*
|
|
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
|
|
307
310
|
* @type {AlertConditionInputFrequencyEnum}
|
|
308
311
|
* @memberof AlertConditionInput
|
|
309
312
|
*/
|
|
@@ -326,6 +329,44 @@ export interface AlertConditionInput {
|
|
|
326
329
|
* @memberof AlertConditionInput
|
|
327
330
|
*/
|
|
328
331
|
days?: Array<number>;
|
|
332
|
+
/**
|
|
333
|
+
* The script version evaluated (`scv_…`, status ok, of a script of this account). script
|
|
334
|
+
* @type {string}
|
|
335
|
+
* @memberof AlertConditionInput
|
|
336
|
+
*/
|
|
337
|
+
script_version_id?: string;
|
|
338
|
+
/**
|
|
339
|
+
* Values for the script's declared inputs (checked against its manifest; absent = the defaults). script
|
|
340
|
+
* @type {{ [key: string]: any; }}
|
|
341
|
+
* @memberof AlertConditionInput
|
|
342
|
+
*/
|
|
343
|
+
inputs?: {
|
|
344
|
+
[key: string]: any;
|
|
345
|
+
};
|
|
346
|
+
/**
|
|
347
|
+
* Only these of the script's alerts (its version's `alert_ids`); empty = all. script
|
|
348
|
+
* @type {Array<string>}
|
|
349
|
+
* @memberof AlertConditionInput
|
|
350
|
+
*/
|
|
351
|
+
alert_ids?: Array<string>;
|
|
352
|
+
/**
|
|
353
|
+
*
|
|
354
|
+
* @type {IndicatorTemplateRef}
|
|
355
|
+
* @memberof AlertConditionInput
|
|
356
|
+
*/
|
|
357
|
+
template?: IndicatorTemplateRef;
|
|
358
|
+
/**
|
|
359
|
+
*
|
|
360
|
+
* @type {IndicatorConditionInput}
|
|
361
|
+
* @memberof AlertConditionInput
|
|
362
|
+
*/
|
|
363
|
+
condition?: IndicatorConditionInput;
|
|
364
|
+
/**
|
|
365
|
+
*
|
|
366
|
+
* @type {IndicatorFiltersInput}
|
|
367
|
+
* @memberof AlertConditionInput
|
|
368
|
+
*/
|
|
369
|
+
filters?: IndicatorFiltersInput;
|
|
329
370
|
}
|
|
330
371
|
/**
|
|
331
372
|
* @export
|
|
@@ -493,7 +534,12 @@ export type AlertConditionInputModeEnum = typeof AlertConditionInputModeEnum[key
|
|
|
493
534
|
* @export
|
|
494
535
|
*/
|
|
495
536
|
export declare const AlertConditionInputIntervalEnum: {
|
|
537
|
+
readonly _1m: "1m";
|
|
538
|
+
readonly _5m: "5m";
|
|
539
|
+
readonly _15m: "15m";
|
|
540
|
+
readonly _30m: "30m";
|
|
496
541
|
readonly _1h: "1h";
|
|
542
|
+
readonly _4h: "4h";
|
|
497
543
|
readonly _1d: "1d";
|
|
498
544
|
readonly _1w: "1w";
|
|
499
545
|
readonly _1mo: "1mo";
|
|
@@ -525,6 +571,9 @@ export declare const AlertConditionInputFrequencyEnum: {
|
|
|
525
571
|
readonly Hourly: "hourly";
|
|
526
572
|
readonly Daily: "daily";
|
|
527
573
|
readonly Weekly: "weekly";
|
|
574
|
+
readonly OncePerBar: "once_per_bar";
|
|
575
|
+
readonly OncePerBarClose: "once_per_bar_close";
|
|
576
|
+
readonly EveryTime: "every_time";
|
|
528
577
|
};
|
|
529
578
|
export type AlertConditionInputFrequencyEnum = typeof AlertConditionInputFrequencyEnum[keyof typeof AlertConditionInputFrequencyEnum];
|
|
530
579
|
/**
|
|
@@ -13,9 +13,12 @@
|
|
|
13
13
|
*/
|
|
14
14
|
import { AlertConditionInputAmountChangeFromJSON, AlertConditionInputAmountChangeToJSON, } from './AlertConditionInputAmountChange';
|
|
15
15
|
import { AlertConditionInputMentionDeltaRuleFromJSON, AlertConditionInputMentionDeltaRuleToJSON, } from './AlertConditionInputMentionDeltaRule';
|
|
16
|
+
import { IndicatorTemplateRefFromJSON, IndicatorTemplateRefToJSON, } from './IndicatorTemplateRef';
|
|
17
|
+
import { IndicatorConditionInputFromJSON, IndicatorConditionInputToJSON, } from './IndicatorConditionInput';
|
|
16
18
|
import { AlertConditionInputYoyRulesInnerFromJSON, AlertConditionInputYoyRulesInnerToJSON, } from './AlertConditionInputYoyRulesInner';
|
|
17
19
|
import { AlertConditionInputRulesInnerFromJSON, AlertConditionInputRulesInnerToJSON, } from './AlertConditionInputRulesInner';
|
|
18
20
|
import { AlertConditionInputYieldRuleFromJSON, AlertConditionInputYieldRuleToJSON, } from './AlertConditionInputYieldRule';
|
|
21
|
+
import { IndicatorFiltersInputFromJSON, IndicatorFiltersInputToJSON, } from './IndicatorFiltersInput';
|
|
19
22
|
/**
|
|
20
23
|
* @export
|
|
21
24
|
*/
|
|
@@ -167,7 +170,12 @@ export const AlertConditionInputModeEnum = {
|
|
|
167
170
|
* @export
|
|
168
171
|
*/
|
|
169
172
|
export const AlertConditionInputIntervalEnum = {
|
|
173
|
+
_1m: '1m',
|
|
174
|
+
_5m: '5m',
|
|
175
|
+
_15m: '15m',
|
|
176
|
+
_30m: '30m',
|
|
170
177
|
_1h: '1h',
|
|
178
|
+
_4h: '4h',
|
|
171
179
|
_1d: '1d',
|
|
172
180
|
_1w: '1w',
|
|
173
181
|
_1mo: '1mo'
|
|
@@ -195,7 +203,10 @@ export const AlertConditionInputFrequencyEnum = {
|
|
|
195
203
|
Once: 'once',
|
|
196
204
|
Hourly: 'hourly',
|
|
197
205
|
Daily: 'daily',
|
|
198
|
-
Weekly: 'weekly'
|
|
206
|
+
Weekly: 'weekly',
|
|
207
|
+
OncePerBar: 'once_per_bar',
|
|
208
|
+
OncePerBarClose: 'once_per_bar_close',
|
|
209
|
+
EveryTime: 'every_time'
|
|
199
210
|
};
|
|
200
211
|
/**
|
|
201
212
|
* Check if a given object implements the AlertConditionInput interface.
|
|
@@ -262,6 +273,12 @@ export function AlertConditionInputFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
262
273
|
'at': json['at'] == null ? undefined : json['at'],
|
|
263
274
|
'weekday': json['weekday'] == null ? undefined : json['weekday'],
|
|
264
275
|
'days': json['days'] == null ? undefined : json['days'],
|
|
276
|
+
'script_version_id': json['script_version_id'] == null ? undefined : json['script_version_id'],
|
|
277
|
+
'inputs': json['inputs'] == null ? undefined : json['inputs'],
|
|
278
|
+
'alert_ids': json['alert_ids'] == null ? undefined : json['alert_ids'],
|
|
279
|
+
'template': json['template'] == null ? undefined : IndicatorTemplateRefFromJSON(json['template']),
|
|
280
|
+
'condition': json['condition'] == null ? undefined : IndicatorConditionInputFromJSON(json['condition']),
|
|
281
|
+
'filters': json['filters'] == null ? undefined : IndicatorFiltersInputFromJSON(json['filters']),
|
|
265
282
|
};
|
|
266
283
|
}
|
|
267
284
|
export function AlertConditionInputToJSON(json) {
|
|
@@ -323,5 +340,11 @@ export function AlertConditionInputToJSONTyped(value, ignoreDiscriminator = fals
|
|
|
323
340
|
'at': value['at'],
|
|
324
341
|
'weekday': value['weekday'],
|
|
325
342
|
'days': value['days'],
|
|
343
|
+
'script_version_id': value['script_version_id'],
|
|
344
|
+
'inputs': value['inputs'],
|
|
345
|
+
'alert_ids': value['alert_ids'],
|
|
346
|
+
'template': IndicatorTemplateRefToJSON(value['template']),
|
|
347
|
+
'condition': IndicatorConditionInputToJSON(value['condition']),
|
|
348
|
+
'filters': IndicatorFiltersInputToJSON(value['filters']),
|
|
326
349
|
};
|
|
327
350
|
}
|
|
@@ -0,0 +1,83 @@
|
|
|
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
|
+
import type { AlertTemplateInput } from './AlertTemplateInput';
|
|
13
|
+
/**
|
|
14
|
+
* A built-in template of the `indicator` alert type.
|
|
15
|
+
* @export
|
|
16
|
+
* @interface AlertTemplate
|
|
17
|
+
*/
|
|
18
|
+
export interface AlertTemplate {
|
|
19
|
+
/**
|
|
20
|
+
* The template key (`condition.template.key`)
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof AlertTemplate
|
|
23
|
+
*/
|
|
24
|
+
key: string;
|
|
25
|
+
/**
|
|
26
|
+
* Its current version
|
|
27
|
+
* @type {number}
|
|
28
|
+
* @memberof AlertTemplate
|
|
29
|
+
*/
|
|
30
|
+
version: number;
|
|
31
|
+
/**
|
|
32
|
+
* `builtin:<key>@<version>`
|
|
33
|
+
* @type {string}
|
|
34
|
+
* @memberof AlertTemplate
|
|
35
|
+
*/
|
|
36
|
+
source_key: string;
|
|
37
|
+
/**
|
|
38
|
+
* Display name
|
|
39
|
+
* @type {string}
|
|
40
|
+
* @memberof AlertTemplate
|
|
41
|
+
*/
|
|
42
|
+
title: string;
|
|
43
|
+
/**
|
|
44
|
+
* What it alerts on
|
|
45
|
+
* @type {string}
|
|
46
|
+
* @memberof AlertTemplate
|
|
47
|
+
*/
|
|
48
|
+
description: string;
|
|
49
|
+
/**
|
|
50
|
+
* `exact`: its state restores from a snapshot after a restart; `lossy`: it warms up from history again (crossovers)
|
|
51
|
+
* @type {AlertTemplateFidelityEnum}
|
|
52
|
+
* @memberof AlertTemplate
|
|
53
|
+
*/
|
|
54
|
+
fidelity: AlertTemplateFidelityEnum;
|
|
55
|
+
/**
|
|
56
|
+
* Its inputs, in order
|
|
57
|
+
* @type {Array<AlertTemplateInput>}
|
|
58
|
+
* @memberof AlertTemplate
|
|
59
|
+
*/
|
|
60
|
+
inputs: Array<AlertTemplateInput>;
|
|
61
|
+
/**
|
|
62
|
+
* The chartlang source
|
|
63
|
+
* @type {string}
|
|
64
|
+
* @memberof AlertTemplate
|
|
65
|
+
*/
|
|
66
|
+
source: string;
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* @export
|
|
70
|
+
*/
|
|
71
|
+
export declare const AlertTemplateFidelityEnum: {
|
|
72
|
+
readonly Exact: "exact";
|
|
73
|
+
readonly Lossy: "lossy";
|
|
74
|
+
};
|
|
75
|
+
export type AlertTemplateFidelityEnum = typeof AlertTemplateFidelityEnum[keyof typeof AlertTemplateFidelityEnum] | (string & {});
|
|
76
|
+
/**
|
|
77
|
+
* Check if a given object implements the AlertTemplate interface.
|
|
78
|
+
*/
|
|
79
|
+
export declare function instanceOfAlertTemplate(value: object): value is AlertTemplate;
|
|
80
|
+
export declare function AlertTemplateFromJSON(json: any): AlertTemplate;
|
|
81
|
+
export declare function AlertTemplateFromJSONTyped(json: any, ignoreDiscriminator: boolean): AlertTemplate;
|
|
82
|
+
export declare function AlertTemplateToJSON(json: any): AlertTemplate;
|
|
83
|
+
export declare function AlertTemplateToJSONTyped(value?: AlertTemplate | null, ignoreDiscriminator?: boolean): any;
|
|
@@ -0,0 +1,79 @@
|
|
|
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
|
+
import { AlertTemplateInputFromJSON, AlertTemplateInputToJSON, } from './AlertTemplateInput';
|
|
15
|
+
/**
|
|
16
|
+
* @export
|
|
17
|
+
*/
|
|
18
|
+
export const AlertTemplateFidelityEnum = {
|
|
19
|
+
Exact: 'exact',
|
|
20
|
+
Lossy: 'lossy'
|
|
21
|
+
};
|
|
22
|
+
/**
|
|
23
|
+
* Check if a given object implements the AlertTemplate interface.
|
|
24
|
+
*/
|
|
25
|
+
export function instanceOfAlertTemplate(value) {
|
|
26
|
+
if (!('key' in value) || value['key'] === undefined)
|
|
27
|
+
return false;
|
|
28
|
+
if (!('version' in value) || value['version'] === undefined)
|
|
29
|
+
return false;
|
|
30
|
+
if (!('source_key' in value) || value['source_key'] === undefined)
|
|
31
|
+
return false;
|
|
32
|
+
if (!('title' in value) || value['title'] === undefined)
|
|
33
|
+
return false;
|
|
34
|
+
if (!('description' in value) || value['description'] === undefined)
|
|
35
|
+
return false;
|
|
36
|
+
if (!('fidelity' in value) || value['fidelity'] === undefined)
|
|
37
|
+
return false;
|
|
38
|
+
if (!('inputs' in value) || value['inputs'] === undefined)
|
|
39
|
+
return false;
|
|
40
|
+
if (!('source' in value) || value['source'] === undefined)
|
|
41
|
+
return false;
|
|
42
|
+
return true;
|
|
43
|
+
}
|
|
44
|
+
export function AlertTemplateFromJSON(json) {
|
|
45
|
+
return AlertTemplateFromJSONTyped(json, false);
|
|
46
|
+
}
|
|
47
|
+
export function AlertTemplateFromJSONTyped(json, ignoreDiscriminator) {
|
|
48
|
+
if (json == null) {
|
|
49
|
+
return json;
|
|
50
|
+
}
|
|
51
|
+
return {
|
|
52
|
+
'key': json['key'],
|
|
53
|
+
'version': json['version'],
|
|
54
|
+
'source_key': json['source_key'],
|
|
55
|
+
'title': json['title'],
|
|
56
|
+
'description': json['description'],
|
|
57
|
+
'fidelity': json['fidelity'],
|
|
58
|
+
'inputs': (json['inputs'].map(AlertTemplateInputFromJSON)),
|
|
59
|
+
'source': json['source'],
|
|
60
|
+
};
|
|
61
|
+
}
|
|
62
|
+
export function AlertTemplateToJSON(json) {
|
|
63
|
+
return AlertTemplateToJSONTyped(json, false);
|
|
64
|
+
}
|
|
65
|
+
export function AlertTemplateToJSONTyped(value, ignoreDiscriminator = false) {
|
|
66
|
+
if (value == null) {
|
|
67
|
+
return value;
|
|
68
|
+
}
|
|
69
|
+
return {
|
|
70
|
+
'key': value['key'],
|
|
71
|
+
'version': value['version'],
|
|
72
|
+
'source_key': value['source_key'],
|
|
73
|
+
'title': value['title'],
|
|
74
|
+
'description': value['description'],
|
|
75
|
+
'fidelity': value['fidelity'],
|
|
76
|
+
'inputs': (value['inputs'].map(AlertTemplateInputToJSON)),
|
|
77
|
+
'source': value['source'],
|
|
78
|
+
};
|
|
79
|
+
}
|