@ariva-mds/mds 2.59.0 → 2.61.0

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

@@ -0,0 +1,404 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface KpiDataAllOf
+ */
+export interface KpiDataAllOf {
+    /**
+     * KPI Source
+     * @type {string}
+     * @memberof KpiDataAllOf
+     */
+    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 KpiDataAllOf
+     */
+    divYield?: number;
+    /**
+     * Average dividend yield over the last five years.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    divYield5?: number;
+    /**
+     * Average dividend yield over the last ten years.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    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 KpiDataAllOf
+     */
+    divYieldPercentage?: number;
+    /**
+     * Year-on-year growth in dividend per share.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    dpsGrowthYoy?: number;
+    /**
+     * Average annual growth in dividend per share over the last five years.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    dpsGrowthYoy5?: number;
+    /**
+     * Average annual growth in dividend per share over the last ten years.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    dpsGrowthYoy10?: number;
+    /**
+     * Continuous dividend payment that the company pays or increases constantly over several years.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    contDivPayment?: number;
+    /**
+     * Continuous dividend growth, indicates whether the company has consistently increased its dividend over several years.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    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 KpiDataAllOf
+     */
+    divPayoutRatio?: number;
+    /**
+     * The market capitalization of a company, in other words, the total value of all shares issued by a company.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    marketCap?: number;
+    /**
+     * The price volatility of the share over a period of one months.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    volatility1?: number;
+    /**
+     * The price volatility of the share over a period of three months.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    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 KpiDataAllOf
+     */
+    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 KpiDataAllOf
+     */
+    avgTradingVolume3m?: number;
+    /**
+     * Ratio of the current share price to earnings per share for the last quarter.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    priceToEarningsRatio?: number;
+    /**
+     * The price-earnings-growth ratio, which sets the price-earnings ratio in relation to earnings growth.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    priceToEarningsGrowthRatio?: number;
+    /**
+     * Ratio of the current share price to earnings per share for the last quarter.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    priceToGrowthRatio4?: number;
+    /**
+     * Ratio of the current share price to the cash flow per share for the last quarter.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    priceToCashFlowRatio?: number;
+    /**
+     * Shows how often a company could settle its current liabilities with available cash.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    cashDebtRatio?: number;
+    /**
+     * Shows the percentage of sales remaining after deducting variable production costs such as wages and raw materials.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    operatingMargin?: number;
+    /**
+     * Year-on-year percentage growth in EBITDA based on the last twelve months.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    ebitdaGrowth?: number;
+    /**
+     * Year-on-year percentage growth in earnings per share based on the last twelve months.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    epsGrowth?: number;
+    /**
+     * Percentage growth in free cash flow year-on-year, based on the last twelve months.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    freeCashFlowGrowth?: number;
+    /**
+     * Year-on-year percentage growth in gross profit based on the last twelve months.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    grossProfitGrowth?: number;
+    /**
+     * Year-on-year percentage growth in sales based on the last twelve months.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    revenueGrowth?: number;
+    /**
+     * Year-on-year percentage growth in total debt.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    totalDebtGrowth?: number;
+    /**
+     * Indicates what percentage of each sales revenue remains as profit before tax.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    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 KpiDataAllOf
+     */
+    cfRatio?: number;
+    /**
+     * Free cash flow margin, shows the percentage of sales that is converted into free cash flow.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    fcfMargin?: number;
+    /**
+     * Return on investment, measures the efficiency with which a company uses its assets to generate profits.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    roa?: number;
+    /**
+     * Return on equity, measures how well a company generates returns from its shareholders' equity.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    roe?: number;
+    /**
+     * Return on investment, measures the efficiency of a company's investments in capital assets.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    roic?: number;
+    /**
+     * Ratio of research and development costs to total revenues, based on the last twelve months.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    rdRatio?: number;
+    /**
+     * Ratio of selling and administrative expenses to total income, based on the last twelve months.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    sgARatio?: number;
+    /**
+     * Percentage change in the share price over the last three months.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    stockPricePerformance3m?: number;
+    /**
+     * Percentage change in the share price over the last six months.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    stockPricePerformance6m?: number;
+    /**
+     * Percentage change in the share price over the last year.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    stockPricePerformance1y?: number;
+    /**
+     * Percentage change in the share price over the last three years.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    stockPricePerformance3y?: number;
+    /**
+     * Percentage change in market capitalization over the last six months.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    marketCapPerformance6m?: number;
+    /**
+     * Percentage change in market capitalization over the last year.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    marketCapPerformance1y?: number;
+    /**
+     * Percentage change in market capitalization over the last three years.
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    marketCapPerformance3y?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    quickRatio?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    debtToEquityRatio?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    grossProfitMargin?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    priceToSalesRatio?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    priceToBookRatio?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    priceToFreeCashFlowRatio?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    priceToCashRatio?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    rsi?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    stochastic?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    commodityChannelIndex?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    averageDirectionalIndex?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    awesomeOscillator?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    momentum?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    macd?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    stochasticRsi?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    williamsPercentRange?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    bullsPower?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    bearsPower?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    ultimateOscillator?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof KpiDataAllOf
+     */
+    oscillatorAverage?: number;
+}
+/**
+ * Check if a given object implements the KpiDataAllOf interface.
+ */
+export declare function instanceOfKpiDataAllOf(value: object): boolean;
+export declare function KpiDataAllOfFromJSON(json: any): KpiDataAllOf;
+export declare function KpiDataAllOfFromJSONTyped(json: any, ignoreDiscriminator: boolean): KpiDataAllOf;
+export declare function KpiDataAllOfToJSON(value?: KpiDataAllOf | null): any;
+//# sourceMappingURL=KpiDataAllOf.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"KpiDataAllOf.d.ts","sourceRoot":"","sources":["../../../src/models/KpiDataAllOf.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH;;;;GAIG;AACH,MAAM,WAAW,YAAY;IACzB;;;;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,sBAAsB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAI7D;AAED,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,GAAG,GAAG,YAAY,CAE5D;AAED,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,GAAG,EAAE,mBAAmB,EAAE,OAAO,GAAG,YAAY,CAsE/F;AAED,wBAAgB,kBAAkB,CAAC,KAAK,CAAC,EAAE,YAAY,GAAG,IAAI,GAAG,GAAG,CAyEnE"}

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

