@ariva-mds/mds 2.59.0 → 2.61.0

package/lib/types/models/KpiData.d.ts

@@ -0,0 +1,435 @@
+/**
+ * MDS API
+ *  Please note the following definitions used throughout this API:  **Source**: A source can be any kind of marketplace (exchange) or an entity that calculates prices/values for instruments.  **Instrument**: An instrument is e.g. a stock, a bond, an index, a currency-pair, or a specific future/option contract. An instrument is identified by an InstrumentId. Some information in MDS is linked to instruments: Masterdata (names, instrument types,...), Fundamental stock data, News,...  **Listing**: An instrument can be traded/calculated on multiple sources. Some sources even support multiple listings of the same instrument, e.g. lisings in different currencies. A listing is identified by a MarketstateId. Most information in MDS is linked to listings: Marketstate (prices/quotes), Tickdata (price/quote history), Performance data,...  **Instrument** **vs** **Listing**: The Microsoft stock is an instrument identified by the InstrumentId \"US5949181045\". It is listed and traded on many exchanges. Each of these listings is identified by a unique MarketstateId, i.e. \"US5949181045@GAT\" (listing on Tradegate) or \"US5949181045,USD@SIX\" (USD-listing on SIX), or \"US5949181045,CHF@SIX\" (CHF-listing on SIX).  **Marketstate** defines the current state of an instrument listed on a source. In our case besides open, close, post and pre market also latest trade and quote information...  **MarketstateQuery**: When you request a price/quote in MDS, you have to select the listing(s) you wish to receive them for. Most API calls use a MarketstateQuery as a parameter to express a filter for one or more Marketstates. The query often takes the form of \"DE0007100000@ETR\" and can also utilize wildcards like \"*\" or \"?\". <br> See here for a full specification <a href=\"#model-MarketstateQuery\">MarketstateQuery</a>  **Timestamps**: Most events covered in MDS have a known instant they refer to. A trade on an exchange usually has an exact time when it was executed. However depending on source and context some events can refer to a whole trading day without specifying a time of day. ECB currency rates for instance are determined for the whole day. In other cases an exact time is not part of the licensed data, e.g. when looking at the end-of-day quality of some exchanges. If an exact time is known, this is transmitted in a field \"datetime\". If only a date is given the field \"date\" is used. If you see \"00:00:00.000\" in a datetime field, this actually means something happened exactly at midnight, it is not a special value indicating \\\"no date available\\\".  **SSE-NOTE**: Many endpoints support Server Sent Events (SSE) to get pushed updates. To receive SSE the client needs to request the content-type \"text/event-stream\" via the \"accept\" http request-header. <br>Unfortunately Swagger UI does not support SSE! To test SSE on an endpoint use the curl command shown in the snapshot response and modify the \"accept\" HTTP request-header as described above.  **CURL-NOTE**: When use curl use the option -i to see the response headers. If the return status is 401 then you have to reauthorize. Otherwise you do not see whether the token is expired and wondering that there is no response.
+ *
+ * The version of the OpenAPI document: 0.4.34
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Represents KPIs for an instrument.
+ * @export
+ * @interface KpiData
+ */
+export interface KpiData {
+    /**
+     * Id for the Marketstate of an Instrument that is listed on a Source. <p> Format: InstrumentId "," ListingVariant "," Source <p>InstrumentId: The InstrumentID in one of the defined formats, see  <a href="#model-InstrumentId">InstrumentId</a></p> <p>ListingVariant: Normally the listing variant is only determined by the trading currency, in that case the ListingVariant is named after the Currency (e.g. EUR). But other variant types might be possible!</p> <p>Source: The Source or Exchange. </p>
+     * <p> Any MarketstateId is also a valid MarketstateQuery.</bold></p>
+     * @type {string}
+     * @memberof KpiData
+     */
+    marketstateId?: string;
+    /**
+     * ID for one instrument, ie. a stock or an index. This will be the highest ranked available identifier for this instrument from the following list: <p>- ISIN: DE0007100000 <br>- Currency: CURRENCY(EUR/USD) <br>- EUREX-Option: EUREXO(DE000710000000,C,3000,1222) </p>
+     * @type {string}
+     * @memberof KpiData
+     */
+    instrumentId?: string;
+    /**
+     * Source
+     * @type {string}
+     * @memberof KpiData
+     */
+    sourceId?: string;
+    /**
+     * if an instrument is listed eg. in multiple currencies on one exchange then the information in this field is used to discriminate between them.
+     * @type {string}
+     * @memberof KpiData
+     */
+    currency?: string;
+    /**
+     * if an instrument is listed eg. in multiple currencies on one exchange then the information in this field is used to discriminate between them.
+     * @type {string}
+     * @memberof KpiData
+     */
+    listingVariant?: string;
+    /**
+     * KPI Source
+     * @type {string}
+     * @memberof KpiData
+     */
+    kpiSourceId?: string;
+    /**
+     * Dividend yield for the current financial year. It indicates the percentage of the dividend in relation to the share price.
+     * @type {number}
+     * @memberof KpiData
+     */
+    divYield?: number;
+    /**
+     * Average dividend yield over the last five years.
+     * @type {number}
+     * @memberof KpiData
+     */
+    divYield5?: number;
+    /**
+     * Average dividend yield over the last ten years.
+     * @type {number}
+     * @memberof KpiData
+     */
+    divYield10?: number;
+    /**
+     * Dividend yield for the current financial year. It indicates the percentage of the dividend in relation to the share price.
+     * @type {number}
+     * @memberof KpiData
+     */
+    divYieldPercentage?: number;
+    /**
+     * Year-on-year growth in dividend per share.
+     * @type {number}
+     * @memberof KpiData
+     */
+    dpsGrowthYoy?: number;
+    /**
+     * Average annual growth in dividend per share over the last five years.
+     * @type {number}
+     * @memberof KpiData
+     */
+    dpsGrowthYoy5?: number;
+    /**
+     * Average annual growth in dividend per share over the last ten years.
+     * @type {number}
+     * @memberof KpiData
+     */
+    dpsGrowthYoy10?: number;
+    /**
+     * Continuous dividend payment that the company pays or increases constantly over several years.
+     * @type {number}
+     * @memberof KpiData
+     */
+    contDivPayment?: number;
+    /**
+     * Continuous dividend growth, indicates whether the company has consistently increased its dividend over several years.
+     * @type {number}
+     * @memberof KpiData
+     */
+    contDivGrowth?: number;
+    /**
+     * Ratio of the distributed dividend to the company's net profit. It shows how much of the profit is distributed to shareholders.
+     * @type {number}
+     * @memberof KpiData
+     */
+    divPayoutRatio?: number;
+    /**
+     * The market capitalization of a company, in other words, the total value of all shares issued by a company.
+     * @type {number}
+     * @memberof KpiData
+     */
+    marketCap?: number;
+    /**
+     * The price volatility of the share over a period of one months.
+     * @type {number}
+     * @memberof KpiData
+     */
+    volatility1?: number;
+    /**
+     * The price volatility of the share over a period of three months.
+     * @type {number}
+     * @memberof KpiData
+     */
+    volatility3?: number;
+    /**
+     * The average daily trading volume of the share on the main market on which it is traded during one month.
+     * @type {number}
+     * @memberof KpiData
+     */
+    avgTradingVolume?: number;
+    /**
+     * The average daily trading volume of the share on the main market on which it is traded during three month.
+     * @type {number}
+     * @memberof KpiData
+     */
+    avgTradingVolume3m?: number;
+    /**
+     * Ratio of the current share price to earnings per share for the last quarter.
+     * @type {number}
+     * @memberof KpiData
+     */
+    priceToEarningsRatio?: number;
+    /**
+     * The price-earnings-growth ratio, which sets the price-earnings ratio in relation to earnings growth.
+     * @type {number}
+     * @memberof KpiData
+     */
+    priceToEarningsGrowthRatio?: number;
+    /**
+     * Ratio of the current share price to earnings per share for the last quarter.
+     * @type {number}
+     * @memberof KpiData
+     */
+    priceToGrowthRatio4?: number;
+    /**
+     * Ratio of the current share price to the cash flow per share for the last quarter.
+     * @type {number}
+     * @memberof KpiData
+     */
+    priceToCashFlowRatio?: number;
+    /**
+     * Shows how often a company could settle its current liabilities with available cash.
+     * @type {number}
+     * @memberof KpiData
+     */
+    cashDebtRatio?: number;
+    /**
+     * Shows the percentage of sales remaining after deducting variable production costs such as wages and raw materials.
+     * @type {number}
+     * @memberof KpiData
+     */
+    operatingMargin?: number;
+    /**
+     * Year-on-year percentage growth in EBITDA based on the last twelve months.
+     * @type {number}
+     * @memberof KpiData
+     */
+    ebitdaGrowth?: number;
+    /**
+     * Year-on-year percentage growth in earnings per share based on the last twelve months.
+     * @type {number}
+     * @memberof KpiData
+     */
+    epsGrowth?: number;
+    /**
+     * Percentage growth in free cash flow year-on-year, based on the last twelve months.
+     * @type {number}
+     * @memberof KpiData
+     */
+    freeCashFlowGrowth?: number;
+    /**
+     * Year-on-year percentage growth in gross profit based on the last twelve months.
+     * @type {number}
+     * @memberof KpiData
+     */
+    grossProfitGrowth?: number;
+    /**
+     * Year-on-year percentage growth in sales based on the last twelve months.
+     * @type {number}
+     * @memberof KpiData
+     */
+    revenueGrowth?: number;
+    /**
+     * Year-on-year percentage growth in total debt.
+     * @type {number}
+     * @memberof KpiData
+     */
+    totalDebtGrowth?: number;
+    /**
+     * Indicates what percentage of each sales revenue remains as profit before tax.
+     * @type {number}
+     * @memberof KpiData
+     */
+    pretaxMargin?: number;
+    /**
+     * Cash flow ratio, can include various metrics depending on the context (e.g. cash flow from operating activities / current liabilities).
+     * @type {number}
+     * @memberof KpiData
+     */
+    cfRatio?: number;
+    /**
+     * Free cash flow margin, shows the percentage of sales that is converted into free cash flow.
+     * @type {number}
+     * @memberof KpiData
+     */
+    fcfMargin?: number;
+    /**
+     * Return on investment, measures the efficiency with which a company uses its assets to generate profits.
+     * @type {number}
+     * @memberof KpiData
+     */
+    roa?: number;
+    /**
+     * Return on equity, measures how well a company generates returns from its shareholders' equity.
+     * @type {number}
+     * @memberof KpiData
+     */
+    roe?: number;
+    /**
+     * Return on investment, measures the efficiency of a company's investments in capital assets.
+     * @type {number}
+     * @memberof KpiData
+     */
+    roic?: number;
+    /**
+     * Ratio of research and development costs to total revenues, based on the last twelve months.
+     * @type {number}
+     * @memberof KpiData
+     */
+    rdRatio?: number;
+    /**
+     * Ratio of selling and administrative expenses to total income, based on the last twelve months.
+     * @type {number}
+     * @memberof KpiData
+     */
+    sgARatio?: number;
+    /**
+     * Percentage change in the share price over the last three months.
+     * @type {number}
+     * @memberof KpiData
+     */
+    stockPricePerformance3m?: number;
+    /**
+     * Percentage change in the share price over the last six months.
+     * @type {number}
+     * @memberof KpiData
+     */
+    stockPricePerformance6m?: number;
+    /**
+     * Percentage change in the share price over the last year.
+     * @type {number}
+     * @memberof KpiData
+     */
+    stockPricePerformance1y?: number;
+    /**
+     * Percentage change in the share price over the last three years.
+     * @type {number}
+     * @memberof KpiData
+     */
+    stockPricePerformance3y?: number;
+    /**
+     * Percentage change in market capitalization over the last six months.
+     * @type {number}
+     * @memberof KpiData
+     */
+    marketCapPerformance6m?: number;
+    /**
+     * Percentage change in market capitalization over the last year.
+     * @type {number}
+     * @memberof KpiData
+     */
+    marketCapPerformance1y?: number;
+    /**
+     * Percentage change in market capitalization over the last three years.
+     * @type {number}
+     * @memberof KpiData
+     */
+    marketCapPerformance3y?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiData
+     */
+    quickRatio?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiData
+     */
+    debtToEquityRatio?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiData
+     */
+    grossProfitMargin?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiData
+     */
+    priceToSalesRatio?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiData
+     */
+    priceToBookRatio?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiData
+     */
+    priceToFreeCashFlowRatio?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiData
+     */
+    priceToCashRatio?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiData
+     */
+    rsi?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiData
+     */
+    stochastic?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiData
+     */
+    commodityChannelIndex?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiData
+     */
+    averageDirectionalIndex?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiData
+     */
+    awesomeOscillator?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiData
+     */
+    momentum?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiData
+     */
+    macd?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiData
+     */
+    stochasticRsi?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiData
+     */
+    williamsPercentRange?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiData
+     */
+    bullsPower?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiData
+     */
+    bearsPower?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiData
+     */
+    ultimateOscillator?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiData
+     */
+    oscillatorAverage?: number;
+}
+/**
+ * Check if a given object implements the KpiData interface.
+ */
+export declare function instanceOfKpiData(value: object): boolean;
+export declare function KpiDataFromJSON(json: any): KpiData;
+export declare function KpiDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): KpiData;
+export declare function KpiDataToJSON(value?: KpiData | null): any;
+//# sourceMappingURL=KpiData.d.ts.map

package/lib/types/models/KpiData.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"KpiData.d.ts","sourceRoot":"","sources":["../../../src/models/KpiData.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH;;;;GAIG;AACH,MAAM,WAAW,OAAO;IACpB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;;;OAIG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;IACpC;;;;OAIG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;;OAIG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;;OAIG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;;OAIG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAClC;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B;;;;OAIG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAIxD;AAED,wBAAgB,eAAe,CAAC,IAAI,EAAE,GAAG,GAAG,OAAO,CAElD;AAED,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,GAAG,EAAE,mBAAmB,EAAE,OAAO,GAAG,OAAO,CA2ErF;AAED,wBAAgB,aAAa,CAAC,KAAK,CAAC,EAAE,OAAO,GAAG,IAAI,GAAG,GAAG,CA8EzD"}