@invinite-org/data-api-client 6.0.0 → 6.2.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/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/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/models/AlertCondition.d.ts +199 -5
- package/dist/esm/models/AlertCondition.js +113 -0
- package/dist/esm/models/AlertConditionInput.d.ts +199 -5
- package/dist/esm/models/AlertConditionInput.js +113 -0
- 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/CreateDestinationRequest.d.ts +12 -0
- package/dist/esm/models/CreateDestinationRequest.js +4 -0
- package/dist/esm/models/Destination.d.ts +12 -0
- package/dist/esm/models/Destination.js +8 -0
- package/dist/esm/models/DestinationCreated.d.ts +12 -0
- package/dist/esm/models/DestinationCreated.js +8 -0
- package/dist/esm/models/UpdateDestinationRequest.d.ts +12 -0
- package/dist/esm/models/UpdateDestinationRequest.js +4 -0
- package/dist/models/AlertCondition.d.ts +199 -5
- package/dist/models/AlertCondition.js +114 -1
- package/dist/models/AlertConditionInput.d.ts +199 -5
- package/dist/models/AlertConditionInput.js +114 -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/CreateDestinationRequest.d.ts +12 -0
- package/dist/models/CreateDestinationRequest.js +4 -0
- package/dist/models/Destination.d.ts +12 -0
- package/dist/models/Destination.js +8 -0
- package/dist/models/DestinationCreated.d.ts +12 -0
- package/dist/models/DestinationCreated.js +8 -0
- package/dist/models/UpdateDestinationRequest.d.ts +12 -0
- package/dist/models/UpdateDestinationRequest.js +4 -0
- package/docs/AlertCondition.md +37 -1
- package/docs/AlertConditionInput.md +37 -1
- package/docs/CompaniesApi.md +2 -2
- package/docs/CreateDestinationRequest.md +4 -0
- package/docs/Destination.md +4 -0
- package/docs/DestinationCreated.md +4 -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/InsiderTradesApi.md +2 -2
- package/docs/InvestorDocumentsApi.md +4 -4
- package/docs/MetricsApi.md +10 -10
- package/docs/NewsApi.md +6 -6
- package/docs/ReferenceApi.md +8 -8
- package/docs/TranscriptsApi.md +2 -2
- package/docs/UpdateDestinationRequest.md +4 -0
- package/package.json +1 -1
- package/src/apis/FilingsApi.ts +2 -2
- package/src/apis/ReferenceApi.ts +4 -4
- package/src/models/AlertCondition.ts +244 -5
- package/src/models/AlertConditionInput.ts +244 -5
- package/src/models/Company.ts +8 -8
- package/src/models/CompanyListItem.ts +1 -1
- package/src/models/CompanyRef.ts +1 -1
- package/src/models/CreateDestinationRequest.ts +16 -0
- package/src/models/Destination.ts +18 -0
- package/src/models/DestinationCreated.ts +18 -0
- package/src/models/UpdateDestinationRequest.ts +16 -0
|
@@ -154,12 +154,12 @@ export declare class FilingsApi extends runtime.BaseAPI {
|
|
|
154
154
|
*/
|
|
155
155
|
listFilingsRequestOpts(requestParameters: ListFilingsRequest): Promise<runtime.RequestOpts>;
|
|
156
156
|
/**
|
|
157
|
-
* A company’s SEC filings by filing date (newest first by default). Several companies are read one after another: all filings of the first company in the request’s order, then the next; `meta.form_facet` sums the forms of the companies read on the page. `items` is applied to the store’s pages, so a page can hold fewer than `limit` rows while `has_more` is true; follow `next_cursor` until `has_more` is false.
|
|
157
|
+
* A company’s SEC filings by filing date (newest first by default). Several companies are read one after another: all filings of the first company in the request’s order, then the next; `meta.form_facet` sums the forms of the companies read on the page. `items` is applied to the store’s pages, so a page can hold fewer than `limit` rows while `has_more` is true; follow `next_cursor` until `has_more` is false. For a US ETF that is a series of a multi-series trust (TQQQ), only the accessions naming its series (`series_id`) are listed, never the whole trust; an ETF that is its own SEC registrant (SPY, QQQ) lists its registrant\'s filings.
|
|
158
158
|
* List filings
|
|
159
159
|
*/
|
|
160
160
|
listFilingsRaw(requestParameters: ListFilingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListFilings200Response>>;
|
|
161
161
|
/**
|
|
162
|
-
* A company’s SEC filings by filing date (newest first by default). Several companies are read one after another: all filings of the first company in the request’s order, then the next; `meta.form_facet` sums the forms of the companies read on the page. `items` is applied to the store’s pages, so a page can hold fewer than `limit` rows while `has_more` is true; follow `next_cursor` until `has_more` is false.
|
|
162
|
+
* A company’s SEC filings by filing date (newest first by default). Several companies are read one after another: all filings of the first company in the request’s order, then the next; `meta.form_facet` sums the forms of the companies read on the page. `items` is applied to the store’s pages, so a page can hold fewer than `limit` rows while `has_more` is true; follow `next_cursor` until `has_more` is false. For a US ETF that is a series of a multi-series trust (TQQQ), only the accessions naming its series (`series_id`) are listed, never the whole trust; an ETF that is its own SEC registrant (SPY, QQQ) lists its registrant\'s filings.
|
|
163
163
|
* List filings
|
|
164
164
|
*/
|
|
165
165
|
listFilings(requestParameters: ListFilingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListFilings200Response>;
|
package/dist/apis/FilingsApi.js
CHANGED
|
@@ -382,7 +382,7 @@ class FilingsApi extends runtime.BaseAPI {
|
|
|
382
382
|
});
|
|
383
383
|
}
|
|
384
384
|
/**
|
|
385
|
-
* A company’s SEC filings by filing date (newest first by default). Several companies are read one after another: all filings of the first company in the request’s order, then the next; `meta.form_facet` sums the forms of the companies read on the page. `items` is applied to the store’s pages, so a page can hold fewer than `limit` rows while `has_more` is true; follow `next_cursor` until `has_more` is false.
|
|
385
|
+
* A company’s SEC filings by filing date (newest first by default). Several companies are read one after another: all filings of the first company in the request’s order, then the next; `meta.form_facet` sums the forms of the companies read on the page. `items` is applied to the store’s pages, so a page can hold fewer than `limit` rows while `has_more` is true; follow `next_cursor` until `has_more` is false. For a US ETF that is a series of a multi-series trust (TQQQ), only the accessions naming its series (`series_id`) are listed, never the whole trust; an ETF that is its own SEC registrant (SPY, QQQ) lists its registrant\'s filings.
|
|
386
386
|
* List filings
|
|
387
387
|
*/
|
|
388
388
|
listFilingsRaw(requestParameters, initOverrides) {
|
|
@@ -393,7 +393,7 @@ class FilingsApi extends runtime.BaseAPI {
|
|
|
393
393
|
});
|
|
394
394
|
}
|
|
395
395
|
/**
|
|
396
|
-
* A company’s SEC filings by filing date (newest first by default). Several companies are read one after another: all filings of the first company in the request’s order, then the next; `meta.form_facet` sums the forms of the companies read on the page. `items` is applied to the store’s pages, so a page can hold fewer than `limit` rows while `has_more` is true; follow `next_cursor` until `has_more` is false.
|
|
396
|
+
* A company’s SEC filings by filing date (newest first by default). Several companies are read one after another: all filings of the first company in the request’s order, then the next; `meta.form_facet` sums the forms of the companies read on the page. `items` is applied to the store’s pages, so a page can hold fewer than `limit` rows while `has_more` is true; follow `next_cursor` until `has_more` is false. For a US ETF that is a series of a multi-series trust (TQQQ), only the accessions naming its series (`series_id`) are listed, never the whole trust; an ETF that is its own SEC registrant (SPY, QQQ) lists its registrant\'s filings.
|
|
397
397
|
* List filings
|
|
398
398
|
*/
|
|
399
399
|
listFilings(requestParameters, initOverrides) {
|
|
@@ -58,12 +58,12 @@ export declare class ReferenceApi extends runtime.BaseAPI {
|
|
|
58
58
|
*/
|
|
59
59
|
listDividendsRequestOpts(requestParameters: ListDividendsRequest): Promise<runtime.RequestOpts>;
|
|
60
60
|
/**
|
|
61
|
-
*
|
|
61
|
+
* Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
|
|
62
62
|
* List dividends
|
|
63
63
|
*/
|
|
64
64
|
listDividendsRaw(requestParameters: ListDividendsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListDividends200Response>>;
|
|
65
65
|
/**
|
|
66
|
-
*
|
|
66
|
+
* Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
|
|
67
67
|
* List dividends
|
|
68
68
|
*/
|
|
69
69
|
listDividends(requestParameters: ListDividendsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListDividends200Response>;
|
|
@@ -100,12 +100,12 @@ export declare class ReferenceApi extends runtime.BaseAPI {
|
|
|
100
100
|
*/
|
|
101
101
|
listSplitsRequestOpts(requestParameters: ListSplitsRequest): Promise<runtime.RequestOpts>;
|
|
102
102
|
/**
|
|
103
|
-
*
|
|
103
|
+
* Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
|
|
104
104
|
* List stock splits
|
|
105
105
|
*/
|
|
106
106
|
listSplitsRaw(requestParameters: ListSplitsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListSplits200Response>>;
|
|
107
107
|
/**
|
|
108
|
-
*
|
|
108
|
+
* Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
|
|
109
109
|
* List stock splits
|
|
110
110
|
*/
|
|
111
111
|
listSplits(requestParameters: ListSplitsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListSplits200Response>;
|
|
@@ -86,7 +86,7 @@ class ReferenceApi extends runtime.BaseAPI {
|
|
|
86
86
|
});
|
|
87
87
|
}
|
|
88
88
|
/**
|
|
89
|
-
*
|
|
89
|
+
* Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
|
|
90
90
|
* List dividends
|
|
91
91
|
*/
|
|
92
92
|
listDividendsRaw(requestParameters, initOverrides) {
|
|
@@ -97,7 +97,7 @@ class ReferenceApi extends runtime.BaseAPI {
|
|
|
97
97
|
});
|
|
98
98
|
}
|
|
99
99
|
/**
|
|
100
|
-
*
|
|
100
|
+
* Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
|
|
101
101
|
* List dividends
|
|
102
102
|
*/
|
|
103
103
|
listDividends(requestParameters, initOverrides) {
|
|
@@ -278,7 +278,7 @@ class ReferenceApi extends runtime.BaseAPI {
|
|
|
278
278
|
});
|
|
279
279
|
}
|
|
280
280
|
/**
|
|
281
|
-
*
|
|
281
|
+
* Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
|
|
282
282
|
* List stock splits
|
|
283
283
|
*/
|
|
284
284
|
listSplitsRaw(requestParameters, initOverrides) {
|
|
@@ -289,7 +289,7 @@ class ReferenceApi extends runtime.BaseAPI {
|
|
|
289
289
|
});
|
|
290
290
|
}
|
|
291
291
|
/**
|
|
292
|
-
*
|
|
292
|
+
* Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
|
|
293
293
|
* List stock splits
|
|
294
294
|
*/
|
|
295
295
|
listSplits(requestParameters, initOverrides) {
|
|
@@ -154,12 +154,12 @@ export declare class FilingsApi extends runtime.BaseAPI {
|
|
|
154
154
|
*/
|
|
155
155
|
listFilingsRequestOpts(requestParameters: ListFilingsRequest): Promise<runtime.RequestOpts>;
|
|
156
156
|
/**
|
|
157
|
-
* A company’s SEC filings by filing date (newest first by default). Several companies are read one after another: all filings of the first company in the request’s order, then the next; `meta.form_facet` sums the forms of the companies read on the page. `items` is applied to the store’s pages, so a page can hold fewer than `limit` rows while `has_more` is true; follow `next_cursor` until `has_more` is false.
|
|
157
|
+
* A company’s SEC filings by filing date (newest first by default). Several companies are read one after another: all filings of the first company in the request’s order, then the next; `meta.form_facet` sums the forms of the companies read on the page. `items` is applied to the store’s pages, so a page can hold fewer than `limit` rows while `has_more` is true; follow `next_cursor` until `has_more` is false. For a US ETF that is a series of a multi-series trust (TQQQ), only the accessions naming its series (`series_id`) are listed, never the whole trust; an ETF that is its own SEC registrant (SPY, QQQ) lists its registrant\'s filings.
|
|
158
158
|
* List filings
|
|
159
159
|
*/
|
|
160
160
|
listFilingsRaw(requestParameters: ListFilingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListFilings200Response>>;
|
|
161
161
|
/**
|
|
162
|
-
* A company’s SEC filings by filing date (newest first by default). Several companies are read one after another: all filings of the first company in the request’s order, then the next; `meta.form_facet` sums the forms of the companies read on the page. `items` is applied to the store’s pages, so a page can hold fewer than `limit` rows while `has_more` is true; follow `next_cursor` until `has_more` is false.
|
|
162
|
+
* A company’s SEC filings by filing date (newest first by default). Several companies are read one after another: all filings of the first company in the request’s order, then the next; `meta.form_facet` sums the forms of the companies read on the page. `items` is applied to the store’s pages, so a page can hold fewer than `limit` rows while `has_more` is true; follow `next_cursor` until `has_more` is false. For a US ETF that is a series of a multi-series trust (TQQQ), only the accessions naming its series (`series_id`) are listed, never the whole trust; an ETF that is its own SEC registrant (SPY, QQQ) lists its registrant\'s filings.
|
|
163
163
|
* List filings
|
|
164
164
|
*/
|
|
165
165
|
listFilings(requestParameters: ListFilingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListFilings200Response>;
|
|
@@ -379,7 +379,7 @@ export class FilingsApi extends runtime.BaseAPI {
|
|
|
379
379
|
});
|
|
380
380
|
}
|
|
381
381
|
/**
|
|
382
|
-
* A company’s SEC filings by filing date (newest first by default). Several companies are read one after another: all filings of the first company in the request’s order, then the next; `meta.form_facet` sums the forms of the companies read on the page. `items` is applied to the store’s pages, so a page can hold fewer than `limit` rows while `has_more` is true; follow `next_cursor` until `has_more` is false.
|
|
382
|
+
* A company’s SEC filings by filing date (newest first by default). Several companies are read one after another: all filings of the first company in the request’s order, then the next; `meta.form_facet` sums the forms of the companies read on the page. `items` is applied to the store’s pages, so a page can hold fewer than `limit` rows while `has_more` is true; follow `next_cursor` until `has_more` is false. For a US ETF that is a series of a multi-series trust (TQQQ), only the accessions naming its series (`series_id`) are listed, never the whole trust; an ETF that is its own SEC registrant (SPY, QQQ) lists its registrant\'s filings.
|
|
383
383
|
* List filings
|
|
384
384
|
*/
|
|
385
385
|
listFilingsRaw(requestParameters, initOverrides) {
|
|
@@ -390,7 +390,7 @@ export class FilingsApi extends runtime.BaseAPI {
|
|
|
390
390
|
});
|
|
391
391
|
}
|
|
392
392
|
/**
|
|
393
|
-
* A company’s SEC filings by filing date (newest first by default). Several companies are read one after another: all filings of the first company in the request’s order, then the next; `meta.form_facet` sums the forms of the companies read on the page. `items` is applied to the store’s pages, so a page can hold fewer than `limit` rows while `has_more` is true; follow `next_cursor` until `has_more` is false.
|
|
393
|
+
* A company’s SEC filings by filing date (newest first by default). Several companies are read one after another: all filings of the first company in the request’s order, then the next; `meta.form_facet` sums the forms of the companies read on the page. `items` is applied to the store’s pages, so a page can hold fewer than `limit` rows while `has_more` is true; follow `next_cursor` until `has_more` is false. For a US ETF that is a series of a multi-series trust (TQQQ), only the accessions naming its series (`series_id`) are listed, never the whole trust; an ETF that is its own SEC registrant (SPY, QQQ) lists its registrant\'s filings.
|
|
394
394
|
* List filings
|
|
395
395
|
*/
|
|
396
396
|
listFilings(requestParameters, initOverrides) {
|
|
@@ -58,12 +58,12 @@ export declare class ReferenceApi extends runtime.BaseAPI {
|
|
|
58
58
|
*/
|
|
59
59
|
listDividendsRequestOpts(requestParameters: ListDividendsRequest): Promise<runtime.RequestOpts>;
|
|
60
60
|
/**
|
|
61
|
-
*
|
|
61
|
+
* Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
|
|
62
62
|
* List dividends
|
|
63
63
|
*/
|
|
64
64
|
listDividendsRaw(requestParameters: ListDividendsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListDividends200Response>>;
|
|
65
65
|
/**
|
|
66
|
-
*
|
|
66
|
+
* Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
|
|
67
67
|
* List dividends
|
|
68
68
|
*/
|
|
69
69
|
listDividends(requestParameters: ListDividendsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListDividends200Response>;
|
|
@@ -100,12 +100,12 @@ export declare class ReferenceApi extends runtime.BaseAPI {
|
|
|
100
100
|
*/
|
|
101
101
|
listSplitsRequestOpts(requestParameters: ListSplitsRequest): Promise<runtime.RequestOpts>;
|
|
102
102
|
/**
|
|
103
|
-
*
|
|
103
|
+
* Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
|
|
104
104
|
* List stock splits
|
|
105
105
|
*/
|
|
106
106
|
listSplitsRaw(requestParameters: ListSplitsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListSplits200Response>>;
|
|
107
107
|
/**
|
|
108
|
-
*
|
|
108
|
+
* Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
|
|
109
109
|
* List stock splits
|
|
110
110
|
*/
|
|
111
111
|
listSplits(requestParameters: ListSplitsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListSplits200Response>;
|
|
@@ -83,7 +83,7 @@ export class ReferenceApi extends runtime.BaseAPI {
|
|
|
83
83
|
});
|
|
84
84
|
}
|
|
85
85
|
/**
|
|
86
|
-
*
|
|
86
|
+
* Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
|
|
87
87
|
* List dividends
|
|
88
88
|
*/
|
|
89
89
|
listDividendsRaw(requestParameters, initOverrides) {
|
|
@@ -94,7 +94,7 @@ export class ReferenceApi extends runtime.BaseAPI {
|
|
|
94
94
|
});
|
|
95
95
|
}
|
|
96
96
|
/**
|
|
97
|
-
*
|
|
97
|
+
* Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
|
|
98
98
|
* List dividends
|
|
99
99
|
*/
|
|
100
100
|
listDividends(requestParameters, initOverrides) {
|
|
@@ -275,7 +275,7 @@ export class ReferenceApi extends runtime.BaseAPI {
|
|
|
275
275
|
});
|
|
276
276
|
}
|
|
277
277
|
/**
|
|
278
|
-
*
|
|
278
|
+
* Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
|
|
279
279
|
* List stock splits
|
|
280
280
|
*/
|
|
281
281
|
listSplitsRaw(requestParameters, initOverrides) {
|
|
@@ -286,7 +286,7 @@ export class ReferenceApi extends runtime.BaseAPI {
|
|
|
286
286
|
});
|
|
287
287
|
}
|
|
288
288
|
/**
|
|
289
|
-
*
|
|
289
|
+
* Keyed by ticker: a US ETF of either identity (SPY, TQQQ) answers like a company.
|
|
290
290
|
* List stock splits
|
|
291
291
|
*/
|
|
292
292
|
listSplits(requestParameters, initOverrides) {
|
|
@@ -15,7 +15,7 @@ import type { AlertConditionRulesInner } from './AlertConditionRulesInner';
|
|
|
15
15
|
import type { AlertConditionYieldRule } from './AlertConditionYieldRule';
|
|
16
16
|
import type { AlertConditionYoyRulesInner } from './AlertConditionYoyRulesInner';
|
|
17
17
|
/**
|
|
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. 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.
|
|
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. 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
19
|
* @export
|
|
20
20
|
* @interface AlertCondition
|
|
21
21
|
*/
|
|
@@ -27,7 +27,7 @@ export interface AlertCondition {
|
|
|
27
27
|
*/
|
|
28
28
|
ciks?: Array<string>;
|
|
29
29
|
/**
|
|
30
|
-
* Companies by ticker. Same types as `ciks
|
|
30
|
+
* Companies by ticker. Same types as `ciks`; a US ETF ticker for the types that take ETFs
|
|
31
31
|
* @type {Array<string>}
|
|
32
32
|
* @memberof AlertCondition
|
|
33
33
|
*/
|
|
@@ -39,7 +39,7 @@ export interface AlertCondition {
|
|
|
39
39
|
*/
|
|
40
40
|
cik?: string;
|
|
41
41
|
/**
|
|
42
|
-
* The company by ticker. Same types as `cik
|
|
42
|
+
* The company (or, for the types that take ETFs, the US ETF) by ticker. Same types as `cik`; price types: the instrument (a US stock / ETF ticker, or a crypto slug / ticker)
|
|
43
43
|
* @type {string}
|
|
44
44
|
* @memberof AlertCondition
|
|
45
45
|
*/
|
|
@@ -201,13 +201,13 @@ export interface AlertCondition {
|
|
|
201
201
|
*/
|
|
202
202
|
minutes_before?: number;
|
|
203
203
|
/**
|
|
204
|
-
* Local minute of the day the reminder fires (default 540 = 09:00). event_countdown
|
|
204
|
+
* Local minute of the day the reminder fires (event_countdown: default 540 = 09:00). event_countdown, price_reminder
|
|
205
205
|
* @type {number}
|
|
206
206
|
* @memberof AlertCondition
|
|
207
207
|
*/
|
|
208
208
|
time_of_day_minutes?: number;
|
|
209
209
|
/**
|
|
210
|
-
* IANA time zone. event_countdown
|
|
210
|
+
* IANA time zone (price_reminder: default America/New_York). event_countdown, price_reminder
|
|
211
211
|
* @type {string}
|
|
212
212
|
* @memberof AlertCondition
|
|
213
213
|
*/
|
|
@@ -218,6 +218,114 @@ export interface AlertCondition {
|
|
|
218
218
|
* @memberof AlertCondition
|
|
219
219
|
*/
|
|
220
220
|
notify_on_date_change?: boolean;
|
|
221
|
+
/**
|
|
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
|
|
223
|
+
* @type {AlertConditionAssetClassEnum}
|
|
224
|
+
* @memberof AlertCondition
|
|
225
|
+
*/
|
|
226
|
+
asset_class?: AlertConditionAssetClassEnum;
|
|
227
|
+
/**
|
|
228
|
+
* `crosses_*` fire when the price crosses `level`; `above` / `below` also fire at once when the price is already on that side. price
|
|
229
|
+
* @type {AlertConditionOperatorEnum}
|
|
230
|
+
* @memberof AlertCondition
|
|
231
|
+
*/
|
|
232
|
+
operator?: AlertConditionOperatorEnum;
|
|
233
|
+
/**
|
|
234
|
+
* The price level (> 0). price
|
|
235
|
+
* @type {number}
|
|
236
|
+
* @memberof AlertCondition
|
|
237
|
+
*/
|
|
238
|
+
level?: number;
|
|
239
|
+
/**
|
|
240
|
+
* Which move fires. price_move
|
|
241
|
+
* @type {AlertConditionDirectionEnum}
|
|
242
|
+
* @memberof AlertCondition
|
|
243
|
+
*/
|
|
244
|
+
direction?: AlertConditionDirectionEnum;
|
|
245
|
+
/**
|
|
246
|
+
* The move in percent of the baseline. price_move
|
|
247
|
+
* @type {number}
|
|
248
|
+
* @memberof AlertCondition
|
|
249
|
+
*/
|
|
250
|
+
pct?: number;
|
|
251
|
+
/**
|
|
252
|
+
* What the move is measured from (ignored with window_minutes); gap_open = the session open against the prior close, once per session. price_move
|
|
253
|
+
* @type {AlertConditionBaselineEnum}
|
|
254
|
+
* @memberof AlertCondition
|
|
255
|
+
*/
|
|
256
|
+
baseline?: AlertConditionBaselineEnum;
|
|
257
|
+
/**
|
|
258
|
+
* Measure the move against the price this many minutes ago instead of the baseline. price_move
|
|
259
|
+
* @type {number}
|
|
260
|
+
* @memberof AlertCondition
|
|
261
|
+
*/
|
|
262
|
+
window_minutes?: number;
|
|
263
|
+
/**
|
|
264
|
+
* `relative` = a closed bar's volume ≥ multiple × its baseline; `absolute` = ≥ threshold; `session` = today's cumulative volume ≥ multiple × the 20-session average daily volume (US stocks). volume_spike
|
|
265
|
+
* @type {AlertConditionModeEnum}
|
|
266
|
+
* @memberof AlertCondition
|
|
267
|
+
*/
|
|
268
|
+
mode?: AlertConditionModeEnum;
|
|
269
|
+
/**
|
|
270
|
+
* The bar evaluated at its close (relative / absolute). volume_spike
|
|
271
|
+
* @type {AlertConditionIntervalEnum}
|
|
272
|
+
* @memberof AlertCondition
|
|
273
|
+
*/
|
|
274
|
+
interval?: AlertConditionIntervalEnum;
|
|
275
|
+
/**
|
|
276
|
+
* Volume multiple of the baseline (relative / session). volume_spike
|
|
277
|
+
* @type {number}
|
|
278
|
+
* @memberof AlertCondition
|
|
279
|
+
*/
|
|
280
|
+
multiple?: number;
|
|
281
|
+
/**
|
|
282
|
+
* Bar volume threshold, > 0 (absolute). volume_spike
|
|
283
|
+
* @type {number}
|
|
284
|
+
* @memberof AlertCondition
|
|
285
|
+
*/
|
|
286
|
+
threshold?: number;
|
|
287
|
+
/**
|
|
288
|
+
* Bars in the baseline, 5–200 (rvol_slot: sessions, 2–20). volume_spike
|
|
289
|
+
* @type {number}
|
|
290
|
+
* @memberof AlertCondition
|
|
291
|
+
*/
|
|
292
|
+
lookback_bars?: number;
|
|
293
|
+
/**
|
|
294
|
+
* The volume baseline: the mean or the median of the previous bars, or `rvol_slot` = the mean of the same time-of-day bar of earlier sessions (default flat_mean). volume_spike
|
|
295
|
+
* @type {AlertConditionBaselineModeEnum}
|
|
296
|
+
* @memberof AlertCondition
|
|
297
|
+
*/
|
|
298
|
+
baseline_mode?: AlertConditionBaselineModeEnum;
|
|
299
|
+
/**
|
|
300
|
+
* Only bars that closed up / down (default any). volume_spike
|
|
301
|
+
* @type {AlertConditionPriceDirectionEnum}
|
|
302
|
+
* @memberof AlertCondition
|
|
303
|
+
*/
|
|
304
|
+
price_direction?: AlertConditionPriceDirectionEnum;
|
|
305
|
+
/**
|
|
306
|
+
* When the reminder fires: once at `at`, on the hour, daily or weekly at `time_of_day_minutes`. price_reminder
|
|
307
|
+
* @type {AlertConditionFrequencyEnum}
|
|
308
|
+
* @memberof AlertCondition
|
|
309
|
+
*/
|
|
310
|
+
frequency?: AlertConditionFrequencyEnum;
|
|
311
|
+
/**
|
|
312
|
+
* The instant of a `once` reminder (ISO 8601 date-time with offset, e.g. 2026-12-01T14:30:00Z). price_reminder
|
|
313
|
+
* @type {Date}
|
|
314
|
+
* @memberof AlertCondition
|
|
315
|
+
*/
|
|
316
|
+
at?: Date;
|
|
317
|
+
/**
|
|
318
|
+
* Day of a weekly reminder, 0 = Sunday. price_reminder
|
|
319
|
+
* @type {number}
|
|
320
|
+
* @memberof AlertCondition
|
|
321
|
+
*/
|
|
322
|
+
weekday?: number;
|
|
323
|
+
/**
|
|
324
|
+
* Several weekdays (0 = Sunday) of a daily / weekly reminder. price_reminder
|
|
325
|
+
* @type {Array<number>}
|
|
326
|
+
* @memberof AlertCondition
|
|
327
|
+
*/
|
|
328
|
+
days?: Array<number>;
|
|
221
329
|
}
|
|
222
330
|
/**
|
|
223
331
|
* @export
|
|
@@ -333,6 +441,92 @@ export declare const AlertConditionEventEnum: {
|
|
|
333
441
|
readonly DividendPayment: "dividend_payment";
|
|
334
442
|
};
|
|
335
443
|
export type AlertConditionEventEnum = typeof AlertConditionEventEnum[keyof typeof AlertConditionEventEnum] | (string & {});
|
|
444
|
+
/**
|
|
445
|
+
* @export
|
|
446
|
+
*/
|
|
447
|
+
export declare const AlertConditionAssetClassEnum: {
|
|
448
|
+
readonly UsStock: "us_stock";
|
|
449
|
+
readonly Crypto: "crypto";
|
|
450
|
+
};
|
|
451
|
+
export type AlertConditionAssetClassEnum = typeof AlertConditionAssetClassEnum[keyof typeof AlertConditionAssetClassEnum] | (string & {});
|
|
452
|
+
/**
|
|
453
|
+
* @export
|
|
454
|
+
*/
|
|
455
|
+
export declare const AlertConditionOperatorEnum: {
|
|
456
|
+
readonly CrossesAbove: "crosses_above";
|
|
457
|
+
readonly CrossesBelow: "crosses_below";
|
|
458
|
+
readonly Crosses: "crosses";
|
|
459
|
+
readonly Above: "above";
|
|
460
|
+
readonly Below: "below";
|
|
461
|
+
};
|
|
462
|
+
export type AlertConditionOperatorEnum = typeof AlertConditionOperatorEnum[keyof typeof AlertConditionOperatorEnum] | (string & {});
|
|
463
|
+
/**
|
|
464
|
+
* @export
|
|
465
|
+
*/
|
|
466
|
+
export declare const AlertConditionDirectionEnum: {
|
|
467
|
+
readonly Up: "up";
|
|
468
|
+
readonly Down: "down";
|
|
469
|
+
readonly Both: "both";
|
|
470
|
+
};
|
|
471
|
+
export type AlertConditionDirectionEnum = typeof AlertConditionDirectionEnum[keyof typeof AlertConditionDirectionEnum] | (string & {});
|
|
472
|
+
/**
|
|
473
|
+
* @export
|
|
474
|
+
*/
|
|
475
|
+
export declare const AlertConditionBaselineEnum: {
|
|
476
|
+
readonly PriorClose: "prior_close";
|
|
477
|
+
readonly IntradayOpen: "intraday_open";
|
|
478
|
+
readonly SessionHigh: "session_high";
|
|
479
|
+
readonly SessionLow: "session_low";
|
|
480
|
+
readonly GapOpen: "gap_open";
|
|
481
|
+
};
|
|
482
|
+
export type AlertConditionBaselineEnum = typeof AlertConditionBaselineEnum[keyof typeof AlertConditionBaselineEnum] | (string & {});
|
|
483
|
+
/**
|
|
484
|
+
* @export
|
|
485
|
+
*/
|
|
486
|
+
export declare const AlertConditionModeEnum: {
|
|
487
|
+
readonly Relative: "relative";
|
|
488
|
+
readonly Absolute: "absolute";
|
|
489
|
+
readonly Session: "session";
|
|
490
|
+
};
|
|
491
|
+
export type AlertConditionModeEnum = typeof AlertConditionModeEnum[keyof typeof AlertConditionModeEnum] | (string & {});
|
|
492
|
+
/**
|
|
493
|
+
* @export
|
|
494
|
+
*/
|
|
495
|
+
export declare const AlertConditionIntervalEnum: {
|
|
496
|
+
readonly _1h: "1h";
|
|
497
|
+
readonly _1d: "1d";
|
|
498
|
+
readonly _1w: "1w";
|
|
499
|
+
readonly _1mo: "1mo";
|
|
500
|
+
};
|
|
501
|
+
export type AlertConditionIntervalEnum = typeof AlertConditionIntervalEnum[keyof typeof AlertConditionIntervalEnum] | (string & {});
|
|
502
|
+
/**
|
|
503
|
+
* @export
|
|
504
|
+
*/
|
|
505
|
+
export declare const AlertConditionBaselineModeEnum: {
|
|
506
|
+
readonly FlatMean: "flat_mean";
|
|
507
|
+
readonly RvolSlot: "rvol_slot";
|
|
508
|
+
readonly Median: "median";
|
|
509
|
+
};
|
|
510
|
+
export type AlertConditionBaselineModeEnum = typeof AlertConditionBaselineModeEnum[keyof typeof AlertConditionBaselineModeEnum] | (string & {});
|
|
511
|
+
/**
|
|
512
|
+
* @export
|
|
513
|
+
*/
|
|
514
|
+
export declare const AlertConditionPriceDirectionEnum: {
|
|
515
|
+
readonly Up: "up";
|
|
516
|
+
readonly Down: "down";
|
|
517
|
+
readonly Any: "any";
|
|
518
|
+
};
|
|
519
|
+
export type AlertConditionPriceDirectionEnum = typeof AlertConditionPriceDirectionEnum[keyof typeof AlertConditionPriceDirectionEnum] | (string & {});
|
|
520
|
+
/**
|
|
521
|
+
* @export
|
|
522
|
+
*/
|
|
523
|
+
export declare const AlertConditionFrequencyEnum: {
|
|
524
|
+
readonly Once: "once";
|
|
525
|
+
readonly Hourly: "hourly";
|
|
526
|
+
readonly Daily: "daily";
|
|
527
|
+
readonly Weekly: "weekly";
|
|
528
|
+
};
|
|
529
|
+
export type AlertConditionFrequencyEnum = typeof AlertConditionFrequencyEnum[keyof typeof AlertConditionFrequencyEnum] | (string & {});
|
|
336
530
|
/**
|
|
337
531
|
* Check if a given object implements the AlertCondition interface.
|
|
338
532
|
*/
|
|
@@ -120,6 +120,83 @@ export const AlertConditionEventEnum = {
|
|
|
120
120
|
ExDividend: 'ex_dividend',
|
|
121
121
|
DividendPayment: 'dividend_payment'
|
|
122
122
|
};
|
|
123
|
+
/**
|
|
124
|
+
* @export
|
|
125
|
+
*/
|
|
126
|
+
export const AlertConditionAssetClassEnum = {
|
|
127
|
+
UsStock: 'us_stock',
|
|
128
|
+
Crypto: 'crypto'
|
|
129
|
+
};
|
|
130
|
+
/**
|
|
131
|
+
* @export
|
|
132
|
+
*/
|
|
133
|
+
export const AlertConditionOperatorEnum = {
|
|
134
|
+
CrossesAbove: 'crosses_above',
|
|
135
|
+
CrossesBelow: 'crosses_below',
|
|
136
|
+
Crosses: 'crosses',
|
|
137
|
+
Above: 'above',
|
|
138
|
+
Below: 'below'
|
|
139
|
+
};
|
|
140
|
+
/**
|
|
141
|
+
* @export
|
|
142
|
+
*/
|
|
143
|
+
export const AlertConditionDirectionEnum = {
|
|
144
|
+
Up: 'up',
|
|
145
|
+
Down: 'down',
|
|
146
|
+
Both: 'both'
|
|
147
|
+
};
|
|
148
|
+
/**
|
|
149
|
+
* @export
|
|
150
|
+
*/
|
|
151
|
+
export const AlertConditionBaselineEnum = {
|
|
152
|
+
PriorClose: 'prior_close',
|
|
153
|
+
IntradayOpen: 'intraday_open',
|
|
154
|
+
SessionHigh: 'session_high',
|
|
155
|
+
SessionLow: 'session_low',
|
|
156
|
+
GapOpen: 'gap_open'
|
|
157
|
+
};
|
|
158
|
+
/**
|
|
159
|
+
* @export
|
|
160
|
+
*/
|
|
161
|
+
export const AlertConditionModeEnum = {
|
|
162
|
+
Relative: 'relative',
|
|
163
|
+
Absolute: 'absolute',
|
|
164
|
+
Session: 'session'
|
|
165
|
+
};
|
|
166
|
+
/**
|
|
167
|
+
* @export
|
|
168
|
+
*/
|
|
169
|
+
export const AlertConditionIntervalEnum = {
|
|
170
|
+
_1h: '1h',
|
|
171
|
+
_1d: '1d',
|
|
172
|
+
_1w: '1w',
|
|
173
|
+
_1mo: '1mo'
|
|
174
|
+
};
|
|
175
|
+
/**
|
|
176
|
+
* @export
|
|
177
|
+
*/
|
|
178
|
+
export const AlertConditionBaselineModeEnum = {
|
|
179
|
+
FlatMean: 'flat_mean',
|
|
180
|
+
RvolSlot: 'rvol_slot',
|
|
181
|
+
Median: 'median'
|
|
182
|
+
};
|
|
183
|
+
/**
|
|
184
|
+
* @export
|
|
185
|
+
*/
|
|
186
|
+
export const AlertConditionPriceDirectionEnum = {
|
|
187
|
+
Up: 'up',
|
|
188
|
+
Down: 'down',
|
|
189
|
+
Any: 'any'
|
|
190
|
+
};
|
|
191
|
+
/**
|
|
192
|
+
* @export
|
|
193
|
+
*/
|
|
194
|
+
export const AlertConditionFrequencyEnum = {
|
|
195
|
+
Once: 'once',
|
|
196
|
+
Hourly: 'hourly',
|
|
197
|
+
Daily: 'daily',
|
|
198
|
+
Weekly: 'weekly'
|
|
199
|
+
};
|
|
123
200
|
/**
|
|
124
201
|
* Check if a given object implements the AlertCondition interface.
|
|
125
202
|
*/
|
|
@@ -167,6 +244,24 @@ export function AlertConditionFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
167
244
|
'time_of_day_minutes': json['time_of_day_minutes'] == null ? undefined : json['time_of_day_minutes'],
|
|
168
245
|
'timezone': json['timezone'] == null ? undefined : json['timezone'],
|
|
169
246
|
'notify_on_date_change': json['notify_on_date_change'] == null ? undefined : json['notify_on_date_change'],
|
|
247
|
+
'asset_class': json['asset_class'] == null ? undefined : json['asset_class'],
|
|
248
|
+
'operator': json['operator'] == null ? undefined : json['operator'],
|
|
249
|
+
'level': json['level'] == null ? undefined : json['level'],
|
|
250
|
+
'direction': json['direction'] == null ? undefined : json['direction'],
|
|
251
|
+
'pct': json['pct'] == null ? undefined : json['pct'],
|
|
252
|
+
'baseline': json['baseline'] == null ? undefined : json['baseline'],
|
|
253
|
+
'window_minutes': json['window_minutes'] == null ? undefined : json['window_minutes'],
|
|
254
|
+
'mode': json['mode'] == null ? undefined : json['mode'],
|
|
255
|
+
'interval': json['interval'] == null ? undefined : json['interval'],
|
|
256
|
+
'multiple': json['multiple'] == null ? undefined : json['multiple'],
|
|
257
|
+
'threshold': json['threshold'] == null ? undefined : json['threshold'],
|
|
258
|
+
'lookback_bars': json['lookback_bars'] == null ? undefined : json['lookback_bars'],
|
|
259
|
+
'baseline_mode': json['baseline_mode'] == null ? undefined : json['baseline_mode'],
|
|
260
|
+
'price_direction': json['price_direction'] == null ? undefined : json['price_direction'],
|
|
261
|
+
'frequency': json['frequency'] == null ? undefined : json['frequency'],
|
|
262
|
+
'at': json['at'] == null ? undefined : (new Date(json['at'])),
|
|
263
|
+
'weekday': json['weekday'] == null ? undefined : json['weekday'],
|
|
264
|
+
'days': json['days'] == null ? undefined : json['days'],
|
|
170
265
|
};
|
|
171
266
|
}
|
|
172
267
|
export function AlertConditionToJSON(json) {
|
|
@@ -210,5 +305,23 @@ export function AlertConditionToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
210
305
|
'time_of_day_minutes': value['time_of_day_minutes'],
|
|
211
306
|
'timezone': value['timezone'],
|
|
212
307
|
'notify_on_date_change': value['notify_on_date_change'],
|
|
308
|
+
'asset_class': value['asset_class'],
|
|
309
|
+
'operator': value['operator'],
|
|
310
|
+
'level': value['level'],
|
|
311
|
+
'direction': value['direction'],
|
|
312
|
+
'pct': value['pct'],
|
|
313
|
+
'baseline': value['baseline'],
|
|
314
|
+
'window_minutes': value['window_minutes'],
|
|
315
|
+
'mode': value['mode'],
|
|
316
|
+
'interval': value['interval'],
|
|
317
|
+
'multiple': value['multiple'],
|
|
318
|
+
'threshold': value['threshold'],
|
|
319
|
+
'lookback_bars': value['lookback_bars'],
|
|
320
|
+
'baseline_mode': value['baseline_mode'],
|
|
321
|
+
'price_direction': value['price_direction'],
|
|
322
|
+
'frequency': value['frequency'],
|
|
323
|
+
'at': value['at'] == null ? value['at'] : value['at'].toISOString(),
|
|
324
|
+
'weekday': value['weekday'],
|
|
325
|
+
'days': value['days'],
|
|
213
326
|
};
|
|
214
327
|
}
|