@@ -0,0 +1,44 @@
+/**
+ * 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.
+ */
+/**
+ * Timeseries bid ask data for an instrument
+ * @export
+ * @interface TimeseriesBidAskData
+ */
+export interface TimeseriesBidAskData {
+    /**
+     *
+     * @type {Date}
+     * @memberof TimeseriesBidAskData
+     */
+    datetime?: Date;
+    /**
+     * Bid value
+     * @type {number}
+     * @memberof TimeseriesBidAskData
+     */
+    bid?: number;
+    /**
+     * Ask value
+     * @type {number}
+     * @memberof TimeseriesBidAskData
+     */
+    ask?: number;
+}
+/**
+ * Check if a given object implements the TimeseriesBidAskData interface.
+ */
+export declare function instanceOfTimeseriesBidAskData(value: object): boolean;
+export declare function TimeseriesBidAskDataFromJSON(json: any): TimeseriesBidAskData;
+export declare function TimeseriesBidAskDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): TimeseriesBidAskData;
+export declare function TimeseriesBidAskDataToJSON(value?: TimeseriesBidAskData | null): any;
+//# sourceMappingURL=TimeseriesBidAskData.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"TimeseriesBidAskData.d.ts","sourceRoot":"","sources":["../../../src/models/TimeseriesBidAskData.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACjC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,IAAI,CAAC;IAChB;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,wBAAgB,8BAA8B,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAIrE;AAED,wBAAgB,4BAA4B,CAAC,IAAI,EAAE,GAAG,GAAG,oBAAoB,CAE5E;AAED,wBAAgB,iCAAiC,CAAC,IAAI,EAAE,GAAG,EAAE,mBAAmB,EAAE,OAAO,GAAG,oBAAoB,CAU/G;AAED,wBAAgB,0BAA0B,CAAC,KAAK,CAAC,EAAE,oBAAoB,GAAG,IAAI,GAAG,GAAG,CAanF"}

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

