openapi: 3.0.3 info: title: Factset Analytics Datastore About Key API description: Allow clients to fetch precalculated Analytics through predeterministic URLs. contact: name: FactSet Research Systems url: https://developer.factset.com/contact email: api@factset.com license: name: Apache License, Version 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 version: 1.0.0 servers: - url: https://api.factset.com description: Production - url: https://api-sandbox.factset.com description: Sandbox security: - basicAuth: [] tags: - name: Key paths: /debtInstrument/keyFigures/notation/get: get: tags: - Key operationId: get/debtInstrument/keyFigures/notation/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset Key Figures of a Debt Instrument. description: Key figures of a debt instrument. The key figures are calculated using delayed prices with an additional delay of 10 minutes after an update of the debt instrument's price. Special product features such as the right to a maturity extension, an attached option, or convertibility are not considered for the key figure calculation. Further, a calculation is not performed for perpetual products and for products with variable interest rate. parameters: - name: id in: query schema: type: string format: id64 x-positive: true description: Identifier of a notation. required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetDebtInstrumentKeyFiguresNotationGet200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/coupon/keyData/get: get: tags: - Key operationId: get/instrument/coupon/keyData/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset Interest Rate Details for Selected Periods of an Interest-bearing Instrument. description: Interest rate details for selected periods of an interest-bearing instrument; any other instrument yields empty values. parameters: - name: identifier in: query schema: type: string pattern: ^[B-DF-HJ-NP-TV-Z0-9]{6}-[SLR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$|^[B-DF-HJ-NP-TV-Z0-9]{6}[0-9]$|^[A-Z]{2}[A-Z0-9]{9}[0-9]$|^[A-Z1-9][A-Z0-9]{5}$|^[0-9]{1,9}$|^[A-Z0-9]{8}[0-9]$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of an instrument. - MDG identifier of a listing. - FactSet Permanent Identifier on security level. - FactSet Permanent Identifier on listing level. - Regional FactSet Permanent Identifier. - FactSet market symbol of a listing. - Regional FactSet ticker symbol. - SEDOL or IDII of a listing. - ISIN of an instrument. - WKN of an instrument. - Valor number of an instrument. - CUSIP or CINS identifier of an instrument enum: - idInstrument - idNotation - fdsPermanentIdentifierSecurity - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional - tickerExchange - tickerRegion - sedol - isin - wkn - valor - cusip required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. - name: _language in: query schema: type: string format: isoLanguage description: ISO 639-1 code of the language. maxLength: 2 minLength: 2 exclusiveMinimum: false exclusiveMaximum: false responses: '200': $ref: '#/components/responses/GetInstrumentCouponKeyDataGet200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/keyFigures/year/10/get: get: tags: - Key operationId: get/notation/keyFigures/year/10/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (eod) Key Figures for the Time Range of Ten Years. description: End-of-day (EOD) key figures for the time range of ten years. parameters: - name: identifier in: query schema: type: string pattern: ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresYear10Get200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/keyFigures/year/10/list: get: tags: - Key operationId: get/notation/keyFigures/year/10/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (eod) Key Figures for the Time Range of Ten Years, for a List of Notations. description: End-of-day (EOD) key figures for the time range of ten years, for a list of notations. parameters: - name: identifiers in: query schema: description: Set of identifiers to resolve. type: array nullable: false items: type: string minLength: 3 exclusiveMinimum: false maxLength: 50 exclusiveMaximum: false pattern: ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ uniqueItems: true minItems: 1 maxItems: 100 required: true style: form explode: false - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresYear10List200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/keyFigures/month/1/get: get: tags: - Key operationId: get/notation/keyFigures/month/1/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (eod) Key Figures for the Time Range of One Month. description: End-of-day (EOD) key figures for the time range of one month. parameters: - name: identifier in: query schema: type: string pattern: ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresMonth1Get200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/keyFigures/month/1/list: get: tags: - Key operationId: get/notation/keyFigures/month/1/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (eod) Key Figures for the Time Range of One Month, for a List of Notations. description: End-of-day (EOD) key figures for the time range of one month, for a list of notations. parameters: - name: identifiers in: query schema: description: Set of identifiers to resolve. type: array nullable: false items: type: string minLength: 3 exclusiveMinimum: false maxLength: 50 exclusiveMaximum: false pattern: ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ uniqueItems: true minItems: 1 maxItems: 100 required: true style: form explode: false - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresMonth1List200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/keyFigures/week/1/get: get: tags: - Key operationId: get/notation/keyFigures/week/1/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (eod) Key Figures for the Time Range of One Week. description: End-of-day (EOD) key figures for the time range of one week. parameters: - name: identifier in: query schema: type: string pattern: ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresWeek1Get200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/keyFigures/week/1/list: get: tags: - Key operationId: get/notation/keyFigures/week/1/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (eod) Key Figures for the Time Range of One Week, for a List of Notations. description: End-of-day (EOD) key figures for the time range of one week, for a list of notations. parameters: - name: identifiers in: query schema: description: Set of identifiers to resolve. type: array nullable: false items: type: string minLength: 3 exclusiveMinimum: false maxLength: 50 exclusiveMaximum: false pattern: ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ uniqueItems: true minItems: 1 maxItems: 100 required: true style: form explode: false - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresWeek1List200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/keyFigures/year/1/get: get: tags: - Key operationId: get/notation/keyFigures/year/1/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (eod) Key Figures for the Time Range of One Year. description: End-of-day (EOD) key figures for the time range of one year. parameters: - name: identifier in: query schema: type: string pattern: ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresYear1Get200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/keyFigures/year/1/list: get: tags: - Key operationId: get/notation/keyFigures/year/1/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (eod) Key Figures for the Time Range of One Year, for a List of Notations. description: End-of-day (EOD) key figures for the time range of one year, for a list of notations. parameters: - name: identifiers in: query schema: description: Set of identifiers to resolve. type: array nullable: false items: type: string minLength: 3 exclusiveMinimum: false maxLength: 50 exclusiveMaximum: false pattern: ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ uniqueItems: true minItems: 1 maxItems: 100 required: true style: form explode: false - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresYear1List200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/keyFigures/month/3/get: get: tags: - Key operationId: get/notation/keyFigures/month/3/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (eod) Key Figures for the Time Range of Three Months. description: End-of-day (EOD) key figures for the time range of three months. parameters: - name: identifier in: query schema: type: string pattern: ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresMonth3Get200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/keyFigures/month/3/list: get: tags: - Key operationId: get/notation/keyFigures/month/3/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (eod) Key Figures for the Time Range of Three Months, for a List of Notations. description: End-of-day (EOD) key figures for the time range of three months, for a list of notations. parameters: - name: identifiers in: query schema: description: Set of identifiers to resolve. type: array nullable: false items: type: string minLength: 3 exclusiveMinimum: false maxLength: 50 exclusiveMaximum: false pattern: ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ uniqueItems: true minItems: 1 maxItems: 100 required: true style: form explode: false - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresMonth3List200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/keyFigures/year/3/get: get: tags: - Key operationId: get/notation/keyFigures/year/3/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (eod) Key Figures for the Time Range of Three Years. description: End-of-day (EOD) key figures for the time range of three years. parameters: - name: identifier in: query schema: type: string pattern: ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresYear3Get200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/keyFigures/year/3/list: get: tags: - Key operationId: get/notation/keyFigures/year/3/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (eod) Key Figures for the Time Range of Three Years, for a List of Notations. description: End-of-day (EOD) key figures for the time range of three years, for a list of notations. parameters: - name: identifiers in: query schema: description: Set of identifiers to resolve. type: array nullable: false items: type: string minLength: 3 exclusiveMinimum: false maxLength: 50 exclusiveMaximum: false pattern: ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ uniqueItems: true minItems: 1 maxItems: 100 required: true style: form explode: false - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresYear3List200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/keyFigures/year/5/get: get: tags: - Key operationId: get/notation/keyFigures/year/5/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (eod) Key Figures for the Time Range of Five Years. description: End-of-day (EOD) key figures for the time range of five years. parameters: - name: identifier in: query schema: type: string pattern: ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresYear5Get200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/keyFigures/year/5/list: get: tags: - Key operationId: get/notation/keyFigures/year/5/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (eod) Key Figures for the Time Range of Five Years, for a List of Notations. description: End-of-day (EOD) key figures for the time range of five years, for a list of notations. parameters: - name: identifiers in: query schema: description: Set of identifiers to resolve. type: array nullable: false items: type: string minLength: 3 exclusiveMinimum: false maxLength: 50 exclusiveMaximum: false pattern: ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ uniqueItems: true minItems: 1 maxItems: 100 required: true style: form explode: false - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresYear5List200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/keyFigures/month/6/get: get: tags: - Key operationId: get/notation/keyFigures/month/6/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (eod) Key Figures for the Time Range of Six Months. description: End-of-day (EOD) key figures for the time range of six months. parameters: - name: identifier in: query schema: type: string pattern: ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresMonth6Get200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/keyFigures/month/6/list: get: tags: - Key operationId: get/notation/keyFigures/month/6/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (eod) Key Figures for the Time Range of Six Months, for a List of Notations. description: End-of-day (EOD) key figures for the time range of six months, for a list of notations. parameters: - name: identifiers in: query schema: description: Set of identifiers to resolve. type: array nullable: false items: type: string minLength: 3 exclusiveMinimum: false maxLength: 50 exclusiveMaximum: false pattern: ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ uniqueItems: true minItems: 1 maxItems: 100 required: true style: form explode: false - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresMonth6List200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/keyFigures/year/7/get: get: tags: - Key operationId: get/notation/keyFigures/year/7/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (eod) Key Figures for the Time Range of Seven Years. description: End-of-day (EOD) key figures for the time range of seven years. parameters: - name: identifier in: query schema: type: string pattern: ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresYear7Get200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/keyFigures/year/7/list: get: tags: - Key operationId: get/notation/keyFigures/year/7/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (eod) Key Figures for the Time Range of Seven Years, for a List of Notations. description: End-of-day (EOD) key figures for the time range of seven years, for a list of notations. parameters: - name: identifiers in: query schema: description: Set of identifiers to resolve. type: array nullable: false items: type: string minLength: 3 exclusiveMinimum: false maxLength: 50 exclusiveMaximum: false pattern: ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ uniqueItems: true minItems: 1 maxItems: 100 required: true style: form explode: false - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresYear7List200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/keyFigures/yearToDate/get: get: tags: - Key operationId: get/notation/keyFigures/yearToDate/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (eod) Key Figures for the Time Range Year-to-date (ytd).. description: End-of-day (EOD) key figures for the time range year-to-date (YTD). The time range YTD begins with the last trading day of the previous calendar year for which EOD prices are available and ends with the most recent trading day of the current calendar year for which EOD prices are available.. parameters: - name: identifier in: query schema: type: string pattern: ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresYearToDateGet200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/keyFigures/yearToDate/list: get: tags: - Key operationId: get/notation/keyFigures/yearToDate/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (eod) Key Figures for the Time Range Year-to-date (ytd), for a List of Notations.. description: End-of-day (EOD) key figures for the time range year-to-date (YTD), for a list of notations. The time range YTD begins with the last trading day of the previous calendar year for which EOD prices are available and ends with the most recent tradingday of the current calendar year for which EOD prices are available.. parameters: - name: identifiers in: query schema: description: Set of identifiers to resolve. type: array nullable: false items: type: string minLength: 3 exclusiveMinimum: false maxLength: 50 exclusiveMaximum: false pattern: ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ uniqueItems: true minItems: 1 maxItems: 100 required: true style: form explode: false - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresYearToDateList200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/keyFigures/tradingDay/average/get: get: tags: - Key operationId: get/notation/keyFigures/tradingDay/average/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: Average end-of-day (EOD) key figures for different trading days periods. A trading day is a calendar day on that trading of the notation was possible. summary: Factset Average End-of-day (eod) Key Figures for Different Trading Days Periods. parameters: - name: identifier in: query schema: type: string pattern: ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresTradingDayAverageGet200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK components: responses: GetNotationKeyFiguresYear1List200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: EOD key figures for a list of notations. nullable: false items: type: object nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - averagePrice - tradingVolume - tradingValue - volatility - status properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. averagePrice: nullable: true type: number format: real description: Arithmetic mean of the notation's EOD closing prices for the given time range. tradingVolume: nullable: false type: object x-property-sort: - average - sum description: Average and total trading volume for the given time range. properties: average: nullable: true type: number format: real description: Arithmetic mean of the daily trading volumes. sum: nullable: true type: number format: real description: Sum of the daily trading volumes. tradingValue: nullable: true type: number format: real description: Sum of the cash flow for all transactions of one notation over a certain time range. The cash flow of a transaction is its volume multiplied by its trade price. volatility: nullable: true type: number format: real description: Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. status: nullable: false type: object x-property-sort: - code - identifier - details - encryptedDetails description: Error status for the requested identifier. properties: code: nullable: true type: string description: Code of the error condition. x-enum-description: - No error. - The provided identifier does not refer to a valid notation. - Not entitled to see data for the notation. - Unable to resolve the provided identifier. enum: - none - parameter - entitlement - identifierMapping identifier: nullable: true type: string format: id64 x-positive: true description: Provided identifier. details: nullable: true type: string description: A human-readable, unstructured explanation specific to this occurrence of the problem. encryptedDetails: nullable: true type: string description: Base64-encoded internal details about the error. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresYearToDateList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: EOD key figures for a list of notations. nullable: false items: type: object nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - volatility - status properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. volatility: nullable: true type: number format: real description: Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. status: nullable: false type: object x-property-sort: - code - identifier - details - encryptedDetails description: Error status for the requested identifier. properties: code: nullable: true type: string description: Code of the error condition. x-enum-description: - No error. - The provided identifier does not refer to a valid notation. - Not entitled to see data for the notation. - Unable to resolve the provided identifier. enum: - none - parameter - entitlement - identifierMapping identifier: nullable: true type: string format: id64 x-positive: true description: Provided identifier. details: nullable: true type: string description: A human-readable, unstructured explanation specific to this occurrence of the problem. encryptedDetails: nullable: true type: string description: Base64-encoded internal details about the error. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresWeek1Get200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. averagePrice: nullable: true type: number format: real description: Arithmetic mean of the notation's EOD closing prices for the given time range. tradingVolume: nullable: false type: object x-property-sort: - average - sum description: Average and total trading volume for the given time range. properties: average: nullable: true type: number format: real description: Arithmetic mean of the daily trading volumes. sum: nullable: true type: number format: real description: Sum of the daily trading volumes. tradingValue: nullable: true type: number format: real description: Sum of the cash flow for all transactions of one notation over a certain time range. The cash flow of a transaction is its volume multiplied by its trade price. volatility: nullable: true type: number format: real description: Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - averagePrice - tradingVolume - tradingValue - volatility description: EOD key figures. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetInstrumentCouponKeyDataGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idInstrument: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the instrument. sourceIdentifier: nullable: true type: string description: Identifier used in the request. occurrence: nullable: false type: object x-property-sort: - type - frequency description: Occurrence and frequency of the coupon payments. properties: type: nullable: true type: string description: Occurrence type of the coupon payments. x-enum-description: - The instrument does not pay out a coupon. - The instrument pays out a coupon only once. - The instrument pays out a coupon on a repeated basis. enum: - never - once - repeated frequency: nullable: false type: object x-property-sort: - id - name description: Frequency of the coupon payments. Information about the frequency is available only if the attribute occurrence.type is set to "repeated". See endpoint `/basic/frequency/type/list` for possible values of the frequency. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the frequency. name: nullable: true type: string format: localizedString description: Name of the frequency. interestRate: nullable: false type: object x-property-sort: - initial - current - final description: Interest rate details for selected coupon periods. properties: initial: nullable: false type: object x-property-sort: - value - startAccrual - periodEnd description: Details of the first coupon period. properties: value: nullable: true type: number format: relativeValue description: Value of the interest rate. startAccrual: nullable: true type: string format: date description: Date as of which interest starts accruing. periodEnd: nullable: true type: string format: date description: Ending date (inclusive). current: nullable: false type: object x-property-sort: - value - type - accruedInterest - periodEnd description: Details of the current coupon period. properties: value: nullable: true type: number format: relativeValue description: Value of the interest rate. type: nullable: false type: object x-property-sort: - id - name description: Type of the interest rate, see endpoint `/instrument/coupon/interestRate/type/list` for possible values. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the interest rate type. name: nullable: true type: string format: localizedString description: Name of the interest rate type. accruedInterest: nullable: false type: object x-property-sort: - absolute - relative description: Accrued interest, i.e. interest earned but not yet received (realized). The interest starts accruing at the beginning of a coupon period and reaches the declared value (see attribute `interestRate.current.value`) for that period at its end. For the start and end date of a coupon period see endpoint `/instrument/coupon/list`, attribute `coupons.period`. properties: absolute: nullable: true type: number format: real description: Monetary value of the accrued interest. The attribute is available only for instruments with a declared nominal value, e.g. securitized derivatives. relative: nullable: true type: number format: relativeValue description: Accrued interest. periodEnd: nullable: true type: string format: date description: Ending date (inclusive). final: nullable: false type: object x-property-sort: - periodEnd description: Details of the final coupon period. properties: periodEnd: nullable: true type: string format: date description: Ending date (inclusive). dayCountConvention: nullable: false type: object x-property-sort: - id - name description: Day count convention type. See endpoint `/instrument/coupon/dayCountConvention/type/list` for possible values. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the day count convention type. name: nullable: true type: string format: localizedString description: Name of the day count convention type. description: Key dates and details. nullable: false x-property-sort: - idInstrument - sourceIdentifier - occurrence - interestRate - dayCountConvention meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresYear5List200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: EOD key figures for a list of notations. nullable: false items: type: object nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - tradingVolume - volatility - status properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. tradingVolume: nullable: true type: number format: real description: Sum of the trading volume of a notation in number of shares for the time-range between the date of the most recent end-of-day (EOD) closing price (inclusive) and the reference date (exclusive). volatility: nullable: true type: number format: real description: Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. status: nullable: false type: object x-property-sort: - code - identifier - details - encryptedDetails description: Error status for the requested identifier. properties: code: nullable: true type: string description: Code of the error condition. x-enum-description: - No error. - The provided identifier does not refer to a valid notation. - Not entitled to see data for the notation. - Unable to resolve the provided identifier. enum: - none - parameter - entitlement - identifierMapping identifier: nullable: true type: string format: id64 x-positive: true description: Provided identifier. details: nullable: true type: string description: A human-readable, unstructured explanation specific to this occurrence of the problem. encryptedDetails: nullable: true type: string description: Base64-encoded internal details about the error. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresMonth3List200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: EOD key figures for a list of notations. nullable: false items: type: object nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - tradingVolume - volatility - status properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. tradingVolume: nullable: true type: number format: real description: Sum of the trading volume of a notation in number of shares for the time-range between the date of the most recent end-of-day (EOD) closing price (inclusive) and the reference date (exclusive). volatility: nullable: true type: number format: real description: Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. status: nullable: false type: object x-property-sort: - code - identifier - details - encryptedDetails description: Error status for the requested identifier. properties: code: nullable: true type: string description: Code of the error condition. x-enum-description: - No error. - The provided identifier does not refer to a valid notation. - Not entitled to see data for the notation. - Unable to resolve the provided identifier. enum: - none - parameter - entitlement - identifierMapping identifier: nullable: true type: string format: id64 x-positive: true description: Provided identifier. details: nullable: true type: string description: A human-readable, unstructured explanation specific to this occurrence of the problem. encryptedDetails: nullable: true type: string description: Base64-encoded internal details about the error. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresYear1Get200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. averagePrice: nullable: true type: number format: real description: Arithmetic mean of the notation's EOD closing prices for the given time range. tradingVolume: nullable: false type: object x-property-sort: - average - sum description: Average and total trading volume for the given time range. properties: average: nullable: true type: number format: real description: Arithmetic mean of the daily trading volumes. sum: nullable: true type: number format: real description: Sum of the daily trading volumes. tradingValue: nullable: true type: number format: real description: Sum of the cash flow for all transactions of one notation over a certain time range. The cash flow of a transaction is its volume multiplied by its trade price. volatility: nullable: true type: number format: real description: Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - averagePrice - tradingVolume - tradingValue - volatility description: EOD key figures. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresYear7List200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: EOD key figures for a list of notations. nullable: false items: type: object nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - tradingVolume - volatility - status properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. tradingVolume: nullable: true type: number format: real description: Sum of the trading volume of a notation in number of shares for the time-range between the date of the most recent end-of-day (EOD) closing price (inclusive) and the reference date (exclusive). volatility: nullable: true type: number format: real description: Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. status: nullable: false type: object x-property-sort: - code - identifier - details - encryptedDetails description: Error status for the requested identifier. properties: code: nullable: true type: string description: Code of the error condition. x-enum-description: - No error. - The provided identifier does not refer to a valid notation. - Not entitled to see data for the notation. - Unable to resolve the provided identifier. enum: - none - parameter - entitlement - identifierMapping identifier: nullable: true type: string format: id64 x-positive: true description: Provided identifier. details: nullable: true type: string description: A human-readable, unstructured explanation specific to this occurrence of the problem. encryptedDetails: nullable: true type: string description: Base64-encoded internal details about the error. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresMonth6Get200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. tradingVolume: nullable: true type: number format: real description: Sum of the trading volume of a notation in number of shares for the time-range between the date of the most recent end-of-day (EOD) closing price (inclusive) and the reference date (exclusive). volatility: nullable: true type: number format: real description: Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - tradingVolume - volatility description: EOD key figures. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresYearToDateGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. volatility: nullable: true type: number format: real description: Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - volatility description: EOD key figures. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresYear3List200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: EOD key figures for a list of notations. nullable: false items: type: object nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - tradingVolume - volatility - status properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. tradingVolume: nullable: true type: number format: real description: Sum of the trading volume of a notation in number of shares for the time-range between the date of the most recent end-of-day (EOD) closing price (inclusive) and the reference date (exclusive). volatility: nullable: true type: number format: real description: Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. status: nullable: false type: object x-property-sort: - code - identifier - details - encryptedDetails description: Error status for the requested identifier. properties: code: nullable: true type: string description: Code of the error condition. x-enum-description: - No error. - The provided identifier does not refer to a valid notation. - Not entitled to see data for the notation. - Unable to resolve the provided identifier. enum: - none - parameter - entitlement - identifierMapping identifier: nullable: true type: string format: id64 x-positive: true description: Provided identifier. details: nullable: true type: string description: A human-readable, unstructured explanation specific to this occurrence of the problem. encryptedDetails: nullable: true type: string description: Base64-encoded internal details about the error. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresMonth6List200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: EOD key figures for a list of notations. nullable: false items: type: object nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - tradingVolume - volatility - status properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. tradingVolume: nullable: true type: number format: real description: Sum of the trading volume of a notation in number of shares for the time-range between the date of the most recent end-of-day (EOD) closing price (inclusive) and the reference date (exclusive). volatility: nullable: true type: number format: real description: Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. status: nullable: false type: object x-property-sort: - code - identifier - details - encryptedDetails description: Error status for the requested identifier. properties: code: nullable: true type: string description: Code of the error condition. x-enum-description: - No error. - The provided identifier does not refer to a valid notation. - Not entitled to see data for the notation. - Unable to resolve the provided identifier. enum: - none - parameter - entitlement - identifierMapping identifier: nullable: true type: string format: id64 x-positive: true description: Provided identifier. details: nullable: true type: string description: A human-readable, unstructured explanation specific to this occurrence of the problem. encryptedDetails: nullable: true type: string description: Base64-encoded internal details about the error. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresWeek1List200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: EOD key figures for a list of notations. nullable: false items: type: object nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - averagePrice - tradingVolume - tradingValue - volatility - status properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. averagePrice: nullable: true type: number format: real description: Arithmetic mean of the notation's EOD closing prices for the given time range. tradingVolume: nullable: false type: object x-property-sort: - average - sum description: Average and total trading volume for the given time range. properties: average: nullable: true type: number format: real description: Arithmetic mean of the daily trading volumes. sum: nullable: true type: number format: real description: Sum of the daily trading volumes. tradingValue: nullable: true type: number format: real description: Sum of the cash flow for all transactions of one notation over a certain time range. The cash flow of a transaction is its volume multiplied by its trade price. volatility: nullable: true type: number format: real description: Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. status: nullable: false type: object x-property-sort: - code - identifier - details - encryptedDetails description: Error status for the requested identifier. properties: code: nullable: true type: string description: Code of the error condition. x-enum-description: - No error. - The provided identifier does not refer to a valid notation. - Not entitled to see data for the notation. - Unable to resolve the provided identifier. enum: - none - parameter - entitlement - identifierMapping identifier: nullable: true type: string format: id64 x-positive: true description: Provided identifier. details: nullable: true type: string description: A human-readable, unstructured explanation specific to this occurrence of the problem. encryptedDetails: nullable: true type: string description: Base64-encoded internal details about the error. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresYear5Get200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. tradingVolume: nullable: true type: number format: real description: Sum of the trading volume of a notation in number of shares for the time-range between the date of the most recent end-of-day (EOD) closing price (inclusive) and the reference date (exclusive). volatility: nullable: true type: number format: real description: Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - tradingVolume - volatility description: EOD key figures. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresTradingDayAverageGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. price: nullable: false type: object x-property-sort: - days5 - days20 - days30 - days38 - days50 - days100 - days200 - days250 description: Average price. See attribute `valueUnit` in endpoint `/notation/get` for its unit. properties: days5: nullable: true type: number format: real description: Five trading days. days20: nullable: true type: number format: real description: 20 trading days. days30: nullable: true type: number format: real description: 30 trading days. days38: nullable: true type: number format: real description: 38 trading days. days50: nullable: true type: number format: real description: 50 trading days. days100: nullable: true type: number format: real description: 100 trading days. days200: nullable: true type: number format: real description: 200 trading days. days250: nullable: true type: number format: real description: 250 trading days. volume: nullable: false type: object x-property-sort: - days5 - days30 - days50 - days100 - days200 - days250 description: Average trading volume. properties: days5: nullable: true type: number format: real description: Five trading days. days30: nullable: true type: number format: real description: 30 trading days. days50: nullable: true type: number format: real description: 50 trading days. days100: nullable: true type: number format: real description: 100 trading days. days200: nullable: true type: number format: real description: 200 trading days. days250: nullable: true type: number format: real description: 250 trading days. value: nullable: false type: object x-property-sort: - days5 - days30 - days100 - days250 description: Average trading value. See attribute `valueUnit` in endpoint `/notation/get` for its unit. properties: days5: nullable: true type: number format: real description: Five trading days. days30: nullable: true type: number format: real description: 30 trading days. days100: nullable: true type: number format: real description: 100 trading days. days250: nullable: true type: number format: real description: 250 trading days. description: Average end-of-day (EOD) key figures for various time ranges. nullable: false x-property-sort: - idNotation - sourceIdentifier - price - volume - value meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresMonth1List200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: EOD key figures for a list of notations. nullable: false items: type: object nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - averagePrice - tradingVolume - tradingValue - volatility - status properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. averagePrice: nullable: true type: number format: real description: Arithmetic mean of the notation's EOD closing prices for the given time range. tradingVolume: nullable: false type: object x-property-sort: - average - sum description: Average and total trading volume for the given time range. properties: average: nullable: true type: number format: real description: Arithmetic mean of the daily trading volumes. sum: nullable: true type: number format: real description: Sum of the daily trading volumes. tradingValue: nullable: true type: number format: real description: Sum of the cash flow for all transactions of one notation over a certain time range. The cash flow of a transaction is its volume multiplied by its trade price. volatility: nullable: true type: number format: real description: Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. status: nullable: false type: object x-property-sort: - code - identifier - details - encryptedDetails description: Error status for the requested identifier. properties: code: nullable: true type: string description: Code of the error condition. x-enum-description: - No error. - The provided identifier does not refer to a valid notation. - Not entitled to see data for the notation. - Unable to resolve the provided identifier. enum: - none - parameter - entitlement - identifierMapping identifier: nullable: true type: string format: id64 x-positive: true description: Provided identifier. details: nullable: true type: string description: A human-readable, unstructured explanation specific to this occurrence of the problem. encryptedDetails: nullable: true type: string description: Base64-encoded internal details about the error. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresYear10List200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: EOD key figures for a list of notations. nullable: false items: type: object nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - tradingVolume - volatility - status properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. tradingVolume: nullable: true type: number format: real description: Sum of the trading volume of a notation in number of shares for the time-range between the date of the most recent end-of-day (EOD) closing price (inclusive) and the reference date (exclusive). volatility: nullable: true type: number format: real description: Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. status: nullable: false type: object x-property-sort: - code - identifier - details - encryptedDetails description: Error status for the requested identifier. properties: code: nullable: true type: string description: Code of the error condition. x-enum-description: - No error. - The provided identifier does not refer to a valid notation. - Not entitled to see data for the notation. - Unable to resolve the provided identifier. enum: - none - parameter - entitlement - identifierMapping identifier: nullable: true type: string format: id64 x-positive: true description: Provided identifier. details: nullable: true type: string description: A human-readable, unstructured explanation specific to this occurrence of the problem. encryptedDetails: nullable: true type: string description: Base64-encoded internal details about the error. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresMonth3Get200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. tradingVolume: nullable: true type: number format: real description: Sum of the trading volume of a notation in number of shares for the time-range between the date of the most recent end-of-day (EOD) closing price (inclusive) and the reference date (exclusive). volatility: nullable: true type: number format: real description: Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - tradingVolume - volatility description: EOD key figures. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresMonth1Get200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. averagePrice: nullable: true type: number format: real description: Arithmetic mean of the notation's EOD closing prices for the given time range. tradingVolume: nullable: false type: object x-property-sort: - average - sum description: Average and total trading volume for the given time range. properties: average: nullable: true type: number format: real description: Arithmetic mean of the daily trading volumes. sum: nullable: true type: number format: real description: Sum of the daily trading volumes. tradingValue: nullable: true type: number format: real description: Sum of the cash flow for all transactions of one notation over a certain time range. The cash flow of a transaction is its volume multiplied by its trade price. volatility: nullable: true type: number format: real description: Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - averagePrice - tradingVolume - tradingValue - volatility description: EOD key figures. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresYear10Get200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. tradingVolume: nullable: true type: number format: real description: Sum of the trading volume of a notation in number of shares for the time-range between the date of the most recent end-of-day (EOD) closing price (inclusive) and the reference date (exclusive). volatility: nullable: true type: number format: real description: Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - tradingVolume - volatility description: EOD key figures. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetDebtInstrumentKeyFiguresNotationGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: nullable: false type: object x-property-sort: - calculation - yield - macaulayDuration - sensitivities description: Key figures and related data. properties: calculation: nullable: false type: object x-property-sort: - time - price description: Details of the calculation. properties: time: nullable: true type: string format: datetime description: Date and time of the calculation. price: nullable: false type: object x-property-sort: - value - valueUnit - dirtyPricing description: Price used for the calculation. properties: value: nullable: true type: number format: real description: Price value. valueUnit: nullable: false type: object x-property-sort: - id - code description: Value unit of the notation of the debt instrument, such as a main currency for a per-unit-quoted debt instrument (rarely), or percentages for a debt instrument quoted in percent. See endpoint `/basic/valueUnit/list` for possible values. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the value unit. code: nullable: true type: string description: Code of the value unit. dirtyPricing: nullable: true type: boolean description: If true, the attribute `price.value` contains the accrued interest. yield: nullable: false type: object x-property-sort: - current - toMaturity - spread description: Yield-related key figures. properties: current: nullable: true type: number format: relativeValue description: Current yield, which is the next annual interest payment divided by the price. If the coupon period is different than a year, the interest payment is annualized. toMaturity: nullable: true type: number format: relativeValue description: Yield to maturity, which is the annual rate of return, assuming the instrument is held until maturity. spread: nullable: true type: number format: relativeValue description: Credit spread, which is the difference in yield to maturity between a highest-quality debt instrument, also called a benchmark bond, and the debt instrument. See endpoint `/instrument/benchmark/list` for the benchmark bond. macaulayDuration: nullable: true type: number format: real description: Macaulay duration, which is the average period (in years) of capital commitment. sensitivities: nullable: false type: object x-property-sort: - basePointValue - modifiedDuration - elasticity - convexity description: Price sensitivities of the debt instrument with respect to the prevailing market interest rate. properties: basePointValue: nullable: true type: number format: real description: Base point value, which is the change of the debt instrument's price for a one base point change (nominally, not relatively) of the prevailing market interest rate. One base point is equivalent to 0,01 percent (1/100 of a percent). See attribute `price/valueUnit` for its value unit. modifiedDuration: nullable: true type: number format: relativeValue description: Modified duration, which is the percentage change of the debt instrument's price for a one percent change (nominally, not relatively) of the prevailing market interest rate. elasticity: nullable: true type: number format: real description: Yield elasticity, which is the ratio of the percentage change of the debt instrument's price for a one percent change (relatively, not nominally) of the prevailing market interest rate. convexity: nullable: true type: number format: real description: Convexity, which is a measure for the change of the modified duration as the prevailing market interest rate changes. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status GetNotationKeyFiguresYear3Get200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. tradingVolume: nullable: true type: number format: real description: Sum of the trading volume of a notation in number of shares for the time-range between the date of the most recent end-of-day (EOD) closing price (inclusive) and the reference date (exclusive). volatility: nullable: true type: number format: real description: Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - tradingVolume - volatility description: EOD key figures. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresYear7Get200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. tradingVolume: nullable: true type: number format: real description: Sum of the trading volume of a notation in number of shares for the time-range between the date of the most recent end-of-day (EOD) closing price (inclusive) and the reference date (exclusive). volatility: nullable: true type: number format: real description: Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - tradingVolume - volatility description: EOD key figures. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta schemas: StatusObject: type: object properties: code: type: number format: int32 description: The HTTP status code of the response, mirroring the code from the Status-Line of the HTTP response message (see [RFC2616] section 6.1). example: 42.5 description: The status member contains the status code of the response. required: - code securitySchemes: basicAuth: type: http scheme: basic externalDocs: url: https://developer.factset.com/api-catalog/analytics-datastore-api description: API Documentation