@ariva-mds/mds
Version:
Stock market data
503 lines • 14.3 kB
TypeScript
/**
* 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 { FiscalYearValue } from './FiscalYearValue';
import type { MovingAverage } from './MovingAverage';
import type { Oscillator } from './Oscillator';
/**
*
* @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
*/
divYield5Y?: number;
/**
* Average dividend yield over the last ten years.
* @type {number}
* @memberof KpiDataAllOf
*/
divYield10Y?: number;
/**
*
* @type {FiscalYearValue}
* @memberof KpiDataAllOf
*/
dpsGrowth?: FiscalYearValue;
/**
*
* @type {FiscalYearValue}
* @memberof KpiDataAllOf
*/
dpsGrowth5Y?: FiscalYearValue;
/**
*
* @type {FiscalYearValue}
* @memberof KpiDataAllOf
*/
dpsGrowth10Y?: FiscalYearValue;
/**
*
* @type {FiscalYearValue}
* @memberof KpiDataAllOf
*/
contDivPayment?: FiscalYearValue;
/**
*
* @type {FiscalYearValue}
* @memberof KpiDataAllOf
*/
contDivGrowth?: FiscalYearValue;
/**
*
* @type {FiscalYearValue}
* @memberof KpiDataAllOf
*/
divPayoutRatio?: FiscalYearValue;
/**
* 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
*/
volatility1MO?: number;
/**
* The price volatility of the share over a period of three months.
* @type {number}
* @memberof KpiDataAllOf
*/
volatility3MO?: number;
/**
* The price volatility of the share over a period of one year.
* @type {number}
* @memberof KpiDataAllOf
*/
volatility1Y?: 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
*/
avgTradingVolume1MO?: 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
*/
avgTradingVolume3MO?: number;
/**
*
* @type {FiscalYearValue}
* @memberof KpiDataAllOf
*/
priceToEarningsRatio?: FiscalYearValue;
/**
*
* @type {FiscalYearValue}
* @memberof KpiDataAllOf
*/
priceToEarningsGrowthRatio?: FiscalYearValue;
/**
*
* @type {FiscalYearValue}
* @memberof KpiDataAllOf
*/
priceToCashFlowRatio?: FiscalYearValue;
/**
*
* @type {FiscalYearValue}
* @memberof KpiDataAllOf
*/
cashDebtRatio?: FiscalYearValue;
/**
*
* @type {FiscalYearValue}
* @memberof KpiDataAllOf
*/
operatingMargin?: FiscalYearValue;
/**
*
* @type {FiscalYearValue}
* @memberof KpiDataAllOf
*/
ebitdaGrowth?: FiscalYearValue;
/**
*
* @type {FiscalYearValue}
* @memberof KpiDataAllOf
*/
epsGrowth?: FiscalYearValue;
/**
*
* @type {FiscalYearValue}
* @memberof KpiDataAllOf
*/
freeCashFlowGrowth?: FiscalYearValue;
/**
*
* @type {FiscalYearValue}
* @memberof KpiDataAllOf
*/
grossProfitGrowth?: FiscalYearValue;
/**
*
* @type {FiscalYearValue}
* @memberof KpiDataAllOf
*/
revenueGrowth?: FiscalYearValue;
/**
*
* @type {FiscalYearValue}
* @memberof KpiDataAllOf
*/
totalDebtGrowth?: FiscalYearValue;
/**
*
* @type {FiscalYearValue}
* @memberof KpiDataAllOf
*/
pretaxMargin?: FiscalYearValue;
/**
*
* @type {FiscalYearValue}
* @memberof KpiDataAllOf
*/
cfRatio?: FiscalYearValue;
/**
*
* @type {FiscalYearValue}
* @memberof KpiDataAllOf
*/
fcfMargin?: FiscalYearValue;
/**
*
* @type {FiscalYearValue}
* @memberof KpiDataAllOf
*/
roa?: FiscalYearValue;
/**
*
* @type {FiscalYearValue}
* @memberof KpiDataAllOf
*/
roe?: FiscalYearValue;
/**
*
* @type {FiscalYearValue}
* @memberof KpiDataAllOf
*/
roic?: FiscalYearValue;
/**
*
* @type {FiscalYearValue}
* @memberof KpiDataAllOf
*/
rdRatio?: FiscalYearValue;
/**
*
* @type {FiscalYearValue}
* @memberof KpiDataAllOf
*/
sgARatio?: FiscalYearValue;
/**
* Percentage change in the share price over the last three months.
* @type {number}
* @memberof KpiDataAllOf
*/
stockPricePerformance3MO?: number;
/**
* Percentage change in the share price over the last six months.
* @type {number}
* @memberof KpiDataAllOf
*/
stockPricePerformance6MO?: 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
*/
marketCapPerformance6MO?: 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 {FiscalYearValue}
* @memberof KpiDataAllOf
*/
quickRatio?: FiscalYearValue;
/**
*
* @type {FiscalYearValue}
* @memberof KpiDataAllOf
*/
debtToEquityRatio?: FiscalYearValue;
/**
*
* @type {FiscalYearValue}
* @memberof KpiDataAllOf
*/
grossProfitMargin?: FiscalYearValue;
/**
*
* @type {FiscalYearValue}
* @memberof KpiDataAllOf
*/
priceToSalesRatio?: FiscalYearValue;
/**
*
* @type {FiscalYearValue}
* @memberof KpiDataAllOf
*/
priceToBookRatio?: FiscalYearValue;
/**
*
* @type {FiscalYearValue}
* @memberof KpiDataAllOf
*/
priceToFreeCashFlowRatio?: FiscalYearValue;
/**
*
* @type {FiscalYearValue}
* @memberof KpiDataAllOf
*/
priceToCashRatio?: FiscalYearValue;
/**
*
* @type {Oscillator}
* @memberof KpiDataAllOf
*/
rsi?: Oscillator;
/**
*
* @type {Oscillator}
* @memberof KpiDataAllOf
*/
stochastic?: Oscillator;
/**
*
* @type {Oscillator}
* @memberof KpiDataAllOf
*/
commodityChannelIndex?: Oscillator;
/**
*
* @type {number}
* @memberof KpiDataAllOf
*/
averageDirectionalIndex?: number;
/**
*
* @type {number}
* @memberof KpiDataAllOf
*/
awesomeOscillator?: number;
/**
*
* @type {number}
* @memberof KpiDataAllOf
*/
momentum?: number;
/**
*
* @type {Oscillator}
* @memberof KpiDataAllOf
*/
macd?: Oscillator;
/**
*
* @type {number}
* @memberof KpiDataAllOf
*/
macdSignal?: number;
/**
*
* @type {Oscillator}
* @memberof KpiDataAllOf
*/
stochasticRsi?: Oscillator;
/**
*
* @type {Oscillator}
* @memberof KpiDataAllOf
*/
williamsPercentRange?: Oscillator;
/**
*
* @type {number}
* @memberof KpiDataAllOf
*/
bullsPower?: number;
/**
*
* @type {number}
* @memberof KpiDataAllOf
*/
bearsPower?: number;
/**
*
* @type {Oscillator}
* @memberof KpiDataAllOf
*/
bullsBearsPower?: Oscillator;
/**
*
* @type {Oscillator}
* @memberof KpiDataAllOf
*/
ultimateOscillator?: Oscillator;
/**
*
* @type {Oscillator}
* @memberof KpiDataAllOf
*/
oscillatorAverage?: Oscillator;
/**
*
* @type {MovingAverage}
* @memberof KpiDataAllOf
*/
ma5?: MovingAverage;
/**
*
* @type {MovingAverage}
* @memberof KpiDataAllOf
*/
ma10?: MovingAverage;
/**
*
* @type {MovingAverage}
* @memberof KpiDataAllOf
*/
ma20?: MovingAverage;
/**
*
* @type {MovingAverage}
* @memberof KpiDataAllOf
*/
ma50?: MovingAverage;
/**
*
* @type {MovingAverage}
* @memberof KpiDataAllOf
*/
ma100?: MovingAverage;
/**
*
* @type {MovingAverage}
* @memberof KpiDataAllOf
*/
ma200?: MovingAverage;
/**
*
* @type {Oscillator}
* @memberof KpiDataAllOf
*/
tripleMovingAverageCrossover?: Oscillator;
/**
*
* @type {Oscillator}
* @memberof KpiDataAllOf
*/
longTermMovingAverageCrossover?: Oscillator;
/**
*
* @type {Oscillator}
* @memberof KpiDataAllOf
*/
allMovingAveragesRating?: Oscillator;
/**
*
* @type {number}
* @memberof KpiDataAllOf
*/
tenkanSen?: number;
/**
*
* @type {number}
* @memberof KpiDataAllOf
*/
kijunSen?: number;
/**
*
* @type {number}
* @memberof KpiDataAllOf
*/
senkouSpanA?: number;
/**
*
* @type {number}
* @memberof KpiDataAllOf
*/
senkouSpanB?: number;
/**
*
* @type {number}
* @memberof KpiDataAllOf
*/
chikouSpan?: number;
/**
*
* @type {Oscillator}
* @memberof KpiDataAllOf
*/
ichimokuInterpretation?: Oscillator;
}
/**
* 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