@@ -51,6 +51,12 @@ export interface TimeseriesData {
      * @memberof TimeseriesData
      */
     close?: number;
+    /**
+     * Official close value
+     * @type {number}
+     * @memberof TimeseriesData
+     */
+    officialClose?: number;
     /**
      * Quantity
      * @type {number}

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

@@ -1 +1 @@
-{"version":3,"file":"TimeseriesData.d.ts","sourceRoot":"","sources":["../../../src/models/TimeseriesData.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,IAAI,CAAC;IAChB;;;;OAIG;IACH,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAI/D;AAED,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,GAAG,GAAG,cAAc,CAEhE;AAED,wBAAgB,2BAA2B,CAAC,IAAI,EAAE,GAAG,EAAE,mBAAmB,EAAE,OAAO,GAAG,cAAc,CAenG;AAED,wBAAgB,oBAAoB,CAAC,KAAK,CAAC,EAAE,cAAc,GAAG,IAAI,GAAG,GAAG,CAkBvE"}
+{"version":3,"file":"TimeseriesData.d.ts","sourceRoot":"","sources":["../../../src/models/TimeseriesData.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,IAAI,CAAC;IAChB;;;;OAIG;IACH,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAI/D;AAED,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,GAAG,GAAG,cAAc,CAEhE;AAED,wBAAgB,2BAA2B,CAAC,IAAI,EAAE,GAAG,EAAE,mBAAmB,EAAE,OAAO,GAAG,cAAc,CAgBnG;AAED,wBAAgB,oBAAoB,CAAC,KAAK,CAAC,EAAE,cAAc,GAAG,IAAI,GAAG,GAAG,CAmBvE"}

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

@@ -0,0 +1,56 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface WebSocketCommandGetKpi
+ */
+export interface WebSocketCommandGetKpi {
+    /**
+     * 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 WebSocketCommandGetKpi
+     */
+    instrumentId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WebSocketCommandGetKpi
+     */
+    sourceId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WebSocketCommandGetKpi
+     */
+    kpiSourceId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WebSocketCommandGetKpi
+     */
+    listingVariant?: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof WebSocketCommandGetKpi
+     */
+    kpis?: Array<string>;
+}
+/**
+ * Check if a given object implements the WebSocketCommandGetKpi interface.
+ */
+export declare function instanceOfWebSocketCommandGetKpi(value: object): boolean;
+export declare function WebSocketCommandGetKpiFromJSON(json: any): WebSocketCommandGetKpi;
+export declare function WebSocketCommandGetKpiFromJSONTyped(json: any, ignoreDiscriminator: boolean): WebSocketCommandGetKpi;
+export declare function WebSocketCommandGetKpiToJSON(value?: WebSocketCommandGetKpi | null): any;
+//# sourceMappingURL=WebSocketCommandGetKpi.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"WebSocketCommandGetKpi.d.ts","sourceRoot":"","sources":["../../../src/models/WebSocketCommandGetKpi.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,IAAI,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACxB;AAED;;GAEG;AACH,wBAAgB,gCAAgC,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAIvE;AAED,wBAAgB,8BAA8B,CAAC,IAAI,EAAE,GAAG,GAAG,sBAAsB,CAEhF;AAED,wBAAgB,mCAAmC,CAAC,IAAI,EAAE,GAAG,EAAE,mBAAmB,EAAE,OAAO,GAAG,sBAAsB,CAYnH;AAED,wBAAgB,4BAA4B,CAAC,KAAK,CAAC,EAAE,sBAAsB,GAAG,IAAI,GAAG,GAAG,CAevF"}

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

@@ -28,4 +28,11 @@ export interface WebSocketCommandGetTradingtimeAnalysis {
      */
     date?: Date;
 }
+/**
+ * Check if a given object implements the WebSocketCommandGetTradingtimeAnalysis interface.
+ */
+export declare function instanceOfWebSocketCommandGetTradingtimeAnalysis(value: object): boolean;
+export declare function WebSocketCommandGetTradingtimeAnalysisFromJSON(json: any): WebSocketCommandGetTradingtimeAnalysis;
+export declare function WebSocketCommandGetTradingtimeAnalysisFromJSONTyped(json: any, ignoreDiscriminator: boolean): WebSocketCommandGetTradingtimeAnalysis;
+export declare function WebSocketCommandGetTradingtimeAnalysisToJSON(value?: WebSocketCommandGetTradingtimeAnalysis | null): any;
 //# sourceMappingURL=WebSocketCommandGetTradingtimeAnalysis.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"WebSocketCommandGetTradingtimeAnalysis.d.ts","sourceRoot":"","sources":["../../../src/models/WebSocketCommandGetTradingtimeAnalysis.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAEH;;;;GAIG;AACH,MAAM,WAAW,sCAAsC;IACnD;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,IAAI,CAAC,EAAE,IAAI,CAAC;CACf"}
+{"version":3,"file":"WebSocketCommandGetTradingtimeAnalysis.d.ts","sourceRoot":"","sources":["../../../src/models/WebSocketCommandGetTradingtimeAnalysis.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH;;;;GAIG;AACH,MAAM,WAAW,sCAAsC;IACnD;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,IAAI,CAAC,EAAE,IAAI,CAAC;CACf;AAED;;GAEG;AACH,wBAAgB,gDAAgD,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAIvF;AAED,wBAAgB,8CAA8C,CAAC,IAAI,EAAE,GAAG,GAAG,sCAAsC,CAEhH;AAED,wBAAgB,mDAAmD,CAAC,IAAI,EAAE,GAAG,EAAE,mBAAmB,EAAE,OAAO,GAAG,sCAAsC,CASnJ;AAED,wBAAgB,4CAA4C,CAAC,KAAK,CAAC,EAAE,sCAAsC,GAAG,IAAI,GAAG,GAAG,CAYvH"}

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

@@ -0,0 +1,59 @@
+/**
+ * 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.
+ */
+import type { Quality } from './Quality';
+import type { Resolution } from './Resolution';
+/**
+ *
+ * @export
+ * @interface WebSocketCommandListTimeseriesBidAsk
+ */
+export interface WebSocketCommandListTimeseriesBidAsk {
+    /**
+     * 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 WebSocketCommandListTimeseriesBidAsk
+     */
+    marketstateId?: string;
+    /**
+     *
+     * @type {Quality}
+     * @memberof WebSocketCommandListTimeseriesBidAsk
+     */
+    quality?: Quality;
+    /**
+     *
+     * @type {string}
+     * @memberof WebSocketCommandListTimeseriesBidAsk
+     */
+    start?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof WebSocketCommandListTimeseriesBidAsk
+     */
+    end?: string;
+    /**
+     *
+     * @type {Resolution}
+     * @memberof WebSocketCommandListTimeseriesBidAsk
+     */
+    resolution?: Resolution;
+}
+/**
+ * Check if a given object implements the WebSocketCommandListTimeseriesBidAsk interface.
+ */
+export declare function instanceOfWebSocketCommandListTimeseriesBidAsk(value: object): boolean;
+export declare function WebSocketCommandListTimeseriesBidAskFromJSON(json: any): WebSocketCommandListTimeseriesBidAsk;
+export declare function WebSocketCommandListTimeseriesBidAskFromJSONTyped(json: any, ignoreDiscriminator: boolean): WebSocketCommandListTimeseriesBidAsk;
+export declare function WebSocketCommandListTimeseriesBidAskToJSON(value?: WebSocketCommandListTimeseriesBidAsk | null): any;
+//# sourceMappingURL=WebSocketCommandListTimeseriesBidAsk.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"WebSocketCommandListTimeseriesBidAsk.d.ts","sourceRoot":"","sources":["../../../src/models/WebSocketCommandListTimeseriesBidAsk.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AAGH,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAMzC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAO/C;;;;GAIG;AACH,MAAM,WAAW,oCAAoC;IACjD;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;CAC3B;AAED;;GAEG;AACH,wBAAgB,8CAA8C,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAIrF;AAED,wBAAgB,4CAA4C,CAAC,IAAI,EAAE,GAAG,GAAG,oCAAoC,CAE5G;AAED,wBAAgB,iDAAiD,CAAC,IAAI,EAAE,GAAG,EAAE,mBAAmB,EAAE,OAAO,GAAG,oCAAoC,CAY/I;AAED,wBAAgB,0CAA0C,CAAC,KAAK,CAAC,EAAE,oCAAoC,GAAG,IAAI,GAAG,GAAG,CAenH"}