@invinite-org/data-api-client 6.3.0 → 6.3.1
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/esm/models/AlertCondition.d.ts +1 -1
- package/dist/esm/models/AlertConditionInput.d.ts +1 -1
- package/dist/esm/models/Company.d.ts +6 -6
- package/dist/models/AlertCondition.d.ts +1 -1
- package/dist/models/AlertConditionInput.d.ts +1 -1
- package/dist/models/Company.d.ts +6 -6
- package/docs/AlertCondition.md +1 -1
- package/docs/AlertConditionInput.md +1 -1
- package/docs/CompaniesApi.md +4 -4
- package/docs/EventsApi.md +2 -2
- package/docs/FilingsApi.md +4 -4
- package/docs/FinancialsApi.md +12 -12
- package/docs/GuidanceApi.md +4 -4
- package/docs/HoldingsApi.md +8 -8
- package/docs/IPOsApi.md +4 -4
- package/docs/InsiderTradesApi.md +2 -2
- package/docs/InvestorDocumentsApi.md +4 -4
- package/docs/MetricsApi.md +10 -10
- package/docs/NewsApi.md +6 -6
- package/docs/ReferenceApi.md +6 -6
- package/docs/TranscriptsApi.md +2 -2
- package/package.json +1 -1
- package/src/models/AlertCondition.ts +1 -1
- package/src/models/AlertConditionInput.ts +1 -1
- package/src/models/Company.ts +6 -6
|
@@ -78,7 +78,7 @@ import {
|
|
|
78
78
|
} from './IndicatorCondition';
|
|
79
79
|
|
|
80
80
|
/**
|
|
81
|
-
* 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`)
|
|
81
|
+
* 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`, `news`, `news_keyword` and an `earnings_call` countdown refuse an ETF of either identity (its ticker or a fund registrant's CIK) by name (400 `invalid_parameter`).
|
|
82
82
|
* @export
|
|
83
83
|
* @interface AlertCondition
|
|
84
84
|
*/
|
|
@@ -71,7 +71,7 @@ import {
|
|
|
71
71
|
} from './IndicatorFiltersInput';
|
|
72
72
|
|
|
73
73
|
/**
|
|
74
|
-
* 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`)
|
|
74
|
+
* What the alert watches; the fields depend on `type` (each field names the types that take it; any other field is refused). Companies: `ciks` / `symbols` (at most 100 in all) or, for single-company types, `cik` / `symbol`. A symbol is resolved to its CIK at create. Price types (`price`, `price_move`, `volume_spike`, `price_reminder`), `script` and `indicator` watch ONE instrument: `symbol` + `asset_class`. An `indicator` alert takes a built-in `template` (`GET /v1/alert-templates`) or a structured `condition` (+ optional `filters`) on `symbol` / `interval`; alerts crossing a constant on the same indicator, instrument and interval share one evaluation whatever the threshold. Coverage: `filing_keyword`, `fundamental_metric` and `earnings_results` work only for companies whose filings and financials Invinite processes (any other company answers 404 `not_covered`); `earnings_call_keyword` takes any company with captured calls. (request form) US ETFs: `dividend`, `event_countdown` (`ex_dividend` / `dividend_payment`), `filing` and `filing_keyword` take an ETF ticker (SPY or a trust series such as TQQQ; a series ETF is stored by symbol and fires only on events that name it, never on another series' filing of its trust); `earnings_call`, `earnings_call_keyword`, `earnings_results`, `fundamental_metric`, `news`, `news_keyword` and an `earnings_call` countdown refuse an ETF of either identity (its ticker or a fund registrant's CIK) by name (400 `invalid_parameter`).
|
|
75
75
|
* @export
|
|
76
76
|
* @interface AlertConditionInput
|
|
77
77
|
*/
|
package/src/models/Company.ts
CHANGED
|
@@ -34,7 +34,7 @@ export interface Company {
|
|
|
34
34
|
*/
|
|
35
35
|
ticker: string;
|
|
36
36
|
/**
|
|
37
|
-
* CIK with or without leading zeros
|
|
37
|
+
* CIK with or without leading zeros; for a US ETF that is a series of a multi-series trust (TQQQ) the trust's CIK, empty ("") for such an ETF without a registrant link
|
|
38
38
|
* @type {string}
|
|
39
39
|
* @memberof Company
|
|
40
40
|
*/
|
|
@@ -52,7 +52,7 @@ export interface Company {
|
|
|
52
52
|
*/
|
|
53
53
|
description: string | null;
|
|
54
54
|
/**
|
|
55
|
-
* High-level category
|
|
55
|
+
* High-level category (`ETF` for a series of a multi-series trust such as TQQQ)
|
|
56
56
|
* @type {string}
|
|
57
57
|
* @memberof Company
|
|
58
58
|
*/
|
|
@@ -76,13 +76,13 @@ export interface Company {
|
|
|
76
76
|
*/
|
|
77
77
|
sic: string | null;
|
|
78
78
|
/**
|
|
79
|
-
* Fama-French sector
|
|
79
|
+
* Fama-French sector, from the issuer's SIC code; null for a US ETF (no SIC-derived values are shown for a fund)
|
|
80
80
|
* @type {string}
|
|
81
81
|
* @memberof Company
|
|
82
82
|
*/
|
|
83
83
|
fama_sector: string | null;
|
|
84
84
|
/**
|
|
85
|
-
* Fama-French industry
|
|
85
|
+
* Fama-French industry, from the issuer's SIC code; null for a US ETF (no SIC-derived values are shown for a fund)
|
|
86
86
|
* @type {string}
|
|
87
87
|
* @memberof Company
|
|
88
88
|
*/
|
|
@@ -202,7 +202,7 @@ export interface Company {
|
|
|
202
202
|
*/
|
|
203
203
|
brand_colors: Array<string> | null;
|
|
204
204
|
/**
|
|
205
|
-
* Street address
|
|
205
|
+
* Street address; null for a US ETF
|
|
206
206
|
* @type {string}
|
|
207
207
|
* @memberof Company
|
|
208
208
|
*/
|
|
@@ -220,7 +220,7 @@ export interface Company {
|
|
|
220
220
|
*/
|
|
221
221
|
state: string | null;
|
|
222
222
|
/**
|
|
223
|
-
* Postal/ZIP code
|
|
223
|
+
* Postal/ZIP code; null for a US ETF
|
|
224
224
|
* @type {string}
|
|
225
225
|
* @memberof Company
|
|
226
226
|
*/
|