openapi: 3.0.3 info: title: Factset Analytics Datastore About Instrument 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: Instrument paths: /debtInstrument/get: get: tags: - Instrument operationId: get/debtInstrument/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 Fundamental Data for a Debt Instrument. description: Fundamental data for a debt instrument; any other instrument yields empty values for debt-instrument-specific attributes. Dates are interpreted in the timezone of the issuer. parameters: - name: id in: query schema: type: string format: id64 x-positive: true description: Identifier of the instrument. 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/GetDebtInstrumentGet200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /debtInstrument/issuer/search: post: tags: - Instrument operationId: post/debtInstrument/issuer/search 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 Search for Issuers of Debt Instruments. description: Search for issuers of debt instruments. FactSet does not consolidate the data provided by different suppliers, therefore the result may contain more than one identifier for a given issuer. The response is limited to 100 results. requestBody: content: application/json: schema: $ref: '#/components/schemas/PostDebtInstrumentIssuerSearchRequest' responses: '200': $ref: '#/components/responses/PostDebtInstrumentIssuerSearch200Response' parameters: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /debtInstrument/keyFigures/notation/get: get: tags: - Instrument 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 /debtInstrument/notation/screener/search: post: tags: - Instrument operationId: post/debtInstrument/notation/screener/search x-supportsOffsetBasedPaging: true 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 Screener for Debt Instruments' Notations Based on Debt Instrument-specific Parameters. description: Screener for debt instruments' notations based on debt instrument-specific parameters. The result is limited to the notations that satisfy all the selected filters. If more than one notation of an instrument matches the parameters, and no market priority has been specified, only the notation with the highest trading volume, averaged over one month, is considered. requestBody: content: application/json: schema: $ref: '#/components/schemas/PostDebtInstrumentNotationScreenerSearchRequest' responses: '200': $ref: '#/components/responses/PostDebtInstrumentNotationScreenerSearch200Response' parameters: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /debtInstrument/notation/screener/valueRanges/get: post: tags: - Instrument operationId: post/debtInstrument/notation/screener/valueRanges/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 Possible Values and Value Ranges for the Parameters Used in the Endpoint `/debtinstrument/notation/screener/search.` description: The endpoint returns the possible values and value ranges for the parameters used in the endpoint `/debtInstrument/notation/screener/search`. It allows to request the values and value ranges only for a restricted set of notations that match predefined parameters. The functionality may be used to pre-fill the values and value ranges of the parameters of the `/debtInstrument/notation/screener/search` endpoint so that performing a search always leads to a non-empty set of notations. If more than one notation of an instrument matches the parameters, and no market priority has been specified, only the notation with the highest trading volume, averaged over one month, is considered. requestBody: content: application/json: schema: $ref: '#/components/schemas/PostDebtInstrumentNotationScreenerValueRangesGetRequest' responses: '200': $ref: '#/components/responses/PostDebtInstrumentNotationScreenerValueRangesGet200Response' parameters: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /news/article/listByInstrument: post: tags: - Instrument operationId: post/news/article/listByInstrument x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: true x-supportsPush: true x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset News Articles for Instruments. description: News articles for instruments. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostNewsArticleListByInstrumentRequest' required: true responses: '200': $ref: '#/components/responses/PostNewsArticleListByInstrument200Response' parameters: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /category/instrument/list: get: tags: - Instrument operationId: get/category/instrument/list x-supportsOffsetBasedPaging: true 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 List of Instruments Where a Specific Dataset Has Assigned a Given Category. description: List of instruments where a specific dataset has assigned a given category. parameters: - name: idCategory in: query schema: type: number format: id32 x-positive: true description: Identifier of a category. required: true - name: idCategoryDataset in: query schema: type: number format: id32 x-positive: true description: Identifier of a category dataset. 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. - description: Non-negative number of entries to skip, or 0 (default). name: _paginationOffset in: query schema: type: number format: int32 minimum: 0 exclusiveMinimum: false default: 0 - description: Non-negative maximum number of entries to return. name: _paginationLimit in: query schema: type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 1000 exclusiveMaximum: false default: 20 responses: '200': $ref: '#/components/responses/GetCategoryInstrumentList200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/get: get: tags: - Instrument operationId: get/instrument/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: Basic data for an instrument. summary: Factset Basic Data for an Instrument. 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/GetInstrumentGet200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/getByNotation: get: tags: - Instrument operationId: get/instrument/getByNotation 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: Basic data for an instrument. summary: Factset Basic Data for an Instrument. 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. - 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/GetInstrumentGetByNotation200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/backgroundText/list: get: tags: - Instrument operationId: get/instrument/backgroundText/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 Background Texts of an Instrument. description: Background texts of an instrument. 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/GetInstrumentBackgroundTextList200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/backgroundText/type/list: post: tags: - Instrument operationId: post/instrument/backgroundText/type/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 List of Background Text Types for Instruments. description: List of background text types for instruments. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostInstrumentBackgroundTextTypeListRequest' required: false responses: '200': $ref: '#/components/responses/PostInstrumentBackgroundTextTypeList200Response' parameters: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/benchmark/list: post: tags: - Instrument operationId: post/instrument/benchmark/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 List of Benchmarks of a Financial Instrument. description: Provides a list of benchmark notations for a selected financial instrument, optionally restricted to specific benchmark types. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostInstrumentBenchmarkListRequest' required: false responses: '200': $ref: '#/components/responses/PostInstrumentBenchmarkList200Response' parameters: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/category/list: post: tags: - Instrument operationId: post/instrument/category/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: 2 x-supportsPermissionDeniedResponse: false summary: Factset List of Categories Assigned to a Specific Instrument the Application Is Entitled to See. description: List of categories assigned to a specific instrument the application is entitled to see. Optionally it is possible to restrict the output to only list those for a specific category dataset. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostInstrumentCategoryListRequest' required: false responses: '200': $ref: '#/components/responses/PostInstrumentCategoryList200Response' parameters: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/complianceProperty/list: post: tags: - Instrument operationId: post/instrument/complianceProperty/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 List of Compliance Properties for Instruments. description: List of compliance properties for instruments. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostInstrumentCompliancePropertyListRequest' required: false responses: '200': $ref: '#/components/responses/PostInstrumentCompliancePropertyList200Response' parameters: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/complianceProperty/listByInstrument: get: tags: - Instrument operationId: get/instrument/complianceProperty/listByInstrument 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 Compliance Properties of an Instrument. description: Compliance properties of an instrument. 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/GetInstrumentCompliancePropertyListByInstrument200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/composite/get: get: tags: - Instrument operationId: get/instrument/composite/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 Composite Instrument and Its Components. description: Composite instrument and its components. 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/GetInstrumentCompositeGet200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/coupon/list: get: tags: - Instrument operationId: get/instrument/coupon/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 List of Coupons for an Interest-bearing Instrument. description: "List of coupons for an interest-bearing instrument; any other instrument yields empty values. The endpoint provides details regarding the coupon period, the respective interest rate, and payable amount (the latter only for instruments with a fixed nominal value). The list of coupons is generally not available for a perpetual, i.e. without a predefined maturity date, interst-bearing instrument. \n\nIf there is no entitled provider supplying a full list of coupons, the list will be synthesized from summary data available from entitled suppliers (if any). Since the exact product terms are not known, e.g. the handling of holidays and weekends, the list may be imprecise." 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/GetInstrumentCouponList200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/coupon/dayCountConvention/type/list: get: tags: - Instrument operationId: get/instrument/coupon/dayCountConvention/type/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 List of Day Count Convention Types. description: List of day count convention types. responses: '200': $ref: '#/components/responses/GetInstrumentCouponDayCountConventionTypeList200Response' parameters: - 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 x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/coupon/interestRate/type/list: get: tags: - Instrument operationId: get/instrument/coupon/interestRate/type/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 List of Interest Rate Types. description: List of interest rate types. responses: '200': $ref: '#/components/responses/GetInstrumentCouponInterestRateTypeList200Response' parameters: - 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 x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/coupon/keyData/get: get: tags: - Instrument 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 /instrument/crossReference/getByISIN: get: tags: - Instrument operationId: get/instrument/crossReference/getByISIN 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: Translate a given ISIN to the respective most recent instrument identifier, retrieved from the Cross Reference Service. summary: Factset Translate Isin to Instrument. parameters: - name: isin in: query schema: type: string format: isin description: Source ISIN to be translated. 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/GetInstrumentCrossReferenceGetByISIN200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/crossReference/getByWKN: get: tags: - Instrument operationId: get/instrument/crossReference/getByWKN 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: Translate a given WKN to the respective most recent instrument identifier, retrieved from the Cross Reference Service. summary: Factset Translate Wkn to Instrument. parameters: - name: wkn in: query schema: description: Source WKN to be translated. type: string minLength: 6 exclusiveMinimum: false maxLength: 6 exclusiveMaximum: false pattern: ^[A-Z0-9]*$ 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/GetInstrumentCrossReferenceGetByWKN200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/crossReference/listByISIN: post: tags: - Instrument operationId: post/instrument/crossReference/listByISIN 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: Translate a given list of ISINs to the respective most recent instrument identifiers, retrieved from the Cross Reference Service. summary: Factset Translate a List of Isins to Instruments. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostInstrumentCrossReferenceListByISINRequest' required: true responses: '200': $ref: '#/components/responses/PostInstrumentCrossReferenceListByISIN200Response' parameters: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/crossReference/listByWKN: post: tags: - Instrument operationId: post/instrument/crossReference/listByWKN 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: Translate a given list of WKNs to the respective most recent instrument identifiers, retrieved from the Cross Reference Service. summary: Factset Translate a List of Wkns to Instruments. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostInstrumentCrossReferenceListByWKNRequest' required: true responses: '200': $ref: '#/components/responses/PostInstrumentCrossReferenceListByWKN200Response' parameters: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/crossReference/history/getByISIN: get: tags: - Instrument operationId: get/instrument/crossReference/history/getByISIN x-supportsOffsetBasedPaging: true 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: Retrieve the complete translation history of a given ISIN to the respective instrument association from the Cross Reference Service. The results are sorted in descending order, starting with the most recent. summary: Factset Isin to Instrument Translation History. parameters: - name: isin in: query schema: type: string format: isin description: Source ISIN to be translated. 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. - description: Non-negative number of entries to skip, or 0 (default). name: _paginationOffset in: query schema: type: number format: int32 minimum: 0 exclusiveMinimum: false default: 0 - description: Non-negative maximum number of entries to return. name: _paginationLimit in: query schema: type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 500 exclusiveMaximum: false default: 10 responses: '200': $ref: '#/components/responses/GetInstrumentCrossReferenceHistoryGetByISIN200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/crossReference/history/getByWKN: get: tags: - Instrument operationId: get/instrument/crossReference/history/getByWKN x-supportsOffsetBasedPaging: true 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: Retrieve the complete translation history of a given WKN to the respective instrument association from the Cross Reference Service. The results are sorted in descending order, starting with the most recent. summary: Factset Wkn to Instrument Translation History. parameters: - name: wkn in: query schema: description: Source WKN to be translated. type: string pattern: ^[A-Z0-9]*$ minLength: 6 exclusiveMinimum: false maxLength: 6 exclusiveMaximum: false 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. - description: Non-negative number of entries to skip, or 0 (default). name: _paginationOffset in: query schema: type: number format: int32 minimum: 0 exclusiveMinimum: false default: 0 - description: Non-negative maximum number of entries to return. name: _paginationLimit in: query schema: type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 500 exclusiveMaximum: false default: 10 responses: '200': $ref: '#/components/responses/GetInstrumentCrossReferenceHistoryGetByWKN200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/exchangeRate/get: get: tags: - Instrument operationId: get/instrument/exchangeRate/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: "Retrieve an exchange rate instrument identifier using the identifier of the main currencies represented by that exchange rate. \n\n An error is returned if one of the provided parameters is invalid or if no instrument is associated with the given combination of parameters." summary: Factset Retrieve an Exchange Rate Instrument Identifier. parameters: - name: target in: query schema: type: number format: id32 x-positive: true description: Identifier of the target main currency. See endpoint `/basic/valueUnit/currency/main/list` for valid values. required: true - name: source in: query schema: type: number format: id32 x-positive: true description: Identifier of the source main currency. See endpoint `/basic/valueUnit/currency/main/list` for valid values. 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/GetInstrumentExchangeRateGet200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/exchangeRate/getByISOCode: get: tags: - Instrument operationId: get/instrument/exchangeRate/getByISOCode 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: "Retrieve an exchange rate instrument identifier using the ISO 4217 code of the main currencies represented by that exchange rate. \n\nAn error is returned if one of the provided parameters is invalid or if no instrument is associated with the given combination of parameters." summary: Factset Retrieve an Exchange Rate Instrument Identifier. parameters: - name: target in: query schema: type: string minLength: 3 exclusiveMinimum: false maxLength: 3 exclusiveMaximum: false description: ISO 4217 code of the target main currency. required: true - name: source in: query schema: type: string minLength: 3 exclusiveMinimum: false maxLength: 3 exclusiveMaximum: false description: ISO 4217 code of the source main currency. 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/GetInstrumentExchangeRateGetByISOCode200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/legalEntity/backgroundText/list: get: tags: - Instrument operationId: get/instrument/legalEntity/backgroundText/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 Role-specific Background Texts of Legal Entities Related to an Instrument. description: Role-specific background texts of legal entities related to an instrument. 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/GetInstrumentLegalEntityBackgroundTextList200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/legalEntity/complianceProperty/list: get: tags: - Instrument operationId: get/instrument/legalEntity/complianceProperty/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 Role-specific Compliance Properties of Legal Entities Related to an Instrument. description: Role-specic compliance properties of legal entities related to an instrument. 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/GetInstrumentLegalEntityCompliancePropertyList200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/mifid/get: get: tags: - Instrument operationId: get/instrument/mifid/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: MiFID II data for a specified financial instrument. The instruments governed by MiFID II are called "investment products". summary: Factset Mifid Ii Data for a Financial Instrument. 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/GetInstrumentMifidGet200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/notation/list: post: tags: - Instrument operationId: post/instrument/notation/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: 1 x-supportsPermissionDeniedResponse: false summary: Factset List of Active, Entitled Notations for a Set of Instruments. description: List of active, entitled notations for a set of instruments. By default the list of notations (per instrument) is sorted descending by the trading volume, averaged over one month. All identifiers used as parameters must be valid and entitled. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostInstrumentNotationListRequest' required: false responses: '200': $ref: '#/components/responses/PostInstrumentNotationList200Response' parameters: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/rating/grade/list: post: tags: - Instrument operationId: post/instrument/rating/grade/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 description: List of rating grades for a list of instruments. The list can be restricted to rating grades belonging to particular rating systems. summary: Factset List of Rating Grades for a List of Instruments. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostInstrumentRatingGradeListRequest' required: false responses: '200': $ref: '#/components/responses/PostInstrumentRatingGradeList200Response' parameters: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/selectionList/list: get: tags: - Instrument operationId: get/instrument/selectionList/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 description: Set of custom instrument-level selection lists. summary: Factset Set of Custom Instrument-level Selection Lists. responses: '200': $ref: '#/components/responses/GetInstrumentSelectionListList200Response' parameters: - 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. x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/selectionList/listByInstrument: get: tags: - Instrument operationId: get/instrument/selectionList/listByInstrument 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: For each given instrument, returns the instrument-level selection lists of which the instrument is a member. summary: Factset for Each Given Instrument, Returns the Instrument-level Selection Lists of Which the Instrument Is a Member. 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}-[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]$ 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 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. responses: '200': $ref: '#/components/responses/GetInstrumentSelectionListListByInstrument200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/selectionList/members/list: post: tags: - Instrument operationId: post/instrument/selectionList/members/list x-supportsOffsetBasedPaging: true 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: 4 x-supportsPermissionDeniedResponse: false summary: Factset List of Instruments Belonging to an Instrument-level Selection List. description: List of instruments belonging to an instrument-level selection list. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostInstrumentSelectionListMembersListRequest' required: false responses: '200': $ref: '#/components/responses/PostInstrumentSelectionListMembersList200Response' parameters: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/crossReference/listByInstrument: post: tags: - Instrument operationId: post/notation/crossReference/listByInstrument 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 List of Entitled Notations. description: List of entitled notations. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostNotationCrossReferenceListByInstrumentRequest' required: false responses: '200': $ref: '#/components/responses/PostNotationCrossReferenceListByInstrument200Response' parameters: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/crossReference/factSetIdentifier/listByInstrument: post: tags: - Instrument operationId: post/notation/crossReference/factSetIdentifier/listByInstrument 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: Retrieve a List of Factset Identifiers for a Given Instrument. description:

Retrieve a list of FactSet identifiers for a given instrument, grouped by regional identifiers, if available. Listings without a regional identifier are grouped at the end of the response.

The notation corresponding to the security's primary listing has the attributes regional.isPrimary and regional.listing.isPrimary both set to true.The security's primary listing might not be among the results depending on the entitlement.

The result contains only notations that have at least one FactSet identifier (see listing.permanentIdentifier, listing.tickerExchange).

See the group description for more information about the security's primary listing.

requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostNotationCrossReferenceFactSetIdentifierListByInstrumentRequest' required: true responses: '200': $ref: '#/components/responses/PostNotationCrossReferenceFactSetIdentifierListByInstrument200Response' parameters: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/search/basic: get: tags: - Instrument operationId: get/instrument/search/basic x-supportsOffsetBasedPaging: true 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 Basic Search for Instruments. description: Search for instruments whose ISIN, specified NSINs, or name match the search value according to a tolerant full-text match algorithm. Better matching results appear in the response before less relevant matches. parameters: - name: searchValue in: query schema: type: string minLength: 3 exclusiveMinimum: false maxLength: 200 exclusiveMaximum: false pattern: ^[ -!#-&(-+--/0-:=?-Za-z\w"]*$ description: The search value of the instruments searching for. It may be enclosed in double quotes ("). No escaping is provided, therefore it is impossible to specify a search string containing double quotes. Relevance of word starts is indicated by a phrase starting with a space character, such as " daimler". required: true - name: nsins in: query schema: description: A set of NSIN kinds to consider in the search. If the parameter is absent or the value is empty, all valid NSIN kinds are searched. type: array nullable: false items: type: string x-enum-description: - The WKN (Wertpapierkennnummer, German for Securities Identification Number) of the instrument. The WKN is a 6-character code of digits and upper-case letters that uniquely identifies an instrument. - 'The Valor number (German: Valorennummer) of the instrument. The Valor number is an integer number that uniquely identifies an instrument.' - The CUSIP (Committee on Uniform Security Identification Procedures) or CINS (CUSIP International Numbering System) identifier of the instrument. These numbers are 9-character codes of digits and upper-case letters that uniquely identify an instrument. - The SEDOL or IDII for the instrument; see entity class "SEDOL or IDII" for details. enum: - wkn - valor - cusip - sedol uniqueItems: true style: form explode: false - name: assetClass in: query schema: type: string description: A parameter to limit the output to a particular asset class. x-enum-description: - An index is an instrument representing a statistical measure of changes in a group of data points. An index has a well-defined calculation method. An index may have index constituents, selected according to a well-defined set of rules. - A stock, also known as stock certificate or share, represents the partitioned capital stock of a company. The capital stock of a company constitutes the equity stake of its owners. - A fund is a supply of capital belonging to numerous investors that is used to collectively purchase securities while each investor retains ownership and control of his or her own shares. - An exchange traded fund (ETF) is a security that tracks an index, a commodity or a basket of assets like an index fund, but trades like a stock on an exchange. ETFs experience price changes throughout the day as they are bought and sold. - A debt instrument is an interest-bearing or interest-earning financial instrument, which is generally used for long-term debt financing and investment. - An investment product is a securitized derivatives product which allows the investor to participate in the performance of the underlying financial instrument. - A leveraged product is a securitized derivatives product which allows the investor to participate with a leverage in the performance of the underlying financial instrument. - A currency cross rate is an exchange rate between two main currencies. - A commodity is a marketable item produced to satisfy market requirements. Economic commodities comprise both goods and services. - An option is a derivatives contract that represents a contract sold by one party (the option writer) to another party (the option holder). The contract offers the buyer the right, but not the obligation, to buy (call) or sell (put) a particular underlying asset at an agreed price (the strike price) on a specific exercise date (European-style option) or during a period of time up to that exercise date (American-style option). - A future is a derivatives contract that represents a contractual agreement to buy or sell a particular underlying asset at a pre-determined price on a specific date in the future. A future contract details the quality and quantity of the underlying asset. Some future contracts may require a physical delivery of the asset, whereas others are settled in cash. In contrast to a forward (traded over-the-counter (OTC)), a future is a standardized derivative traded on a futures exchange. - An interest rate is the rate at which interest is paid by borrowers for the use of money borrowed from a lender. Specifically, the interest rate is a percentage of the principal. - Rights are securities that allow the owner to participate at the securitized right. enum: - index - stock - fund - etf - debt - investmentProduct - leveragedProduct - currency - commodity - option - future - interestRate - right - name: onlyActive in: query schema: type: boolean description: If true, restricts the result to active instruments. default: true required: false - 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 - description: Non-negative number of entries to skip, or 0 (default). name: _paginationOffset in: query schema: type: number format: int32 minimum: 0 exclusiveMinimum: false default: 0 - description: Non-negative maximum number of entries to return. name: _paginationLimit in: query schema: type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 500 exclusiveMaximum: false default: 20 responses: '200': $ref: '#/components/responses/GetInstrumentSearchBasic200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: PartialOutputObject: type: object properties: isPartial: type: boolean description: Flag indicating that the response is a possibly incomplete array or an object containing a possibly incomplete array, due to hitting a processing time limit. If `true`, some matching results might be missing from the array, or elements for matching results might be incorrectly included (for example, when priority sorting would have removed the element). Depending on the use case, such a response may be unsuitable. example: true description: Object denoting that the endpoint response is possibly incomplete. required: - isPartial x-property-sort: - isPartial PostInstrumentCategoryListRequest: x-property-sort: - data - meta description: Request Body type: object properties: data: type: object x-property-sort: - identifier - filter description: The data member contains the request's primary data. properties: identifier: type: object x-property-sort: - value - type description: Identifier and type. properties: value: 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. type: 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: - value - type filter: type: object x-property-sort: - dataset description: Criteria that filter the items in the response list; only items that match all of the criteria are returned. properties: dataset: type: object x-property-sort: - id description: Filter the categories to only return values assigned by a dataset. See endpoint `/category/dataset/list` for valid values. properties: id: type: number format: id32 x-positive: true description: Identifier of a category dataset. required: - identifier example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' language: $ref: '#/components/schemas/LanguageMember' sort: description: Sortable attributes. The sort order is ascending unless it is prefixed with a minus sign, in which case it is descending. A list of at most 2 (possibly prefixed) attribute name(s) is allowed. type: array items: type: string enum: - datasets.dataset.id - -datasets.dataset.id - datasets.dataset.name - -datasets.dataset.name maxItems: 2 uniqueItems: true default: - datasets.dataset.name x-property-sort: - attributes - language - sort example: example_value PostNotationCrossReferenceFactSetIdentifierListByInstrumentRequest: x-property-sort: - data - meta description: Request Body required: - data type: object properties: data: type: object x-property-sort: - identifier description: The data member contains the request's primary data. properties: identifier: type: object x-property-sort: - value - type description: Identifier and type. properties: value: 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. type: 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: - value - type required: - identifier example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' language: $ref: '#/components/schemas/LanguageMember' x-property-sort: - attributes - language example: example_value LanguageMember: type: string format: isoLanguage description: ISO 639-1 code of the language. maxLength: 2 minLength: 2 exclusiveMinimum: false exclusiveMaximum: false PostNewsArticleListByInstrumentRequest: x-property-sort: - data - meta description: Request Body required: - data type: object properties: data: type: object x-property-sort: - identifier - filter description: The data member contains the request's primary data. properties: identifier: type: object x-property-sort: - values - type description: Set of identifiers and their type. properties: values: 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}-[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]$ uniqueItems: true minItems: 1 maxItems: 100 type: 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: - values - type filter: description: Criteria that filter the items in the response list; only items that match all of the criteria are returned. type: object x-property-sort: - range - categories - regions - distributor - publisher - language - types properties: range: type: object format: timeRange properties: start: type: string format: datetime description: The starting point of the time range (inclusive), or `null` to indicate that the time range extends indefinitely into the past. x-allowNullValue: true end: type: string format: datetime description: The ending point of the time range (exclusive), or `null` to indicate that the time range extends indefinitely into the future. x-allowNullValue: true x-property-sort: - start - end required: - start - end description: Time range for matching the news article's date. At most one of the attributes `start` or `end` may be `null`. categories: type: object x-property-sort: - ids description: Filter for specific categories of the news article. Use a category system of type news with endpoint `/category/listBySystem` for valid values. properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true minItems: 1 maxItems: 100 uniqueItems: true description: Identifiers of the categories. regions: type: object x-property-sort: - ids description: Filter for specific regions of the content of the news article. See endpoint `/basic/region/list` for valid values. properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true minItems: 1 maxItems: 100 uniqueItems: true description: Identifiers of the regions. distributor: type: object x-property-sort: - ids description: Filter for specific distributors of the news article. See endpoint `/news/distributor/list` for valid values. properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true minItems: 1 maxItems: 100 uniqueItems: true description: Identifiers of the distributors. publisher: type: object x-property-sort: - ids description: Filter for specific publishers of the news article. See endpoint `/news/publisher/list` for valid values. properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true minItems: 1 maxItems: 100 uniqueItems: true description: Identifiers of the publishers. language: type: object x-property-sort: - ids description: Filter for specific languages of the news article. See endpoint `/basic/language/list` for valid values. properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true minItems: 1 maxItems: 100 uniqueItems: true description: Identifiers of the languages. types: type: object x-property-sort: - ids description: Filter for specific types of the news article. See endpoint `/news/article/type/list` for valid values. properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true minItems: 1 maxItems: 100 uniqueItems: true description: Identifiers of the article types. required: - identifier example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' subscription: type: object description: Object defining the subscription attributes. properties: minimumInterval: type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 5000 exclusiveMaximum: false default: 0 description: Non-negative number of milliseconds to throttle the update rate from 0ms to 5000ms. Set to 0 for sending updates immediately. x-property-sort: - minimumInterval pagination: type: object description: Pagination attributes for the cursor-based pagination strategy. properties: cursor: type: string maxLength: 50 exclusiveMaximum: false description: Starting point as returned in the attributes `pagination.next` or `pagination.previous` by a prior invocation of this endpoint, or undefined (default). limit: type: number format: int32 minimum: 1 exclusiveMinimum: false maximum: 500 exclusiveMaximum: false default: 20 description: Non-negative maximum number of entries to return. x-property-sort: - cursor - limit x-property-sort: - attributes - subscription - pagination example: example_value PostInstrumentBenchmarkListRequest: x-property-sort: - data - meta description: Request Body type: object properties: data: type: object x-property-sort: - identifier - filter description: The data member contains the request's primary data. properties: identifier: type: object x-property-sort: - value - type description: Identifier and type. properties: value: 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. type: 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: - value - type filter: type: object x-property-sort: - types description: Criteria that filter the items in the response list; only items that match all of the criteria are returned. properties: types: type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true description: Set of benchmark types. See endpoint `/basic/benchmark/type/list` for valid values. required: - identifier example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' language: $ref: '#/components/schemas/LanguageMember' x-property-sort: - attributes - language example: example_value PostDebtInstrumentIssuerSearchRequest: type: object properties: data: type: object x-property-sort: - name - minimumRatingGrade - country - market description: The data member contains the request's primary data. properties: name: type: object x-property-sort: - searchValue description: Issuer name. properties: searchValue: type: string pattern: ^[ -!#-&(-+--/0-:=?-Za-zw"]*$ minLength: 3 exclusiveMinimum: false maxLength: 100 exclusiveMaximum: false description: Text string to be searched for. minimumRatingGrade: type: object x-property-sort: - debtInstrument description: Minimum rating grade requirements for the issuers or their debt instruments. In either case, only one identifier per rating system is allowed. See endpoint `/rating/grade/listBySystem` for valid values. properties: debtInstrument: type: object x-property-sort: - ids description: Debt instrument rating. Only issuers whose debt instruments are rated higher than or equal to the rating grades in the provided list are returned. properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true maxItems: 5 uniqueItems: true description: List of rating grade identifiers. country: type: object x-property-sort: - ids description: List of countries of registration of the issuers. Only issuers that are registered in a country in the provided list are returned. properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true maxItems: 20 uniqueItems: true description: List of country identifiers. See endpoint `/basic/region/country/list` for valid values. market: type: object x-property-sort: - ids description: List of markets where debt instruments are traded. Only issuers that have issued at least one debt instrument traded on a market in the provided list are returned. properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true maxItems: 20 uniqueItems: true description: List of market identifiers. See endpoint `/basic/market/list` for valid values. example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' x-property-sort: - attributes example: example_value PostInstrumentBackgroundTextTypeListRequest: x-property-sort: - data - meta description: Request Body type: object properties: data: type: object x-property-sort: - filter description: The data member contains the request's primary data. properties: filter: type: object x-property-sort: - ids description: Criteria that filter the items in the response list; only items that match all of the criteria are returned. properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true maxItems: 100 uniqueItems: true description: Identifiers of background text types. example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' language: $ref: '#/components/schemas/LanguageMember' x-property-sort: - attributes - language example: example_value AttributesMember: type: array description: Limit the attributes returned in the response to the specified set. items: type: string maxLength: 100 exclusiveMaximum: false maxItems: 50 uniqueItems: true PostInstrumentCrossReferenceListByISINRequest: x-property-sort: - data - meta description: Request Body required: - data type: object properties: data: type: object x-property-sort: - isins description: The data member contains the request's primary data. properties: isins: description: List of source ISINs to be translated. type: array nullable: false items: type: string format: isin uniqueItems: true minItems: 1 maxItems: 10 required: - isins example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' x-property-sort: - attributes example: example_value PostInstrumentNotationListRequest: x-property-sort: - data - meta description: Request Body type: object properties: data: type: object x-property-sort: - identifier - filter description: The data member contains the request's primary data. properties: identifier: type: object x-property-sort: - values - type description: Set of identifiers and their type. properties: values: 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}-[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]$ uniqueItems: true minItems: 1 maxItems: 100 type: 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: - values - type filter: type: object x-property-sort: - valueUnit - market description: Criteria that filter the items in the response list; only items that match all of the criteria are returned. properties: valueUnit: type: object x-property-sort: - selection - order description: Value unit-related notation selection. See endpoint `/basic/valueUnit/list` for valid values. properties: selection: type: object x-property-sort: - restrict - exclude x-atMostOne: true description: Value unit selection. properties: restrict: type: object x-property-sort: - ids description: Specifies the value units a notation may have. properties: ids: description: Set of value unit identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 exclude: type: object x-property-sort: - ids description: Specifies the value units a notation may not have. properties: ids: description: Set of value unit identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 order: type: object x-property-sort: - ids description: Sequence of value unit identifiers specifying the sorting of the notations per instrument; if the value unit of notation A precedes the value unit of notation B in this list, A precedes B in the result. Notations whose value unit is not in this list sort last. The ordering is applied only when the parameter `meta.sort` contains the attribute `notations.valueUnit.id`; the parameter `meta.sort` cannot contain that attribute if the attribute `valueUnit.order` is absent. The list does not restrict the request to only those value units, use the parameter `valueUnit.selection` for that purpose. properties: ids: description: List of value unit identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 market: type: object x-property-sort: - selection - order description: Market-related notation selection. See endpoint `/basic/market/list` for valid values. properties: selection: type: object x-property-sort: - restrict - exclude - sipOnly x-atMostOne: true description: Market selection. properties: restrict: type: object x-property-sort: - ids description: Specifies the markets from which a notation may originate. properties: ids: description: Set of market identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 exclude: type: object x-property-sort: - ids description: Specifies the markets from which a notation may not originate. properties: ids: description: Set of market identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 sipOnly: type: boolean description: If `true`, only notations are returned that are traded on a market that reports to a U.S. Securities Information Processor (SIP). order: type: object x-property-sort: - ids description: Sequence of market identifiers specifying the sorting of the notations per instrument; if the market of notation A precedes the market of notation B in this list, A precedes B in the result. Notations whose market is not in this list sort last. The ordering is applied only when the parameter `meta.sort` contains the attribute `notations.market.id`; the parameter `meta.sort` cannot contain that attribute if the attribute `market.order` is absent. The list does not restrict the request to only those markets, use the parameter `market.selection` for that purpose. properties: ids: description: List of market identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 required: - identifier example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' language: $ref: '#/components/schemas/LanguageMember' sort: description: Sortable attributes. The sort order is ascending unless it is prefixed with a minus sign, in which case it is descending. A list of at most 1 (possibly prefixed) attribute name(s) is allowed. type: array items: type: string enum: - notations.market.id - -notations.market.id - notations.market.name - -notations.market.name - notations.valueUnit.id - -notations.valueUnit.id - notations.valueUnit.name - -notations.valueUnit.name - notations.tradingVolume.month1.average - -notations.tradingVolume.month1.average maxItems: 1 uniqueItems: true default: - notations.tradingVolume.month1.average x-property-sort: - attributes - language - sort example: example_value 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 PostInstrumentCompliancePropertyListRequest: x-property-sort: - data - meta description: Request Body type: object properties: data: type: object x-property-sort: - filter description: The data member contains the request's primary data. properties: filter: type: object x-property-sort: - ids description: Criteria that filter the items in the response list; only items that match all of the criteria are returned. properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true maxItems: 100 uniqueItems: true description: Identifiers of compliance properties. example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' language: $ref: '#/components/schemas/LanguageMember' x-property-sort: - attributes - language example: example_value PostNotationCrossReferenceListByInstrumentRequest: x-property-sort: - data - meta description: Request Body type: object properties: data: type: object x-property-sort: - identifier - filter description: The data member contains the request's primary data. properties: identifier: type: object x-property-sort: - value - type description: Identifier and type. properties: value: 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. type: 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: - value - type filter: type: object x-property-sort: - markets - valueUnits - onlyActive description: Criteria that filter the items in the response list; only items that match all of the criteria are returned. properties: markets: type: object x-property-sort: - ids description: Filter for specific markets. properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true maxItems: 100 minItems: 1 description: List of market ids. valueUnits: type: object x-property-sort: - ids description: Filter for specific value units. properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true maxItems: 100 minItems: 1 description: List of value unit ids. onlyActive: type: boolean default: false description: If true, only active notations will be returned. The term "active" reflects the fact that notations and related data is not being deleted immediately after becoming irrelevant (e.g. because the source does not provide a price anymore), but remains in general retrievable for up to 6 months. required: - identifier example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' language: $ref: '#/components/schemas/LanguageMember' x-property-sort: - attributes - language example: example_value PostInstrumentRatingGradeListRequest: x-property-sort: - data - meta description: Request Body type: object properties: data: type: object x-property-sort: - identifier - filter description: The data member contains the request's primary data. properties: identifier: type: object x-property-sort: - values - type description: Set of identifiers and their type. properties: values: 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}-[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]$ uniqueItems: true minItems: 1 maxItems: 100 type: 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: - values - type filter: type: object x-property-sort: - ratingSystem description: Criteria that filter the items in the response list; only items that match all of the criteria are returned. properties: ratingSystem: type: object x-property-sort: - ids description: Rating system. properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true description: List of rating system identifiers. See endpoint `/rating/system/list` for valid values. uniqueItems: true maxItems: 10 required: - identifier example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' x-property-sort: - attributes example: example_value PostDebtInstrumentNotationScreenerSearchRequest: type: object properties: data: type: object x-property-sort: - validation - lifeCycle - subordinated - rating - issuer - issue - tradingVolume - compliance - coupon - yield - macaulayDuration - sensitivities - tradedValue description: The data member contains the request's primary data. properties: validation: description: Validation parameters. type: object x-property-sort: - onlyActive - onlyNotSuspended - prices - valueUnit - market - instrumentSelectionList - notationSelectionList - categorization properties: onlyActive: description: If `true`, only active notations will be returned. The term "active" reflects the fact that notations and related data is not being deleted immediately after becoming irrelevant (e.g. because the source does not provide a price anymore), but remains in general retrievable for up to 6 months. type: boolean default: true onlyNotSuspended: description: If `true`, only notations not suspended from trading will be returned. type: boolean default: false prices: description: Price-related parameters. type: object x-property-sort: - quality - latest - previous properties: quality: type: string description: Quality of the price. default: DLY x-enum-description: - 'Delayed: intraday prices with an exchange-imposed delay of usually 15 to 30 minutes.' - 'End-of-day: prices updated once per day after the close of trading, possibly with an exchange-imposed delay of several hours or days.' enum: - DLY - EOD latest: description: Parameters related to the presence and age of the most recent trade price. type: object x-property-sort: - availableOnly - minimumDate properties: availableOnly: description: If `true`, only notations for which a trade price (even an outdated one) is available will be returned. type: boolean minimumDate: description: Earliest admissible date of the most recent trade price. type: string format: date previous: description: Parameters related to the presence and age of a trade price from a preceding trading day. type: object x-property-sort: - availableOnly - minimumDate properties: availableOnly: description: If `true`, only notations for which a trade price from a preceding trading day is available will be returned. type: boolean minimumDate: description: Earliest admissible date of the trade price from a preceding trading day. type: string format: date valueUnit: description: Value unit selection. See endpoint `/basic/valueUnit/list` for valid values. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Specifies the value units a notation may have. type: object x-property-sort: - ids properties: ids: description: Set of value unit identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 50 exclude: description: Specifies the value units a notation may not have. type: object x-property-sort: - ids properties: ids: description: Set of value unit identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 50 market: description: Market-related notation selection. See endpoint `/basic/market/list` for valid values. type: object x-property-sort: - selection - priority properties: selection: description: Market selection. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Specifies the markets from which a notation may originate. type: object x-property-sort: - ids properties: ids: description: Set of market identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 exclude: description: Specifies the markets from which a notation may not originate. type: object x-property-sort: - ids properties: ids: description: Set of market identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 priority: description: "Sequence of markets specifying the priority order of the markets for the selection of one notation per instrument. If for a given instrument with two matching notations, A and B, the market of notation A precedes the market of notation B in this list or if the market of notation B is not in this list, A is selected. If neither of the markets is in this list, the notation with the highest trading volume, averaged over one month, is selected. \n The list does not restrict the request to only those markets (use the parameter `market.selection` for that purpose)." type: object x-property-sort: - ids properties: ids: description: List of market identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 instrumentSelectionList: description: Instrument-level restriction or exclusion. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Restriction lists. If present, the result contains only notations belonging to debt instruments that are a member of any of the provided lists. type: object x-property-sort: - ids properties: ids: description: Set of identifiers of restriction lists. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 3 exclude: description: Exclusion lists. If present, the result does not contain notations belonging to debt instruments that are a member of any of the provided lists. type: object x-property-sort: - ids properties: ids: description: Set of identifiers of exclusion lists. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 3 notationSelectionList: description: Notation-level restriction or exclusion. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Restriction lists. If present, the result contains only debt instrument notations that are a member of any of the provided lists. type: object x-property-sort: - ids properties: ids: description: Set of identifiers of restriction lists. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 3 exclude: description: Exclusion lists. If present, the result does not contain debt instrument notations that are a member of any of the provided lists. type: object x-property-sort: - ids properties: ids: description: Set of identifiers of exclusion lists. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 3 categorization: description: Debt instrument categorization. See endpoint `/category/listBySystem` with `id=18` for valid values. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Restriction list. Only debt instruments that belong to a category in the provided list are returned. type: object x-property-sort: - ids properties: ids: description: Set of category identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 20 exclude: description: Exclusion lists. Debt instruments that belong to a category in the provided list are not returned. type: object x-property-sort: - ids properties: ids: description: Set of category identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 20 lifeCycle: description: Parameters related to important dates. type: object x-property-sort: - issue - maturity - callable properties: issue: type: object format: dateRange x-isClosedInterval: true properties: start: type: string format: date description: The starting point of the date range (inclusive), or `null` to indicate that the date range extends indefinitely into the past. x-allowNullValue: true end: type: string format: date description: The ending point of the date range (inclusive), or `null` to indicate that the date range extends indefinitely into the future. x-allowNullValue: true x-property-sort: - start - end required: - start - end description: Date range of the issue date. maturity: description: Parameters related to the maturity. type: object x-property-sort: - restriction - perpetual properties: restriction: description: The maturity can be restricted by using one of the parameters `date` or `remainingTermYears` but not both at the same time. If a maturity restriction is set, perpetual instruments, i.e. such that do not mature, are not included in the result unless the parameter `perpetual` is set to "include". type: object x-property-sort: - date - remainingTermYears x-atMostOne: true properties: date: type: object format: dateRange x-isClosedInterval: true properties: start: type: string format: date description: The starting point of the date range (inclusive), or `null` to indicate that the date range extends indefinitely into the past. x-allowNullValue: true end: type: string format: date description: The ending point of the date range (inclusive), or `null` to indicate that the date range extends indefinitely into the future. x-allowNullValue: true x-property-sort: - start - end required: - start - end description: Date range of the maturity date. remainingTermYears: description: Value range for the remaining term to maturity expressed in years. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum perpetual: type: string description: Defines whether or not perpetual debt instruments, i.e. such that do not mature, are included in the result. The value "only" can be used if both parameters `maturity.restriction.date` and `maturity.restriction.remainingTermYears` are not set. x-enum-description: - Only perpetual debt instruments are included in the result. - Perpetual debt instruments are included in the result even if one of the parameters `maturity.restriction.date` or `maturity.restriction.remainingTermYears` is set. - Perpetual debt instruments are excluded from the result. enum: - only - include - exclude callable: type: boolean description: Restricts the result to debt instruments that are callable (`true`) or are not callable (`false`). A callable instrument is one that may be redeemed by the issuer prior to maturity. subordinated: description: Restricts the result to debt instruments that are subordinated (`true`) or are not subordinated (`false`). In case of default, subordinated debt instruments are redeemed with a lower priority than non-subordinated. type: boolean rating: description: Parameters related to a rating of a debt instrument. type: object x-property-sort: - grade properties: grade: description: Rating grade. type: object x-property-sort: - minimum properties: minimum: description: Minimum rating grade. type: object x-property-sort: - ids properties: ids: description: List of rating grade identifiers. Allowed are at most two identifiers which must refer to rating grades originating from different rating systems. Only debt instruments that satisfy all conditions, i.e. are rated higher than or equal to all provided rating grades, are returned. The sequence of the provided identifiers corresponds to the response attributes `ratingSystem1` and `ratingSystem2` respectively, i.e. the rating grade of a debt instrument in the rating system of which the first identifier in the provided list is a member, is represented by the attribute `ratingSystem1.rating.grade` (and `ratingSystem1.rating.id` for the identifier of the rating grade). type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 2 issuer: description: Parameters related to the issuer. type: object x-property-sort: - selection - country properties: selection: description: Issuer selection. See endpoint `/debtInstrument/issuer/search` for valid values. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Restriction list. Only debt instruments issued by an issuer in the provided list are returned. type: object x-property-sort: - ids properties: ids: description: Set of identifiers of legal entities in the role of an issuer. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 exclude: description: Exclusion list. Debt instruments issued by an issuer in the provided list are not returned. type: object x-property-sort: - ids properties: ids: description: Set of identifiers of legal entities in the role of an issuer. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 country: description: Selection of the country of registration of the debt instrtuments' issuer. See endpoint `/basic/region/country/list` for valid values. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Restriction list. Only debt instruments issued by an issuer whose country of registration is in the provided list are returned. type: object x-property-sort: - ids properties: ids: description: Set of country identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 50 exclude: description: Exclusion list. Debt instruments issued by an issuer whose country of registration is in the provided list are not returned. type: object x-property-sort: - ids properties: ids: description: Set of country identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 50 issue: description: Parameters related to the issue. type: object x-property-sort: - volume properties: volume: description: Issue volume. type: object x-property-sort: - currency properties: currency: description: Selection of the main currency of denomination of the issue volume. See endpoint `/basic/valueUnit/currency/main/list` for valid values. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Restriction list. Only debt instruments with a main currency of denomination in the provided list are returned. type: object x-property-sort: - ids properties: ids: description: Set of main currency identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 50 exclude: description: Exclusion list. Debt instruments with a main currency of denomination in the provided list are not returned. type: object x-property-sort: - ids properties: ids: description: Set of main currency identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 50 tradingVolume: description: Parameters regarding the trading volume. The issuer of a debt instrument may define a minimum trading volume, and an increment over that minimum, per market place and for the over-the-counter (e.g. interbank) trade. Orders that do not match the defined volumes cannot be (fully) executed. The currency is the currency of denomination, thus the parameter `issue.volume.currency.restrict.ids` must be set to exactly one currency in order to use this parameter. type: object x-property-sort: - otc properties: otc: description: Volume applicable to the over-the-counter (non-exchange based) trading. type: object x-property-sort: - minimum properties: minimum: description: Value range for the minimum trading volume. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum compliance: description: Compliance properties. type: object x-property-sort: - germany properties: germany: description: Compliance properties in accordance with the German law. type: object x-property-sort: - trusteeEligible properties: trusteeEligible: type: boolean description: Defines whether or not the debt instruments are eligible for investment by trustees according to §§1806ff of the BGB (German Civil Code). The German legislative has declared such debt instruments to be virtually free of the risk of loss, such as government and state bonds. Eligible are primarily German debt instruments. coupon: description: Parameters regarding the interest rate. type: object x-property-sort: - occurrence - currentInterestRate properties: occurrence: description: Parameters regarding the occurrence and frequency of the coupon payments. type: object x-property-sort: - type - frequency properties: type: type: array nullable: false items: type: string x-enum-description: - Include debt instruments that do not pay a coupon. - Include debt instruments that pay a coupon only once. - Include debt instruments that pay a coupon on a repeated basis, possibly further limited by `occurrence.frequency`. enum: - never - once - repeated description: Occurrence type of the coupon payments. uniqueItems: true frequency: description: Frequency of the coupon payments. This filter is only applied to debt instruments whose `coupon.occurrence.type` is `repeated`. If this parameter is set, `occurrence.type` must include the value `repeated` or must not be set (in which case `repeated` is implied). type: object x-property-sort: - ids properties: ids: description: List of frequency identifiers. See endpoint `/basic/frequency/type/list` for valid values. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 9 currentInterestRate: description: Interest rate of the current coupon period. Not available for debt instruments with an occurrence type of the coupon payments "never". type: object x-property-sort: - type - value properties: type: description: Type of the interest rate. type: object x-property-sort: - ids properties: ids: description: List of interest rate type identifiers. See endpoint `/instrument/coupon/interestRate/type/list` for valid values. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 5 value: description: Value range for the interest rate of the current coupon period; annualized if the payment frequency is not "annually". Not available for debt instruments with a current interest rate type other than "fixed rate" (`id=2`) or "step/reset" (`id=5`). type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum yield: description: Parameters related to the yield. type: object x-property-sort: - current - toMaturity - spread properties: current: description: Value range for the 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. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum toMaturity: description: Value range for the yield to maturity, which is the annual rate of return, assuming the instrument is held until maturity. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum spread: description: Value range for the credit spread (the difference in yield to maturity) between a debt instrument and its benchmark bond. See endpoint `/instrument/benchmark/list` for the benchmark bond. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum macaulayDuration: description: Value range for the Macaulay duration, which is the average period (in years) of capital commitment. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum sensitivities: description: Parameters related to the price sensitivities of debt instruments with respect to the prevailing market interest rate. type: object x-property-sort: - basePointValue - modifiedDuration - elasticity - convexity properties: basePointValue: description: Value range for the 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). The unit of the base point value is the value unit of the notation, thus the parameter `validation.valueUnit.restrict.ids` must be set to exactly one value unit in order to use the parameter. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum modifiedDuration: description: Value range for the 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. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum elasticity: description: Value range for the 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. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum convexity: description: Value range for the convexity, which is a measure for the change of the modified duration as the prevailing market interest rate changes. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum tradedValue: description: Parameters regarding the cash flow for all transactions over a certain time range. The currency is the currency of denomination, thus the parameter `issue.volume.currency.restrict.ids` must be set to exactly one currency in order to use these parameters. type: object x-property-sort: - days30 properties: days30: description: Cash flow for the time range 30 trading days. type: object x-property-sort: - sum - average properties: sum: description: Value range for the sum of the cash flow. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum average: description: Value range for the average daily cash flow. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' language: $ref: '#/components/schemas/LanguageMember' sort: description: Sortable attributes. The sort order is ascending unless it is prefixed with a minus sign, in which case it is descending. A list of at most 10 (possibly prefixed) attribute name(s) is allowed. type: array items: type: string enum: - valueUnit.code - -valueUnit.code - market.name - -market.name - symbol - -symbol - instrument.name - -instrument.name - instrument.shortName - -instrument.shortName - instrument.categorization.level1.name - -instrument.categorization.level1.name - instrument.categorization.level2.name - -instrument.categorization.level2.name - instrument.categorization.level3.name - -instrument.categorization.level3.name - instrument.lifeCycle.issue - -instrument.lifeCycle.issue - instrument.lifeCycle.maturity.date - -instrument.lifeCycle.maturity.date - instrument.lifeCycle.maturity.remainingTermYears - -instrument.lifeCycle.maturity.remainingTermYears - instrument.lifeCycle.maturity.perpetual - -instrument.lifeCycle.maturity.perpetual - instrument.lifeCycle.callable - -instrument.lifeCycle.callable - instrument.subordinated - -instrument.subordinated - instrument.ratingSystem1.rating.grade - -instrument.ratingSystem1.rating.grade - instrument.ratingSystem2.rating.grade - -instrument.ratingSystem2.rating.grade - instrument.issuer.name - -instrument.issuer.name - instrument.issuer.country.name - -instrument.issuer.country.name - instrument.issue.volume.currency.isoCode - -instrument.issue.volume.currency.isoCode - instrument.tradingVolume.otc.minimum - -instrument.tradingVolume.otc.minimum - instrument.compliance.germany.trusteeEligible - -instrument.compliance.germany.trusteeEligible - instrument.coupon.occurrence.frequency.name - -instrument.coupon.occurrence.frequency.name - instrument.coupon.currentInterestRate.type.name - -instrument.coupon.currentInterestRate.type.name - instrument.coupon.currentInterestRate.value - -instrument.coupon.currentInterestRate.value - yield.current - -yield.current - yield.toMaturity - -yield.toMaturity - yield.spread - -yield.spread - macaulayDuration - -macaulayDuration - sensitivities.basePointValue - -sensitivities.basePointValue - sensitivities.modifiedDuration - -sensitivities.modifiedDuration - sensitivities.elasticity - -sensitivities.elasticity - sensitivities.convexity - -sensitivities.convexity - tradedValue.days30.sum - -tradedValue.days30.sum - tradedValue.days30.average - -tradedValue.days30.average maxItems: 10 uniqueItems: true default: - instrument.name pagination: type: object description: Pagination attributes for the offset-based pagination strategy. properties: offset: type: number format: int32 minimum: 0 exclusiveMinimum: false default: 0 description: Non-negative number of entries to skip, or 0 (default). limit: type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 500 exclusiveMaximum: false default: 20 description: Non-negative maximum number of entries to return. x-property-sort: - offset - limit x-property-sort: - attributes - language - sort - pagination example: example_value PostDebtInstrumentNotationScreenerValueRangesGetRequest: type: object properties: data: type: object x-property-sort: - validation - lifeCycle - subordinated - rating - issuer - issue - tradingVolume - compliance - coupon - yield - macaulayDuration - sensitivities - tradedValue description: The data member contains the request's primary data. properties: validation: description: Validation parameters. type: object x-property-sort: - onlyActive - onlyNotSuspended - prices - valueUnit - market - instrumentSelectionList - notationSelectionList - categorization properties: onlyActive: description: If `true`, only active notations will be returned. The term "active" reflects the fact that notations and related data is not being deleted immediately after becoming irrelevant (e.g. because the source does not provide a price anymore), but remains in general retrievable for up to 6 months. type: boolean default: true onlyNotSuspended: description: If `true`, only notations not suspended from trading will be returned. type: boolean default: false prices: description: Price-related parameters. type: object x-property-sort: - quality - latest - previous properties: quality: type: string description: Quality of the price. default: DLY x-enum-description: - 'Delayed: intraday prices with an exchange-imposed delay of usually 15 to 30 minutes.' - 'End-of-day: prices updated once per day after the close of trading, possibly with an exchange-imposed delay of several hours or days.' enum: - DLY - EOD latest: description: Parameters related to the presence and age of the most recent trade price. type: object x-property-sort: - availableOnly - minimumDate properties: availableOnly: description: If `true`, only notations for which a trade price (even an outdated one) is available will be returned. type: boolean minimumDate: description: Earliest admissible date of the most recent trade price. type: string format: date previous: description: Parameters related to the presence and age of a trade price from a preceding trading day. type: object x-property-sort: - availableOnly - minimumDate properties: availableOnly: description: If `true`, only notations for which a trade price from a preceding trading day is available will be returned. type: boolean minimumDate: description: Earliest admissible date of the trade price from a preceding trading day. type: string format: date valueUnit: description: Value unit selection. See endpoint `/basic/valueUnit/list` for valid values. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Specifies the value units a notation may have. type: object x-property-sort: - ids properties: ids: description: Set of value unit identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 50 exclude: description: Specifies the value units a notation may not have. type: object x-property-sort: - ids properties: ids: description: Set of value unit identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 50 market: description: Market-related notation selection. See endpoint `/basic/market/list` for valid values. type: object x-property-sort: - selection - priority properties: selection: description: Market selection. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Specifies the markets from which a notation may originate. type: object x-property-sort: - ids properties: ids: description: Set of market identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 exclude: description: Specifies the markets from which a notation may not originate. type: object x-property-sort: - ids properties: ids: description: Set of market identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 priority: description: "Sequence of markets specifying the priority order of the markets for the selection of one notation per instrument. If for a given instrument with two matching notations, A and B, the market of notation A precedes the market of notation B in this list or if the market of notation B is not in this list, A is selected. If neither of the markets is in this list, the notation with the highest trading volume, averaged over one month, is selected. \n The list does not restrict the request to only those markets (use the parameter `market.selection` for that purpose)." type: object x-property-sort: - ids properties: ids: description: List of market identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 instrumentSelectionList: description: Instrument-level restriction or exclusion. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Restriction lists. If present, the result contains only notations belonging to debt instruments that are a member of any of the provided lists. type: object x-property-sort: - ids properties: ids: description: Set of identifiers of restriction lists. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 3 exclude: description: Exclusion lists. If present, the result does not contain notations belonging to debt instruments that are a member of any of the provided lists. type: object x-property-sort: - ids properties: ids: description: Set of identifiers of exclusion lists. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 3 notationSelectionList: description: Notation-level restriction or exclusion. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Restriction lists. If present, the result contains only debt instrument notations that are a member of any of the provided lists. type: object x-property-sort: - ids properties: ids: description: Set of identifiers of restriction lists. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 3 exclude: description: Exclusion lists. If present, the result does not contain debt instrument notations that are a member of any of the provided lists. type: object x-property-sort: - ids properties: ids: description: Set of identifiers of exclusion lists. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 3 categorization: description: Debt instrument categorization. See endpoint `/category/listBySystem` with `id=18` for valid values. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Restriction list. Only debt instruments that belong to a category in the provided list are returned. type: object x-property-sort: - ids properties: ids: description: Set of category identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 20 exclude: description: Exclusion lists. Debt instruments that belong to a category in the provided list are not returned. type: object x-property-sort: - ids properties: ids: description: Set of category identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 20 lifeCycle: description: Parameters related to important dates. type: object x-property-sort: - issue - maturity - callable properties: issue: type: object format: dateRange x-isClosedInterval: true properties: start: type: string format: date description: The starting point of the date range (inclusive), or `null` to indicate that the date range extends indefinitely into the past. x-allowNullValue: true end: type: string format: date description: The ending point of the date range (inclusive), or `null` to indicate that the date range extends indefinitely into the future. x-allowNullValue: true x-property-sort: - start - end required: - start - end description: Date range of the issue date. maturity: description: Parameters related to the maturity. type: object x-property-sort: - restriction - perpetual properties: restriction: description: The maturity can be restricted by using one of the parameters `date` or `remainingTermYears` but not both at the same time. If a maturity restriction is set, perpetual instruments, i.e. such that do not mature, are not included in the result unless the parameter `perpetual` is set to "include". type: object x-property-sort: - date - remainingTermYears x-atMostOne: true properties: date: type: object format: dateRange x-isClosedInterval: true properties: start: type: string format: date description: The starting point of the date range (inclusive), or `null` to indicate that the date range extends indefinitely into the past. x-allowNullValue: true end: type: string format: date description: The ending point of the date range (inclusive), or `null` to indicate that the date range extends indefinitely into the future. x-allowNullValue: true x-property-sort: - start - end required: - start - end description: Date range of the maturity date. remainingTermYears: description: Value range for the remaining term to maturity expressed in years. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum perpetual: type: string description: Defines whether or not perpetual debt instruments, i.e. such that do not mature, are included in the result. The value "only" can be used if both parameters `maturity.restriction.date` and `maturity.restriction.remainingTermYears` are not set. x-enum-description: - Only perpetual debt instruments are included in the result. - Perpetual debt instruments are included in the result even if one of the parameters `maturity.restriction.date` or `maturity.restriction.remainingTermYears` is set. - Perpetual debt instruments are excluded from the result. enum: - only - include - exclude callable: type: boolean description: Restricts the result to debt instruments that are callable (`true`) or are not callable (`false`). A callable instrument is one that may be redeemed by the issuer prior to maturity. subordinated: description: Restricts the result to debt instruments that are subordinated (`true`) or are not subordinated (`false`). In case of default, subordinated debt instruments are redeemed with a lower priority than non-subordinated. type: boolean rating: description: Parameters related to a rating of a debt instrument. If a rating system is not selected by either specifying it directly (see parameter `rating.system.ids`) or by implying it via the minimum rating grade (see parameter `rating.grade.minimum.ids`) the result contains no data on ratings. type: object x-property-sort: - system - grade x-atMostOne: true properties: system: description: Rating system. The parameter allows to specify the rating system (up to two) from which the available ratings of the restricted set of debt instruments are retrieved without limiting the debt instrument selection to only debt instruments with a rating in that rating system. type: object x-property-sort: - ids properties: ids: description: List of identifiers of rating systems. The sequence of the provided identifiers corresponds to the response attributes `ratingSystem1` and `ratingSystem2` respectively, i.e. the rating grades of the selected debt instruments in the rating system of which the first identifier in the provided list is a member, is represented by the attribute `ratingSystem1.rating.grade` (and `ratingSystem1.rating.id` for the identifier of the rating grade). type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 2 grade: description: Rating grade. type: object x-property-sort: - minimum properties: minimum: description: Minimum rating grade. type: object x-property-sort: - ids properties: ids: description: List of rating grade identifiers. Allowed are at most two identifiers which must refer to rating grades originating from different rating systems. Only debt instruments that satisfy all conditions, i.e. are rated higher than or equal to all provided rating grades, are returned. The sequence of the provided identifiers corresponds to the response attributes `ratingSystem1` and `ratingSystem2` respectively, i.e. the rating grade of a debt instrument in the rating system of which the first identifier in the provided list is a member, is represented by the attribute `ratingSystem1.rating.grade` (and `ratingSystem1.rating.id` for the identifier of the rating grade). type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 2 issuer: description: Parameters related to the issuer. type: object x-property-sort: - selection - country properties: selection: description: Issuer selection. See endpoint `/debtInstrument/issuer/search` for valid values. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Restriction list. Only debt instruments issued by an issuer in the provided list are returned. type: object x-property-sort: - ids properties: ids: description: Set of identifiers of legal entities in the role of an issuer. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 exclude: description: Exclusion list. Debt instruments issued by an issuer in the provided list are not returned. type: object x-property-sort: - ids properties: ids: description: Set of identifiers of legal entities in the role of an issuer. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 country: description: Selection of the country of registration of the debt instrtuments' issuer. See endpoint `/basic/region/country/list` for valid values. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Restriction list. Only debt instruments issued by an issuer whose country of registration is in the provided list are returned. type: object x-property-sort: - ids properties: ids: description: Set of country identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 50 exclude: description: Exclusion list. Debt instruments issued by an issuer whose country of registration is in the provided list are not returned. type: object x-property-sort: - ids properties: ids: description: Set of country identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 50 issue: description: Parameters related to the issue. type: object x-property-sort: - volume properties: volume: description: Issue volume. type: object x-property-sort: - currency properties: currency: description: Selection of the main currency of denomination of the issue volume. See endpoint `/basic/valueUnit/currency/main/list` for valid values. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: Restriction list. Only debt instruments with a main currency of denomination in the provided list are returned. type: object x-property-sort: - ids properties: ids: description: Set of main currency identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 50 exclude: description: Exclusion list. Debt instruments with a main currency of denomination in the provided list are not returned. type: object x-property-sort: - ids properties: ids: description: Set of main currency identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 50 tradingVolume: description: Parameters regarding the trading volume. The issuer of a debt instrument may define a minimum trading volume, and an increment over that minimum, per market place and for the over-the-counter (e.g. interbank) trade. Orders that do not match the defined volumes cannot be (fully) executed. The currency is the currency of denomination, thus the parameter `issue.volume.currency.restrict.ids` must be set to exactly one currency in order to use this parameter. type: object x-property-sort: - otc properties: otc: description: Volume applicable to the over-the-counter (non-exchange based) trading. type: object x-property-sort: - minimum properties: minimum: description: Value range for the minimum trading volume. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum compliance: description: Compliance properties. type: object x-property-sort: - germany properties: germany: description: Compliance properties in accordance with the German law. type: object x-property-sort: - trusteeEligible properties: trusteeEligible: type: boolean description: Defines whether or not the debt instruments are eligible for investment by trustees according to §§1806ff of the BGB (German Civil Code). The German legislative has declared such debt instruments to be virtually free of the risk of loss, such as government and state bonds. Eligible are primarily German debt instruments. coupon: description: Parameters regarding the interest rate. type: object x-property-sort: - occurrence - currentInterestRate properties: occurrence: description: Parameters regarding the occurrence and frequency of the coupon payments. type: object x-property-sort: - type - frequency properties: type: type: array nullable: false items: type: string x-enum-description: - Include debt instruments that do not pay a coupon. - Include debt instruments that pay a coupon only once. - Include debt instruments that pay a coupon on a repeated basis, possibly further limited by `occurrence.frequency`. enum: - never - once - repeated description: Occurrence type of the coupon payments. uniqueItems: true frequency: description: Frequency of the coupon payments. This filter is only applied to debt instruments whose `coupon.occurrence.type` is `repeated`. If this parameter is set, `occurrence.type` must include the value `repeated` or must not be set (in which case `repeated` is implied). type: object x-property-sort: - ids properties: ids: description: List of frequency identifiers. See endpoint `/basic/frequency/type/list` for valid values. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 9 currentInterestRate: description: Interest rate of the current coupon period. Not available for debt instruments with an occurrence type of the coupon payments "never". type: object x-property-sort: - type - value properties: type: description: Type of the interest rate. type: object x-property-sort: - ids properties: ids: description: List of interest rate type identifiers. See endpoint `/instrument/coupon/interestRate/type/list` for valid values. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 5 value: description: Value range for the interest rate of the current coupon period; annualized if the payment frequency is not "annually". Not available for debt instruments with a current interest rate type other than "fixed rate" (`id=2`) or "step/reset" (`id=5`). type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum yield: description: Parameters related to the yield. type: object x-property-sort: - current - toMaturity - spread properties: current: description: Value range for the 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. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum toMaturity: description: Value range for the yield to maturity, which is the annual rate of return, assuming the instrument is held until maturity. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum spread: description: Value range for the credit spread (the difference in yield to maturity) between a debt instrument and its benchmark bond. See endpoint `/instrument/benchmark/list` for the benchmark bond. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum macaulayDuration: description: Value range for the Macaulay duration, which is the average period (in years) of capital commitment. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum sensitivities: description: Parameters related to the price sensitivities of debt instruments with respect to the prevailing market interest rate. type: object x-property-sort: - basePointValue - modifiedDuration - elasticity - convexity properties: basePointValue: description: Value range for the 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). The unit of the base point value is the value unit of the notation, thus the parameter `validation.valueUnit.restrict.ids` must be set to exactly one value unit in order to use the parameter. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum modifiedDuration: description: Value range for the 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. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum elasticity: description: Value range for the 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. type: object format: relativeValueRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: relativeValue description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: relativeValue description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum convexity: description: Value range for the convexity, which is a measure for the change of the modified duration as the prevailing market interest rate changes. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum tradedValue: description: Parameters regarding the cash flow for all transactions over a certain time range. The currency is the currency of denomination, thus the parameter `issue.volume.currency.restrict.ids` must be set to exactly one currency in order to use these parameters. type: object x-property-sort: - days30 properties: days30: description: Cash flow for the time range 30 trading days. type: object x-property-sort: - sum - average properties: sum: description: Value range for the sum of the cash flow. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum average: description: Value range for the average daily cash flow. type: object format: realRange properties: minimum: type: object x-property-sort: - value - inclusive description: The minimum of the range, or `null` to indicate that there is no minimum. properties: value: type: number format: real description: The minimum value. inclusive: type: boolean description: Indicates whether the minimum value is included in the range or not. default: true x-allowNullValue: true maximum: type: object x-property-sort: - value - inclusive description: The maximum of the range, or `null` to indicate that there is no maximum. properties: value: type: number format: real description: The maximum value. inclusive: type: boolean description: Indicates whether the maximum value is included in the range or not. default: true x-allowNullValue: true x-property-sort: - minimum - maximum example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' language: $ref: '#/components/schemas/LanguageMember' x-property-sort: - attributes - language example: example_value PostInstrumentCrossReferenceListByWKNRequest: x-property-sort: - data - meta description: Request Body required: - data type: object properties: data: type: object x-property-sort: - wkns description: The data member contains the request's primary data. properties: wkns: description: List of source WKNs to be translated. type: array nullable: false items: type: string minLength: 6 exclusiveMinimum: false maxLength: 6 exclusiveMaximum: false pattern: ^[A-Z0-9]*$ uniqueItems: true minItems: 1 maxItems: 10 required: - wkns example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' x-property-sort: - attributes example: example_value CursorBasedPaginationOutputObjectWithoutTotal: type: object description: Pagination attributes for the cursor-based pagination strategy; a total element count is not supported. properties: next: type: string description: The next cursor position to use in the parameter `pagination.cursor` for an endpoint that supports cursor-based pagination, otherwise `null`. example: example_value previous: type: string description: The previous cursor position to use in the parameter `pagination.cursor` for an endpoint that supports cursor-based pagination. If a previous cursor position is not supported or available, `previous` is `null`. example: example_value required: - next - previous x-property-sort: - next - previous PostInstrumentSelectionListMembersListRequest: x-property-sort: - data - meta description: Request Body type: object properties: data: type: object x-property-sort: - id - filter description: The data member contains the request's primary data. properties: id: type: number format: id32 x-positive: true description: Identifier of a selection list. filter: type: object x-property-sort: - assetClass - category description: Criteria that filter the items in the response list; only items that match all of the criteria are returned. properties: assetClass: type: object x-property-sort: - ids description: Asset class restriction. properties: ids: description: Set of asset class identifiers. See endpoint `/basic/assetClass/list` for valid values. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 12 category: type: object x-property-sort: - restrict - exclude description: Category selection. Identifiers from all entitled category systems can be used, see endpoint `/category/system/list` with `idType=1` for the list of category systems. x-atMostOne: true properties: restrict: type: object x-property-sort: - ids description: Specifies the categories that the instruments may have. properties: ids: description: Set of category identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 20 exclude: type: object x-property-sort: - ids description: Specifies the categories that the instruments may not have. properties: ids: description: Set of category identifiers. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 20 required: - id example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' language: $ref: '#/components/schemas/LanguageMember' sort: description: Sortable attributes. The sort order is ascending unless it is prefixed with a minus sign, in which case it is descending. A list of at most 4 (possibly prefixed) attribute name(s) is allowed. type: array items: type: string enum: - name.default.long - -name.default.long - name.default.short - -name.default.short - name.assetClassSpecific.long - -name.assetClassSpecific.long - name.assetClassSpecific.short - -name.assetClassSpecific.short maxItems: 4 uniqueItems: true default: - name.default.long pagination: type: object description: Pagination attributes for the offset-based pagination strategy. properties: offset: type: number format: int32 minimum: 0 exclusiveMinimum: false default: 0 description: Non-negative number of entries to skip, or 0 (default). limit: type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 500 exclusiveMaximum: false default: 20 description: Non-negative maximum number of entries to return. x-property-sort: - offset - limit x-property-sort: - attributes - language - sort - pagination example: example_value OffsetBasedPaginationOutputObject: type: object description: Pagination attributes for the offset-based pagination strategy. properties: total: type: number format: int32 description: Total number of entries in the result set. example: 42.5 isEstimatedTotal: type: boolean description: Flag indicating that the value of "total" is estimated. example: true required: - total - isEstimatedTotal x-property-sort: - total - isEstimatedTotal responses: PostInstrumentCrossReferenceListByISIN200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of instruments. nullable: false items: type: object nullable: false x-property-sort: - id - fsym - validity - sourceIsin - status properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the instrument. fsym: nullable: false type: object x-property-sort: - security description: Instrument-level FactSet identifier of the financial instrument used primarily in FactSet products other than the MDG. properties: security: nullable: false type: object x-property-sort: - permanentIdentifier description: Security-level identifier. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for an instrument. The format is six alpha numeric characters, excluding vowels, with an S suffix (XXXXXX-S). validity: nullable: true type: object format: timeRange properties: start: nullable: true type: string format: datetime description: The starting point of the time range (inclusive). end: nullable: true type: string format: datetime description: The ending point of the time range (exclusive), or `null` to indicate that the time range extends indefinitely into the future. x-property-sort: - start - end required: - start - end description: Time range that this translation is valid for. sourceIsin: nullable: true type: string format: isin description: The source ISIN that the instrument is translated for. status: nullable: false type: object x-property-sort: - code - identifier 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 ISIN. - Not entitled to see data for the instrument. enum: - none - parameter - entitlement identifier: nullable: true type: string format: isin description: Provided identifier. 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 GetDebtInstrumentGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: description: Fundamental data for a debt instrument. nullable: false type: object x-property-sort: - isin - nsin - name - shortName - type - lifeCycle - issuer - issue - tradingVolume - redemption - nominalValue - debtRanking - germany properties: isin: nullable: true type: string format: isin description: The International Securities Identification Number (ISIN) of the instrument. The ISIN is a 12-character code of digits and upper-case letters that uniquely identifies an instrument. nsin: nullable: false type: object x-property-sort: - wkn - valor description: NSIN data of the instrument. properties: wkn: nullable: true type: string description: The WKN (Wertpapierkennnummer, German for Securities Identification Number) of the instrument. The WKN is a 6-character code of digits and upper-case letters that uniquely identifies an instrument. valor: nullable: true type: string description: 'The Valor number (German: Valorennummer) of the instrument. The Valor number is an integer number that uniquely identifies an instrument.' name: nullable: true type: string format: localizedString description: Name of the instrument. shortName: nullable: true type: string format: localizedString description: Short name of the instrument. type: nullable: false description: Instrument type as defined by FactSet Digital Solutions. Instrument types are arranged in a hierarchy, with the first level representing the most coarse granularity and further levels successively refining the granularity (see MDG category system 18). See endpoint `/category/get` for possible values. type: array items: type: object nullable: false x-property-sort: - id - name properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the instrument type. name: nullable: true type: string format: localizedString description: Name of the instrument type. lifeCycle: nullable: false type: object x-property-sort: - issue - maturity description: Important dates of the instrument. properties: issue: nullable: true type: string format: date description: Date of the issue. maturity: nullable: false type: object x-property-sort: - date - isPerpetual - isCallable description: Maturity data. properties: date: nullable: true type: string format: date description: Date of the instrument's maturity. The value is empty if the instrument is perpetual. isPerpetual: nullable: true type: boolean description: If true, the instrument is perpetual, i.e. it does not mature, therefore the attribute `date` is null. isCallable: nullable: true type: boolean description: If true, the issuer may redeem the instrument prior to maturity. issuer: nullable: false type: object x-property-sort: - id - name - lei description: Issuer of the instrument. See endpoint `/legalEntity/list` for possible values. properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the issuer. name: nullable: true type: string description: Name of the issuer. lei: nullable: true type: string description: Legal Entity Identifier of the issuer. issue: nullable: false type: object x-property-sort: - price - volume description: Issue data of the instrument. properties: price: nullable: false type: object x-property-sort: - value - valueUnit description: Issue price data. properties: value: nullable: true type: number format: real description: Issue price. valueUnit: nullable: false type: object x-property-sort: - id - code description: Value unit of the issue price such as percentages for a debt instrument quoted in percent, or a main or a fractional currency for a per-unit-quoted debt instrument (rarely). 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. volume: nullable: false type: object x-property-sort: - amount - currency description: Issue volume data. properties: amount: nullable: true type: number format: real description: Issue volume. currency: nullable: false type: object x-property-sort: - id - code - isoCode description: Main currency of denomination of the issue volume. See endpoint `/basic/valueUnit/currency/main/list` for possible values. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the currency. code: nullable: true type: string description: 'Code of the currency: if assigned, a code according to ISO 4217, otherwise a local code.' isoCode: nullable: true type: string description: ISO 4217 code of the currency. tradingVolume: nullable: false type: object x-property-sort: - minimum - increment description: Requirements regarding the trading volume in the over-the-counter (non-exchange-based) trading. For the currency of the trading volume, see attribute `issue.volume.currency`. properties: minimum: nullable: true type: number format: real description: Minimum trading volume. increment: nullable: true type: number format: real description: Incremental trading volume over the minimum. The trading volume over the minimum must be an integral multiple of the increment. redemption: nullable: false type: object x-property-sort: - price - currency description: Redemption data of the instrument. properties: price: nullable: false type: object x-property-sort: - value - valueUnit description: Redemption price data. properties: value: nullable: true type: number format: real description: Redemption price. valueUnit: nullable: false type: object x-property-sort: - id - code description: Value unit of the redemption price such as percentages for a debt instrument quoted in percent, or a main or a fractional currency for a per-unit-quoted debt instrument (rarely). 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. currency: nullable: false type: object x-property-sort: - id - code - isoCode description: Main currency of the redemption. See endpoint `/basic/valueUnit/currency/main/list` for possible values. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the currency. code: nullable: true type: string description: 'Code of the currency: if assigned, a code according to ISO 4217, otherwise a local code.' isoCode: nullable: true type: string description: ISO 4217 code of the currency. nominalValue: nullable: true type: number format: real description: Nominal value for per-unit quoted debt instruments. Debt instruments quoted in percent do not have a nominal value per se. debtRanking: nullable: false type: object x-property-sort: - id - name description: Ranking data of the debt instrument. It indicates how payments related to the debt instrument are ranked compared to payments on the issuer's other obligations. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the debt ranking. name: nullable: true type: string format: localizedString description: Name of the debt ranking. germany: nullable: false type: object x-property-sort: - isTrusteeEligible description: Specific data for Germany. properties: isTrusteeEligible: nullable: true type: boolean description: If true, the debt instrument is eligible for investments by trustees according to §§1806ff of the BGB (German Civil Code). The German legislative has declared it to be virtually free of the risk of loss, such as government and state bonds. Eligible are primarily German securities. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status GetCategoryInstrumentList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array nullable: false items: type: object nullable: false x-property-sort: - id - fsym properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the instrument. fsym: nullable: false type: object x-property-sort: - security description: Instrument-level FactSet identifier of the financial instrument used primarily in FactSet products other than the MDG. properties: security: nullable: false type: object x-property-sort: - permanentIdentifier description: Security-level identifier. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for an instrument. The format is six alpha numeric characters, excluding vowels, with an S suffix (XXXXXX-S). x-partial: true description: List of instruments. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' pagination: $ref: '#/components/schemas/OffsetBasedPaginationOutputObject' partial: $ref: '#/components/schemas/PartialOutputObject' x-property-sort: - status - pagination - partial x-property-sort: - data - meta GetInstrumentCouponInterestRateTypeList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array nullable: false items: type: object nullable: false x-property-sort: - id - name - description properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the type. name: nullable: true type: string format: localizedString description: Name of the type. description: nullable: true type: string format: localizedString description: Description of the type. description: List of interest rate types. 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 GetInstrumentCompliancePropertyListByInstrument200Response: 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. complianceProperties: nullable: false description: Compliance properties of the instrument. type: array items: type: object nullable: false x-property-sort: - id - name - description properties: id: nullable: true description: Identifier of a compliance property. type: number format: id32 x-positive: true name: nullable: true type: string format: localizedString description: Name of the compliance property. description: nullable: true type: string format: localizedString description: Description of the compliance property. description: Compliance properties of an instrument. nullable: false x-property-sort: - idInstrument - sourceIdentifier - complianceProperties 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 PostDebtInstrumentNotationScreenerSearch200Response: description: Successful Response content: application/json: schema: type: object properties: data: description: List of notations. nullable: false type: array items: type: object nullable: false x-property-sort: - id - valueUnit - market - symbol - nsin - fsym - instrument - yield - macaulayDuration - sensitivities - tradedValue properties: id: nullable: true description: Identifier of the notation. type: string format: id64 x-positive: true valueUnit: nullable: false description: Value unit of the notation such as a main or fractional currency for equities, a percentage for debt instruments, or points for indices. See endpoint `/basic/valueUnit/list` for possible values. type: object x-property-sort: - id - code properties: id: nullable: true description: Identifier of the value unit. type: number format: id32 x-positive: true code: nullable: true description: 'Code of the value unit: If assigned, a code according to ISO 4217, otherwise a local code, for a main currency; a code such as GBp (for British pence) for a fractional currency; or a code such as PT (points) for non-currency value units.' x-sortable: true type: string market: nullable: false description: Market of the notation. type: object x-property-sort: - id - name properties: id: nullable: true description: Identifier of the market. type: number format: id32 x-positive: true name: nullable: true description: Name of the market. x-sortable: true type: string format: localizedString symbol: nullable: true description: The symbol of the notation. It is a market-specific code to identify the notation. Which characters can be part of a symbol depends on the market. If a market does not define a proprietary symbol, but uses a different identifier (for example, the ISIN or the WKN) to identify instruments, no symbol will be set for the notations of that market. x-sortable: true type: string nsin: nullable: false description: NSIN data of the notation. type: object x-property-sort: - sedol properties: sedol: nullable: true description: The SEDOL or IDII for the notation. type: string fsym: nullable: false type: object x-property-sort: - listing - regional description: Notation-level FactSet identifiers of the financial instrument used primarily in FactSet products other than the MDG. properties: listing: nullable: false type: object x-property-sort: - permanentIdentifier - tickerExchange - isPrimary description: Listing-level identifiers. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for a notation. The format is six alpha numeric characters, excluding vowels, with an L suffix (XXXXXX-L). tickerExchange: nullable: true type: string description: 'FactSet market symbol of the notation, usually consisting of the ticker (e.g. "DAI" for Daimler AG) and the three-character code of the exchange on which the listing is traded (example: DAI-ETR).' isPrimary: nullable: true type: boolean description: Indicates whether the notation is the primary notation among all notations within the same region (`true`) or not (`false`). regional: nullable: false type: object x-property-sort: - permanentIdentifier - tickerRegion - isPrimary description: Regional-level identifiers. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for a set of one or more notations of the same region with the same value unit. The format is six alpha numeric characters, excluding vowels, with an R suffix (XXXXXX-R). tickerRegion: nullable: true type: string description: 'FactSet regional symbol of the notation, consisting of the ticker and the two-character code of the country or region where the listing is traded (example: DAI-DE).' isPrimary: nullable: true type: boolean description: Indicates whether the notation is in the primary region of the security (`true`) or not (`false`). instrument: nullable: false description: Instrument data of the notation. type: object x-property-sort: - id - name - shortName - isin - nsin - fsym - categorization - lifeCycle - subordinated - ratingSystem1 - ratingSystem2 - issuer - issue - tradingVolume - compliance - coupon properties: id: nullable: true description: Identifier of the instrument. type: string format: id64 x-positive: true name: nullable: true description: Name of the instrument. x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string format: localizedString shortName: nullable: true description: Short name of the instrument. x-sortable: true type: string format: localizedString isin: nullable: true description: The International Securities Identification Number (ISIN) of the instrument. The ISIN is a 12-character code of digits and upper-case letters that uniquely identifies an instrument. type: string format: isin nsin: nullable: false description: NSIN data of the instrument. type: object x-property-sort: - wkn - valor - cusip properties: wkn: nullable: true description: The WKN (Wertpapierkennnummer, German for Securities Identification Number) of the instrument. The WKN is a 6-character code of digits and upper-case letters that uniquely identifies an instrument. type: string valor: nullable: true description: 'The Valor number (German: Valorennummer) of the instrument. The Valor number is an integer number that uniquely identifies an instrument.' type: string cusip: nullable: true description: The CUSIP (Committee on Uniform Security Identification Procedures) or CINS (CUSIP International Numbering System) identifier of the instrument. These numbers are 9-character codes of digits and upper-case letters that uniquely identify an instrument. type: string fsym: nullable: false type: object x-property-sort: - security description: Instrument-level FactSet identifier of the financial instrument used primarily in FactSet products other than the MDG. properties: security: nullable: false type: object x-property-sort: - permanentIdentifier description: Security-level identifier. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for an instrument. The format is six alpha numeric characters, excluding vowels, with an S suffix (XXXXXX-S). categorization: nullable: false type: object x-property-sort: - level1 - level2 - level3 description: Debt instrument categorization. See endpoint `/category/listBySystem` with `id=18` for valid values. properties: level1: nullable: false type: object x-property-sort: - id - name description: First, most coarse, level of categorization. properties: id: nullable: true description: Identifier of the category. type: number format: id32 x-positive: true name: nullable: true description: Name of the category. x-sortable: true type: string format: localizedString level2: nullable: false type: object x-property-sort: - id - name description: Second level of categorization. properties: id: nullable: true description: Identifier of the category. type: number format: id32 x-positive: true name: nullable: true description: Name of the category. x-sortable: true type: string format: localizedString level3: nullable: false type: object x-property-sort: - id - name description: Third, most detailed, level of categorization. properties: id: nullable: true description: Identifier of the category. type: number format: id32 x-positive: true name: nullable: true description: Name of the category. x-sortable: true type: string format: localizedString lifeCycle: nullable: false description: Important dates of the debt instrument. type: object x-property-sort: - issue - maturity - callable properties: issue: nullable: true description: Date of the issue. x-sortable: true type: string format: date maturity: nullable: false description: Maturity data. type: object x-property-sort: - date - remainingTermYears - perpetual properties: date: nullable: true description: Date of the debt instrument's maturity. The value is empty if the instrument is perpetual. x-sortable: true type: string format: date remainingTermYears: nullable: true description: Remaining term to maturity expressed in years. x-sortable: true type: number format: real perpetual: nullable: true description: If `true`, the debt instrument is perpetual, i.e. it does not mature, therefore the attribute `date` is `null`. x-sortable: true type: boolean callable: nullable: true description: If `true`, the issuer may redeem the instrument prior to maturity. x-sortable: true type: boolean subordinated: nullable: true description: If `true`, the debt instrument is subordinated. x-sortable: true type: boolean ratingSystem1: nullable: false description: Rating of the debt instrument according to the rating system of the first identifier in the list provided in the parameter `rating.grade.minimum.ids`. type: object x-property-sort: - rating properties: rating: nullable: false description: Rating of the debt instrument. See endpoint `/rating/grade/listBySystem` with the identifier of the respective rating system for possible values. See endpoint `/rating/grade/get` with the identifier of the rating grade for the identifier of the rating system. type: object x-property-sort: - id - grade properties: id: nullable: true description: Identifier of the rating grade. type: number format: id32 x-positive: true grade: nullable: true description: Rating grade. x-sortable: true type: string ratingSystem2: nullable: false description: Rating of the debt instrument according to the rating system of the second identifier in the list provided in the parameter `rating.grade.minimum.ids`. type: object x-property-sort: - rating properties: rating: nullable: false description: Rating of the debt instrument. See endpoint `/rating/grade/listBySystem` with the identifier of the respective rating system for possible values. See endpoint `/rating/grade/get` with the identifier of the rating grade for the identifier of the rating system. type: object x-property-sort: - id - grade properties: id: nullable: true description: Identifier of the rating grade. type: number format: id32 x-positive: true grade: nullable: true description: Rating grade. x-sortable: true type: string issuer: nullable: false description: Issuer of the debt instrument. See endpoint `/legalEntity/list` for possible values. type: object x-property-sort: - id - name - country properties: id: nullable: true description: Identifier of the issuer. type: number format: id32 x-positive: true name: nullable: true description: Name of the issuer. x-sortable: true type: string country: nullable: false description: Country of registration of the issuer. See endpoint `/basic/region/country/list` for possible values. type: object x-property-sort: - id - name properties: id: nullable: true description: Identifier of the country. type: number format: id32 x-positive: true name: nullable: true description: Name of the country. x-sortable: true type: string format: localizedString issue: nullable: false description: Issue data of the debt instrument. type: object x-property-sort: - volume properties: volume: nullable: false description: Issue volume data. type: object x-property-sort: - currency properties: currency: nullable: false description: Main currency of denomination of the issue volume. See endpoint `/basic/valueUnit/currency/main/list` for possible values. type: object x-property-sort: - id - isoCode properties: id: nullable: true description: Identifier of the currency. type: number format: id32 x-positive: true isoCode: nullable: true description: ISO 4217 code of the currency. x-sortable: true type: string tradingVolume: nullable: false description: Requirements regarding the trading volume. The currency is the currency of denomination (see attribute `issue.volume.currency`), thus the values are not comparable if debt instruments with different currencies of denomination are among the results. type: object x-property-sort: - otc properties: otc: nullable: false description: Volume applicable to the over-the-counter (non-exchange based) trading. type: object x-property-sort: - minimum properties: minimum: nullable: true description: Minimum trading volume. x-sortable: true type: number format: real compliance: nullable: false description: Compliance properties. type: object x-property-sort: - germany properties: germany: nullable: false description: Compliance properties in accordance with the German law. type: object x-property-sort: - trusteeEligible properties: trusteeEligible: nullable: true x-sortable: true type: boolean description: If `true`, the debt instrument is eligible for investments by trustees according to §§1806ff of the BGB (German Civil Code). The German legislative has declared it to be virtually free of the risk of loss, such as government and state bonds. Eligible are primarily German debt instruments. coupon: nullable: false description: Interest rate details. type: object x-property-sort: - occurrence - currentInterestRate properties: occurrence: nullable: false description: Occurrence and frequency of the coupon payments. type: object x-property-sort: - type - frequency properties: type: nullable: true type: string description: Occurrence type of the coupon payments. x-enum-description: - The debt instrument does not pay out a coupon. - The debt instrument pays out a coupon only once. - The debt instrument pays out a coupon on a repeated basis. enum: - never - once - repeated frequency: nullable: false 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. type: object x-property-sort: - id - name properties: id: nullable: true description: Identifier of the frequency. type: number format: id32 x-positive: true name: nullable: true description: Name of the frequency. x-sortable: true type: string format: localizedString currentInterestRate: nullable: false description: Details of the current coupon period. type: object x-property-sort: - type - value properties: type: nullable: false description: Type of the interest rate, see endpoint `/instrument/coupon/interestRate/type/list` for possible values. type: object x-property-sort: - id - name properties: id: nullable: true description: Identifier of the type. type: number format: id32 x-positive: true name: nullable: true description: Name of the type. x-sortable: true type: string format: localizedString value: nullable: true x-sortable: true type: number format: relativeValue description: Value of the interest rate; annualized if the payment frequency is not "annually". See endpoint `/instrument/coupon/keyData/get` for details regarding the current period. yield: nullable: false description: Yield-related key figures. type: object x-property-sort: - current - toMaturity - spread properties: current: nullable: true x-sortable: 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 x-sortable: 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 x-sortable: 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 x-sortable: true type: number format: real description: Macaulay duration, which is the average period (in years) of capital commitment. sensitivities: nullable: false description: Price sensitivities of the debt instrument with respect to the prevailing market interest rate. type: object x-property-sort: - basePointValue - modifiedDuration - elasticity - convexity properties: basePointValue: nullable: true x-sortable: 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). The unit of the base point value is the value unit of the notation (see attribute `valueUnit`), thus the values are not comparable if notations with different value units are among the results. modifiedDuration: nullable: true x-sortable: 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 x-sortable: 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 x-sortable: 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. tradedValue: nullable: false description: Cash flow for all transactions over a certain time range. The currency is the currency of denomination (see attribute `issue.volume.currency`), thus the values are not comparable if debt instruments with different currencies of denomination are among the results. type: object x-property-sort: - days30 properties: days30: nullable: false description: Cash flow for the time range 30 trading days. type: object x-property-sort: - sum - average properties: sum: nullable: true x-sortable: true type: number format: real description: Sum of the cash flow. average: nullable: true x-sortable: true type: number format: real description: Average daily cash flow. x-partial: true meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' pagination: $ref: '#/components/schemas/OffsetBasedPaginationOutputObject' partial: $ref: '#/components/schemas/PartialOutputObject' x-property-sort: - status - pagination - partial GetInstrumentLegalEntityBackgroundTextList200Response: 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. roles: nullable: false description: Role-specific background texts. type: array items: type: object nullable: false x-property-sort: - id - name - legalEntities properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a role. name: nullable: true type: string format: localizedString description: Name of the role. legalEntities: nullable: false type: object x-property-sort: - id - name - backgroundTexts description: Legal entities and their respective background texts with regard to the role. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a legal entity. name: nullable: true type: string format: localizedString description: Name of the legal entity. backgroundTexts: nullable: false type: object x-property-sort: - type - body description: List of background texts. properties: type: nullable: false type: object x-property-sort: - id - name description: Type of the background text. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the type. name: nullable: true type: string format: localizedString description: Name of the type. body: nullable: true type: string format: localizedString description: Body of the background text. description: Role-specific background texts of legal entities related to an instrument. nullable: false x-property-sort: - idInstrument - sourceIdentifier - roles 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 GetInstrumentExchangeRateGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: instrument: nullable: false type: object x-property-sort: - id - name - shortName - fsym description: Details regarding the exchange rate instrument. properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the instrument. name: nullable: true type: string format: localizedString description: Name of the instrument. shortName: nullable: true type: string format: localizedString description: Short name of the instrument. fsym: nullable: false type: object x-property-sort: - security description: Instrument-level FactSet identifier of the financial instrument used primarily in FactSet products other than the MDG. properties: security: nullable: false type: object x-property-sort: - permanentIdentifier description: Security-level identifier. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for an instrument. The format is six alpha numeric characters, excluding vowels, with an S suffix (XXXXXX-S). description: Basic data for an exchange rate. nullable: false x-property-sort: - instrument 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 GetInstrumentSearchBasic200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of instruments. nullable: false items: type: object nullable: false x-property-sort: - id - name - isin - nsin - fsym - assetClass - type description: The data member contains a list of the matching instruments properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the instrument. name: nullable: true type: string description: Asset class-unspecific name in English. isin: nullable: true type: string format: isin description: The International Securities Identification Number (ISIN) of the instrument. The ISIN is a 12-character code of digits and upper-case letters that uniquely identifies an instrument. nsin: nullable: false type: object x-property-sort: - wkn - valor - cusip - sedol description: NSIN data of the instrument. properties: wkn: nullable: true type: string description: The WKN (Wertpapierkennnummer, German for Securities Identification Number) of the instrument. The WKN is a 6-character code of digits and upper-case letters that uniquely identifies an instrument. valor: nullable: true type: string description: 'The Valor number (German: Valorennummer) of the instrument. The Valor number is an integer number that uniquely identifies an instrument.' cusip: nullable: true type: string description: The CUSIP (Committee on Uniform Security Identification Procedures) or CINS (CUSIP International Numbering System) identifier of the instrument. These numbers are 9-character codes of digits and upper-case letters that uniquely identify an instrument. sedol: nullable: true type: string description: The SEDOL or IDII for the instrument. fsym: nullable: false type: object x-property-sort: - security description: Instrument-level FactSet identifier of the financial instrument used primarily in FactSet products other than the MDG. properties: security: nullable: false type: object x-property-sort: - permanentIdentifier description: Security-level identifier. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for an instrument. The format is six alpha numeric characters, excluding vowels, with an S suffix (XXXXXX-S). assetClass: nullable: true type: string description: Name of the asset class of the instrument. Possible values are listed in the enumeration in the parameter description. type: nullable: false description: Instrument type as defined by FactSet Digital Solutions. Instrument categories are arranged in a hierarchy, with level 1 representing the most coarse granularity and further levels successively refining the granularity (see MDG category system 18). type: array items: type: object nullable: false x-property-sort: - id - name properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the category. name: nullable: true type: string format: localizedString description: Name of the category. x-partial: true meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' pagination: $ref: '#/components/schemas/OffsetBasedPaginationOutputObject' partial: $ref: '#/components/schemas/PartialOutputObject' x-property-sort: - status - pagination - partial x-property-sort: - data - meta PostInstrumentCompliancePropertyList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array nullable: false items: type: object nullable: false x-property-sort: - id - name - description properties: id: nullable: true description: Identifier of a compliance property. type: number format: id32 x-positive: true name: nullable: true type: string format: localizedString description: Name of the compliance property. description: nullable: true type: string format: localizedString description: Description of the compliance property. description: List of compliance properties, sorted by increasing identifier 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 GetInstrumentLegalEntityCompliancePropertyList200Response: 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. roles: nullable: false description: Role-specific compliance properties. type: array items: type: object nullable: false x-property-sort: - id - name - legalEntities properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a role. name: nullable: true type: string format: localizedString description: Name of the role. legalEntities: nullable: false type: array items: type: object nullable: false x-property-sort: - id - name - complianceProperties properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a legal entity. name: nullable: true type: string format: localizedString description: Name of the legal entity. complianceProperties: nullable: false type: array items: type: object nullable: false x-property-sort: - id - name - description properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a compliance property. name: nullable: true type: string format: localizedString description: Name of the compliance property. description: nullable: true type: string format: localizedString description: Description of the compliance property. description: List of compliance properties. description: Legal entities and their respective compliance properties with regard to the role. description: Role-specific compliance properties of legal entities related to an instrument. nullable: false x-property-sort: - idInstrument - sourceIdentifier - roles 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 GetInstrumentCompositeGet200Response: 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. typeComposite: nullable: true type: string description: Type of the composite instrument. x-enum-description: - A basket is a composite instrument which consists of several components. Its value is calculated as the weighted combination of the levels of the components. All weights are positive. - An alpha structure is a composite instrument which consists of two components. Its value is calculated as the difference of the performances of the components. The performances are measured starting at the date specified in the conditions of the securitized derivative. - 'A futures spread is a composite instrument which is built of two or more different futures contracts as its components. ' - A factor index is a composite instrument that reflects the day-to-day performance of its component, multiplied with a constant factor. The related capital costs and fees for calculation and administration are not represented. enum: - basket - alphaStructure - futuresSpread - factorIndex activeManagement: nullable: true type: boolean description: If set to true, the composite instrument is actively managed. managementFee: nullable: true type: number format: relativeValue description: Management fee p.a. of the composite instrument. components: nullable: false description: Information regarding the components of the composite instrument. type: array items: type: object nullable: false x-property-sort: - name - valueUnit - notation - participation - numberShares - initialWeight - referenceLevel - constantLeverage properties: name: nullable: true type: string format: localizedString description: Name of the component, provided also if there is no notation for the component. valueUnit: nullable: false type: object x-property-sort: - id - code description: 'Value unit of the component, provided also if there is no notation for the component. 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. notation: nullable: false type: object x-property-sort: - id - fsym - instrument - operatingMIC description: Notation of the component. If there is no notation for the component, the object is null. properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the notation. fsym: nullable: false type: object x-property-sort: - listing - regional description: Notation-level FactSet identifiers of the financial instrument used primarily in FactSet products other than the MDG. properties: listing: nullable: false type: object x-property-sort: - permanentIdentifier - tickerExchange - isPrimary description: Listing-level identifiers. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for a notation. The format is six alpha numeric characters, excluding vowels, with an L suffix (XXXXXX-L). tickerExchange: nullable: true type: string description: 'FactSet market symbol of the notation, usually consisting of the ticker (e.g. "DAI" for Daimler AG) and the three-character code of the exchange on which the listing is traded (example: DAI-ETR).' isPrimary: nullable: true type: boolean description: Indicates whether the notation is the primary notation among all notations within the same region (`true`) or not (`false`). regional: nullable: false type: object x-property-sort: - permanentIdentifier - tickerRegion - isPrimary description: Regional-level identifiers. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for a set of one or more notations of the same region with the same value unit. The format is six alpha numeric characters, excluding vowels, with an R suffix (XXXXXX-R). tickerRegion: nullable: true type: string description: 'FactSet regional symbol of the notation, consisting of the ticker and the two-character code of the country or region where the listing is traded (example: DAI-DE).' isPrimary: nullable: true type: boolean description: Indicates whether the notation is in the primary region of the security (`true`) or not (`false`). instrument: nullable: false type: object x-property-sort: - id - fsym description: Instrument of the component. properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the instrument. fsym: nullable: false type: object x-property-sort: - security description: Instrument-level FactSet identifier of the financial instrument used primarily in FactSet products other than the MDG. properties: security: nullable: false type: object x-property-sort: - permanentIdentifier description: Security-level identifier. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for an instrument. The format is six alpha numeric characters, excluding vowels, with an S suffix (XXXXXX-S). operatingMIC: nullable: false type: object x-property-sort: - id - isoCode - name description: The operating MIC of the component. See endpoint `/basic/mic/operating/list` for possible values. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the operating MIC. isoCode: nullable: true type: string description: ISO 10383 code of the operating MIC. name: nullable: true type: string description: English name of the operating MIC. participation: nullable: true type: string description: Indicates whether the level of the composite instrument rises or falls with a rising level of the component. The level of a basket always rises with rising level of its components and vice versa; therefore, for those the attribute is not set. The level of an alpha structure or a futures spread is calculated by subtracting the performance (price) of the short component from that of the long one. The level of a factor index rises with rising level of its component if the latter is long, and falls if it is short. For the type of composite instrument, see attribute `typeComposite`. x-enum-description: - The composite instrument's level rises with a rising level of the component. - The composite instrument's level falls with a rising level of the component. enum: - long - short numberShares: nullable: true type: number format: real description: 'Absolute number of shares of the component contained in the composite instrument. The absolute number of shares can be subject to change due to corporate actions or active management of the composite instrument (see attribute `activeManagement`). If the component is an index, the number of shares is a factor which applies to the level of the index.' initialWeight: nullable: true type: number format: relativeValue description: "Weighting of the component, valid only at initial fixing\n\n (see attribute `initialFixing` in endpoint `/securitizedDerivative/get`). " referenceLevel: nullable: true type: number format: real description: 'Level of the component on the issue date of the derivative product. For the value unit, see attribute `valueUnit`.' constantLeverage: nullable: true type: number format: real description: For a leveraged component, e.g. a component of a factor index, day-to-day leverage factor of the component's performance. nullable: false x-property-sort: - idInstrument - sourceIdentifier - typeComposite - activeManagement - managementFee - components description: Composite instrument and its components. 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 GetInstrumentCrossReferenceGetByWKN200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the instrument. fsym: nullable: false type: object x-property-sort: - security description: Instrument-level FactSet identifier of the financial instrument used primarily in FactSet products other than the MDG. properties: security: nullable: false type: object x-property-sort: - permanentIdentifier description: Security-level identifier. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for an instrument. The format is six alpha numeric characters, excluding vowels, with an S suffix (XXXXXX-S). validity: nullable: true type: object format: timeRange properties: start: nullable: true type: string format: datetime description: The starting point of the time range (inclusive). end: nullable: true type: string format: datetime description: The ending point of the time range (exclusive), or `null` to indicate that the time range extends indefinitely into the future. x-property-sort: - start - end required: - start - end description: Time range that this translation is valid for. description: Instrument response. nullable: false x-property-sort: - id - fsym - validity 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 GetInstrumentCouponDayCountConventionTypeList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array nullable: false items: type: object nullable: false x-property-sort: - id - name - description properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the type. name: nullable: true type: string format: localizedString description: Name of the type. description: nullable: true type: string format: localizedString description: Description of the type. description: List of day count convention types. 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 GetInstrumentCrossReferenceGetByISIN200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the instrument. fsym: nullable: false type: object x-property-sort: - security description: Instrument-level FactSet identifier of the financial instrument used primarily in FactSet products other than the MDG. properties: security: nullable: false type: object x-property-sort: - permanentIdentifier description: Security-level identifier. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for an instrument. The format is six alpha numeric characters, excluding vowels, with an S suffix (XXXXXX-S). validity: nullable: true type: object format: timeRange properties: start: nullable: true type: string format: datetime description: The starting point of the time range (inclusive). end: nullable: true type: string format: datetime description: The ending point of the time range (exclusive), or `null` to indicate that the time range extends indefinitely into the future. x-property-sort: - start - end required: - start - end description: Time range that this translation is valid for. description: Instrument response. nullable: false x-property-sort: - id - fsym - validity 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 GetInstrumentMifidGet200Response: 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. general: nullable: false type: object x-property-sort: - isin - name - currency - reportingDate - legalStructure - fund - issuer - guarantor - type - leveragedOrContingent - manufacturer - approvalProcedure - complexProduct description: General information. properties: isin: nullable: true type: string format: isin description: International Securities Identification Number (ISIN). name: nullable: true type: string format: localizedString description: Name of the investment product. currency: nullable: false type: object x-property-sort: - id - isoCode description: Denomination currency of the investment product. This attribute is also decisive for the main currency many of the cost attributes are originally provided in, assumed the quotation type (see attribute `quotation`) has the value 1 (currency amount per unit). See endpoint `/basic/valueUnit/currency/main/list` for valid values. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the currency. isoCode: nullable: true type: string description: ISO 4217 code of the currency. reportingDate: nullable: true type: string format: date description: The date to which the MiFID II data refers. legalStructure: nullable: false type: object x-property-sort: - id - name description: Basic legal structure categorization of the investment product. See endpoint `/category/listBySystem` for category system 38 for possible values. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the category. name: nullable: true type: string format: localizedString description: Name of the category. fund: nullable: false type: object x-property-sort: - id - name - domicile description: For an instrument that represents a share class of an investment fund, the juristic person in the role of a fund. For more information see endpoint `/legalEntity/list`. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the juristic person in the role of a fund. name: nullable: true type: string description: Name of the juristic person in the role of a fund. domicile: nullable: false type: object x-property-sort: - id - name description: The domicile country of the fund. This is the country of registration of the juristic person that is in the fund role. For more information about countries see endpoint `/basic/region/country/list`. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the country. name: nullable: true type: string format: localizedString description: Name of the country. issuer: nullable: false type: object x-property-sort: - id - name - lei description: Issuer of the investment product. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the issuer. name: nullable: true type: string description: Name of the issuer. lei: nullable: true type: string description: Legal entity identifier (LEI) of the issuer. guarantor: nullable: false type: object x-property-sort: - id - name - lei description: Guarantor of the investment product. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the guarantor. name: nullable: true type: string description: Name of the guarantor. lei: nullable: true type: string description: Legal entity identifier (LEI) of the guarantor. type: nullable: false type: object x-property-sort: - id - name description: Type of the investment product. See endpoint `/category/list` for valid values properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the category. name: nullable: true type: string format: localizedString description: Name of the category. leveragedOrContingent: nullable: true type: boolean description: Indicates whether the investment product has leverage or implies a contingent liability. manufacturer: nullable: false type: object x-property-sort: - id - name - lei description: Manufacturer of the investment product. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the manufacturer. name: nullable: true type: string description: Name of the manufacturer. lei: nullable: true type: string description: Legal entity identifier (LEI) of the manufacturer. approvalProcedure: nullable: true description: Information on the approval procedure undergone by the investment product. type: string x-enum-description: - Pursuant to MiFID II - Comparable to MiFID II - Not-in-accordance with MiFID II - Not required - Information not available enum: - pursuant - comparable - notInAccordance - notRequired - notRelevant complexProduct: nullable: true description: Indicates whether the investment product is considered a complex one. type: string x-enum-description: - 'Yes' - 'No' - Situational verification by the customer necessary - Not relevant enum: - 'yes' - 'no' - situational - notRelevant targetMarket: nullable: false type: object x-property-sort: - investorType - knowledgeAndExperience - abilityToBearLosses - riskTolerance - clientObjectivesAndNeeds - recommendedHoldingPeriod description: Target market. properties: investorType: nullable: false type: object x-property-sort: - retail - professional - eligibleCounterParty description: Describes the intended type of investors for an investment product. properties: retail: nullable: true description: Indicates whether the investment product is suitable for retail clients. type: string x-enum-description: - 'Yes' - 'No' - Neutral enum: - 'yes' - 'no' - neutral professional: nullable: true description: Indicates whether the investment product is suitable for professional clients. type: string x-enum-description: - 'Yes' - 'No' - Neutral - Per se professional - Elective professional - Both (Per se and elective professional) enum: - 'yes' - 'no' - neutral - perSe - elective - both eligibleCounterParty: nullable: true description: Indicates whether the investment product is suitable for clients of type eligible counterparty. type: string x-enum-description: - 'Yes' - 'No' - Neutral enum: - 'yes' - 'no' - neutral knowledgeAndExperience: nullable: false type: object x-property-sort: - basicInvestor - informedInvestor - advancedInvestor - germany description: Describes the level of knowledge and experience an investor should have in order to acquire the investment product. properties: basicInvestor: nullable: true description: Indicates whether the investment product is suitable for investors having basic knowledge and experience. Basic knowledge and experience means that the investor can make an informed investment decision based on the regulated and authorized offering documentation or with the help of basic information provided by the point of sale or the investor has no financial industry experience, i.e. the investment product is suitable for a first-time investor type: string x-enum-description: - 'Yes' - 'No' - Neutral - Yes with feedback enum: - 'yes' - 'no' - neutral - feedback informedInvestor: nullable: true description: Indicates whether the investment product is suitable for investors with an informed level of knowledge and experience. Informed investors have the ability to understand the particular financial instrument. Additionally, the investor must have a number of investment holdings in relevant financial instruments or must be involved in frequent trading activity in those. type: string x-enum-description: - 'Yes' - 'No' - Neutral - Yes with feedback enum: - 'yes' - 'no' - neutral - feedback advancedInvestor: nullable: true description: Indicates whether the investment product is suitable for investors with an advanced level of knowledge and experience. An advanced investor has comprehensive understanding of relevant financial instruments. Additionally, the investor must have a large number of diverse investment holdings in relevant financial instruments; must be involved in frequent trading activity in those, must have had previous exposure to high-risk or complex investments or must have relevant financial industry experience. type: string x-enum-description: - 'Yes' - 'No' - Neutral - Yes with feedback enum: - 'yes' - 'no' - neutral - feedback germany: nullable: false type: object x-property-sort: - expertInvestor description: Specific indicators for Germany. properties: expertInvestor: nullable: true description: Indicates whether the investment product is suitable for investors with an expert level of knowledge and experience. This regulatory requirement is available only in Germany, e.g. for investment in a contract for difference (CFD). type: string x-enum-description: - 'Yes' - 'No' - Neutral - Yes with feedback enum: - 'yes' - 'no' - neutral - feedback abilityToBearLosses: nullable: false type: object x-property-sort: - noCapitalLoss - limitedCapitalLoss - noCapitalGuarantee - lossBeyondCapital - maximumCapitalLoss description: Describes the potential loss associated with the investment product an investor shall be willing to accept. properties: noCapitalLoss: nullable: true description: Indicates whether the investment product is suitable for investors not able to bear capital loss. Minor loss e.g. due to costs is possible. type: string x-enum-description: - 'Yes' - 'No' - Neutral - Yes with feedback enum: - 'yes' - 'no' - neutral - feedback limitedCapitalLoss: nullable: true description: Indicates whether the investment product is suitable for investors able to bear limited capital loss. type: string x-enum-description: - 'Yes' - 'No' - Neutral - Yes with feedback enum: - 'yes' - 'no' - neutral - feedback noCapitalGuarantee: nullable: true description: Indicates whether the investment product is suitable for investors able to bear total capital loss. type: string x-enum-description: - 'Yes' - 'No' - Neutral - Yes with feedback enum: - 'yes' - 'no' - neutral - feedback lossBeyondCapital: nullable: true description: Indicates whether the investment product is suitable for investors able to bear loss beyond the invested capital. type: string x-enum-description: - 'Yes' - 'No' - Neutral - Yes with feedback enum: - 'yes' - 'no' - neutral - feedback maximumCapitalLoss: nullable: true type: number format: relativeValue description: Maximum loss of the invested capital assumed the investment product is held until maturity. riskTolerance: nullable: false type: object x-property-sort: - sri - srri - internalRiskRating - spain - germany description: Quantifies the risk associated with the product by assigning a rating using an appropriate risk rating system. properties: sri: nullable: false type: object x-property-sort: - id - rank - description description: Summary risk indicator (SRI). properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of rating grade. rank: nullable: true type: string description: Rating grade. description: nullable: true type: string format: localizedString description: Description of the rating grade. srri: nullable: false type: object x-property-sort: - id - rank - description description: Synthetic risk and reward indicator (SRRI). properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of rating grade. rank: nullable: true type: string description: Rating grade. description: nullable: true type: string format: localizedString description: Description of the rating grade. internalRiskRating: nullable: false type: object x-property-sort: - id - rank - description description: MiFID risk rating as per the internal methodology of the issuer. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of rating grade. rank: nullable: true type: string description: Rating grade. description: nullable: true type: string format: localizedString description: Description of the rating grade. spain: nullable: false type: object x-property-sort: - sri description: Specific indicators for Spain. properties: sri: nullable: false type: object x-property-sort: - id - rank - description description: Summary risk indicator (SRI). properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of rating grade. rank: nullable: true type: string description: Rating grade. description: nullable: true type: string format: localizedString description: Description of the rating grade. germany: nullable: false type: object x-property-sort: - lowestRiskTolerance description: Specific indicators for Germany. properties: lowestRiskTolerance: nullable: true type: boolean description: Indicates whether the investment product is suitable for investors with the lowest risk tolerance. clientObjectivesAndNeeds: nullable: false type: object x-property-sort: - returnProfile - maturityDate - mayBeTerminatedEarly - specificInvestmentNeed description: Characterizes the investment product regarding its ability to serve specific investment objectives. properties: returnProfile: nullable: false type: object x-property-sort: - preservation - growth - income - financing - hedging - optionOrLeveraged - other - germany description: Indicates whether the investment product is suitable for investors with specific return profiles. properties: preservation: nullable: true description: Indicates whether the investment product is suitable for investors with the return profile "preservation". type: string x-enum-description: - 'Yes' - 'No' - Neutral - Yes with feedback enum: - 'yes' - 'no' - neutral - feedback growth: nullable: true description: Indicates whether the investment product is suitable for investors with the return profile "growth". type: string x-enum-description: - 'Yes' - 'No' - Neutral - Yes with feedback enum: - 'yes' - 'no' - neutral - feedback income: nullable: true description: Indicates whether the investment product is suitable for investors with the return profile "income". type: string x-enum-description: - 'Yes' - 'No' - Neutral - Yes with feedback enum: - 'yes' - 'no' - neutral - feedback financing: nullable: true description: Indicates whether the investment product is suitable for investors with the return profile "financing". type: string x-enum-description: - 'Yes' - 'No' - Neutral - Yes with feedback enum: - 'yes' - 'no' - neutral - feedback hedging: nullable: true description: Indicates whether the investment product is suitable for investors with the return profile "hedging". type: string x-enum-description: - 'Yes' - 'No' - Neutral - Yes with feedback enum: - 'yes' - 'no' - neutral - feedback optionOrLeveraged: nullable: true description: Indicates whether the investment product is suitable for investors with the return profile "leverage". type: string x-enum-description: - 'Yes' - 'No' - Neutral - Yes with feedback enum: - 'yes' - 'no' - neutral - feedback other: nullable: true description: Indicates whether the investment product is suitable for investors with the return profile "other". type: string x-enum-description: - 'Yes' - 'No' - Neutral - Yes with feedback enum: - 'yes' - 'no' - neutral - feedback germany: nullable: false type: object x-property-sort: - pensionScheme description: Specific indicators for Germany. properties: pensionScheme: nullable: true description: Indicates whether the investment product is suitable for investors with the return profile "pension scheme". This regulatory requirement is available only in Germany ("Riester Rente"). type: string x-enum-description: - 'Yes' - 'No' - Neutral - Yes with feedback enum: - 'yes' - 'no' - neutral - feedback maturityDate: nullable: true type: string format: date description: Maturity date of the investment product. mayBeTerminatedEarly: nullable: true description: Indicates whether the investment product is unsuitable for investors not accepting financial products with potential termination prior to maturity. (That means, a "yes" value indicates that the product may not last until maturity and thus conflicts with an investor profile rejecting premature redemption.) The termination could be initiated by the issuer (callable), by the investor (puttable) or automatically due to an event, e.g. barrier breach (auto-callable). type: string x-enum-description: - 'Yes' - 'No' - Neutral - Yes with feedback enum: - 'yes' - 'no' - neutral - feedback specificInvestmentNeed: nullable: false description: Indicates whether the investment product is suitable for investors with a specific investment need. This attribute provides either a general statement (yes or no) or a set of needs (green investment, ethical investment, islamic banking, Environmental, social and governance (ESG), other) covered by the product. type: array items: type: string x-enum-description: - 'Yes' - 'No' - Green Investment - Ethical Investment - Islamic Banking - Environmental, Social and Governance (ESG) - Other enum: - 'yes' - 'no' - green - ethical - islamic - esg - other recommendedHoldingPeriod: nullable: false type: object x-property-sort: - holdingPeriod - holdingPeriodYears description: States the recommended holding period of the product. properties: holdingPeriod: nullable: false description: Indicates the recommended holding period (RHP) of the investment product whereby more than one RHP per product may exist. type: array items: type: string x-enum-description: - Very short (<1 year) - Short (<3 years) - Medium (<5 years) - Long (5 years) - Neutral enum: - veryShort - short - medium - long - neutral holdingPeriodYears: nullable: true type: number format: real description: Indicates the length of the recommended holding period (RHP) of the investment product in years, not available if the attribute `holdingPeriod` is set. distributionChannel: nullable: false type: object x-property-sort: - executionOnly - executionAppropriateness - investmentAdvice - portfolioManagement description: MiFID distribution channel provides information on the different services a firm might employ in order to deliver an investment product to its customers and on the client type the particular service is appropriate for. properties: executionOnly: nullable: true description: Indicates the client type(s) for which the investment product is suitable through the distribution channel "execution only / reception and transmission of orders (RTO) without appropriateness assessment". type: string x-enum-description: - Retail - Professional - Both - None enum: - retail - professional - both - none executionAppropriateness: nullable: true description: Indicates the client type(s) for which the investment product is suitable through the distribution channel "execution only / reception and transmission of orders (RTO) with appropriateness assessment". type: string x-enum-description: - Retail - Professional - Both - None enum: - retail - professional - both - none investmentAdvice: nullable: true description: Indicates the client type(s) for which the investment product is suitable through the distribution channel "investment advice with suitability assessment". type: string x-enum-description: - Retail - Professional - Both - None enum: - retail - professional - both - none portfolioManagement: nullable: true description: Indicates the client type for which the investment product is suitable through the distribution channel "discretionary/portfolio management with suitability assessment". type: string x-enum-description: - Retail - Professional - Both - None enum: - retail - professional - both - none costsAndCharges: nullable: false type: object x-property-sort: - quotation - exAnte - exPost description: MiFID cost is the disclosure of information on costs and charges related to an investment product and on the investment or ancillary service provided to a client. MiFID distinguishes between ex-ante and ex-post disclosure of costs. properties: quotation: nullable: true description: Quotation type originally used for providing most of the cost items of the investment product. type: string x-enum-description: - Currency amount per unit - In percent enum: - currency - percent exAnte: nullable: false type: object x-property-sort: - oneOffEntryCost - italy - oneOffMaximumAcquiredEntryCost - oneOffMaximumExitCost - oneOffMaximumAcquiredExitCost - oneOffTypicalExitCost - oneOffPriorRHPExitCost - ongoingCosts - managementFee - distributionFee - transactionCosts - incidentalCosts description: Disclosure on costs and charges at the point of sale based on reasonable estimations. properties: oneOffEntryCost: nullable: false type: object x-property-sort: - value - valueUnit description: One-off ex ante entry cost of the investment product. properties: value: nullable: true type: number format: real description: Value of the attribute. valueUnit: nullable: false type: object x-property-sort: - id - code description: Value unit of the attribute 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 italy: nullable: false type: object x-property-sort: - oneOffMaximumFixedEntryCost - oneOffMaximumFixedExitCost description: Specific indicators for Italy. properties: oneOffMaximumFixedEntryCost: nullable: false type: object x-property-sort: - value - valueUnit description: Maximum ex ante fixed one-off entry cost (e.g. flat fee per subscription, paying agent cost). This type of cost is applicable to funds traded in Italy only. The originally delivered values are always monetary amounts. properties: value: nullable: true type: number format: real description: Value of the attribute. valueUnit: nullable: false type: object x-property-sort: - id - code description: Value unit of the attribute 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 oneOffMaximumFixedExitCost: nullable: false type: object x-property-sort: - value - valueUnit description: Maximum ex ante fixed one-off exit cost (e.g. flat fee per redemption, paying agent cost). This type of cost is applicable to funds traded in Italy only. The originally delivered values are always monetary amounts properties: value: nullable: true type: number format: real description: Value of the attribute. valueUnit: nullable: false type: object x-property-sort: - id - code description: Value unit of the attribute 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 oneOffMaximumAcquiredEntryCost: nullable: false type: object x-property-sort: - value - valueUnit description: Maximum ex ante one-off entry cost acquired to a fund (e.g. subscription fee). This type of cost is applicable to funds only. properties: value: nullable: true type: number format: real description: Value of the attribute. valueUnit: nullable: false type: object x-property-sort: - id - code description: Value unit of the attribute 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 oneOffMaximumExitCost: nullable: false type: object x-property-sort: - value - valueUnit description: Maximum ex ante one-off exit cost, not acquired to a fund. This type of cost is applicable to funds only. properties: value: nullable: true type: number format: real description: Value of the attribute. valueUnit: nullable: false type: object x-property-sort: - id - code description: Value unit of the attribute 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 oneOffMaximumAcquiredExitCost: nullable: false type: object x-property-sort: - value - valueUnit description: Maximum ex ante one-off exit cost acquired to a fund (e.g. redemption fee). This type of cost is applicable to funds only. properties: value: nullable: true type: number format: real description: Value of the attribute. valueUnit: nullable: false type: object x-property-sort: - id - code description: Value unit of the attribute 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 oneOffTypicalExitCost: nullable: false type: object x-property-sort: - value - valueUnit description: Typical ex ante one-off exit cost of the investment product at maturity or at the end of the recommended holding period. properties: value: nullable: true type: number format: real description: Value of the attribute. valueUnit: nullable: false type: object x-property-sort: - id - code description: Value unit of the attribute 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 oneOffPriorRHPExitCost: nullable: false type: object x-property-sort: - value - valueUnit description: One-off ex ante exit cost of the investment product assumed it is redeemed prior to maturity or prior to the end of the recommended holding period (RHP). properties: value: nullable: true type: number format: real description: Value of the attribute. valueUnit: nullable: false type: object x-property-sort: - id - code description: Value unit of the attribute 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 ongoingCosts: nullable: false type: object x-property-sort: - value - valueUnit description: Annualized ex ante ongoing cost of the investment product. This cost includes the management fee and the distribution fee. A research fee could also be included here if applicable and not already included in the transaction cost. properties: value: nullable: true type: number format: real description: Value of the attribute. valueUnit: nullable: false type: object x-property-sort: - id - code description: Value unit of the attribute 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 managementFee: nullable: false type: object x-property-sort: - value - valueUnit description: Annualized ex ante management fee of the investment product, included in the annualized ex ante ongoing cost. properties: value: nullable: true type: number format: real description: Value of the attribute. valueUnit: nullable: false type: object x-property-sort: - id - code description: Value unit of the attribute 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 distributionFee: nullable: false type: object x-property-sort: - value - valueUnit description: Annualized ex ante distribution fee of the investment product, included in the annualized ex ante ongoing cost. This type of cost is applicable to funds only. properties: value: nullable: true type: number format: real description: Value of the attribute. valueUnit: nullable: false type: object x-property-sort: - id - code description: Value unit of the attribute 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 transactionCosts: nullable: false type: object x-property-sort: - value - valueUnit description: Annualized ex ante transaction cost of the investment product. A research fee could also be included here if applicable and not already included in the annualized ex ante ongoing cost. This type of cost is applicable to funds only. properties: value: nullable: true type: number format: real description: Value of the attribute. valueUnit: nullable: false type: object x-property-sort: - id - code description: Value unit of the attribute 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 incidentalCosts: nullable: false type: object x-property-sort: - value - valueUnit description: Annualized ex ante incidental cost of the investment product. Among others, this includes the performance fee and the carried interests. This type of cost is applicable to funds only. properties: value: nullable: true type: number format: real description: Value of the attribute. valueUnit: nullable: false type: object x-property-sort: - id - code description: Value unit of the attribute 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 exPost: nullable: false type: object x-property-sort: - oneOffEntryCost - oneOffExitCost - ongoingCosts - ongoingCostAccumulated - managementFee - distributionFee - transactionCosts - incidentalCosts description: Disclosure on costs and charges in the latest available post sale period, providing the latest available figures. properties: oneOffEntryCost: nullable: false type: object x-property-sort: - value - valueUnit description: One-off ex post entry cost of the investment product. properties: value: nullable: true type: number format: real description: Value of the attribute. valueUnit: nullable: false type: object x-property-sort: - id - code description: Value unit of the attribute 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 oneOffExitCost: nullable: false type: object x-property-sort: - value - valueUnit description: One-off ex post exit cost of the investment product. properties: value: nullable: true type: number format: real description: Value of the attribute. valueUnit: nullable: false type: object x-property-sort: - id - code description: Value unit of the attribute 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 ongoingCosts: nullable: false type: object x-property-sort: - value - valueUnit description: Annualized ex post ongoing cost of the investment product. This cost includes the ex post management and distribution fees over the period. A research fee could also be included here if applicable and not already included in the ex post transaction cost. properties: value: nullable: true type: number format: real description: Value of the attribute. valueUnit: nullable: false type: object x-property-sort: - id - code description: Value unit of the attribute 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 ongoingCostAccumulated: nullable: false type: object x-property-sort: - value - valueUnit description: Ongoing ex post accumulated cost of the investment product. This cost represents the sum of all daily recurring product costs. properties: value: nullable: true type: number format: real description: Value of the attribute. valueUnit: nullable: false type: object x-property-sort: - id - code description: Value unit of the attribute 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 managementFee: nullable: false type: object x-property-sort: - value - valueUnit description: Annualized ex post management fee of the investment product. This fee is included in the total ex post ongoing cost. properties: value: nullable: true type: number format: real description: Value of the attribute. valueUnit: nullable: false type: object x-property-sort: - id - code description: Value unit of the attribute 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 distributionFee: nullable: false type: object x-property-sort: - value - valueUnit description: Annualized ex post distribution fee of the investment product. This fee is included in the total ex post ongoing cost. properties: value: nullable: true type: number format: real description: Value of the attribute. valueUnit: nullable: false type: object x-property-sort: - id - code description: Value unit of the attribute 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 transactionCosts: nullable: false type: object x-property-sort: - value - valueUnit description: Annualized ex post transaction cost of the investment product. A research fee could also be included here if applicable and not already included in the ex post ongoing cost. properties: value: nullable: true type: number format: real description: Value of the attribute. valueUnit: nullable: false type: object x-property-sort: - id - code description: Value unit of the attribute 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 incidentalCosts: nullable: false type: object x-property-sort: - value - valueUnit description: Annualized ex post incidental cost of the investment product. Among others, this includes the performance fee and the carried interests. properties: value: nullable: true type: number format: real description: Value of the attribute. valueUnit: nullable: false type: object x-property-sort: - id - code description: Value unit of the attribute 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 nullable: false x-property-sort: - idInstrument - sourceIdentifier - general - targetMarket - distributionChannel - costsAndCharges description: MiFID II data. 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 GetInstrumentCrossReferenceHistoryGetByWKN200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of instruments. nullable: false items: type: object nullable: false x-property-sort: - id - validity properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the instrument. validity: nullable: true type: object format: timeRange properties: start: nullable: true type: string format: datetime description: The starting point of the time range (inclusive). end: nullable: true type: string format: datetime description: The ending point of the time range (exclusive), or `null` to indicate that the time range extends indefinitely into the future. x-property-sort: - start - end required: - start - end description: Time range that this translation is valid for. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' pagination: $ref: '#/components/schemas/OffsetBasedPaginationOutputObject' x-property-sort: - status - pagination x-property-sort: - data - meta GetInstrumentSelectionListList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: Unsorted set of selection lists. nullable: false items: type: object nullable: false x-property-sort: - id - name - description properties: id: nullable: true description: Identifier of a selection list. type: number format: id32 x-positive: true name: nullable: true description: Name of the selection list, as provided by the customer. type: string description: nullable: true description: Description of the selection list in English. type: string 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 GetInstrumentExchangeRateGetByISOCode200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: instrument: nullable: false type: object x-property-sort: - id - name - shortName - fsym description: Details regarding the exchange rate instrument. properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the instrument. name: nullable: true type: string format: localizedString description: Name of the instrument. shortName: nullable: true type: string format: localizedString description: Short name of the instrument. fsym: nullable: false type: object x-property-sort: - security description: Instrument-level FactSet identifier of the financial instrument used primarily in FactSet products other than the MDG. properties: security: nullable: false type: object x-property-sort: - permanentIdentifier description: Security-level identifier. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for an instrument. The format is six alpha numeric characters, excluding vowels, with an S suffix (XXXXXX-S). description: Basic data for an exchange rate. nullable: false x-property-sort: - instrument 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 PostInstrumentRatingGradeList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array nullable: false items: type: object nullable: false x-property-sort: - idInstrument - sourceIdentifier - status - ratings 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. 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 instrument level identifier. - Not entitled to see data for the identifier. - Unable to resolve the provided identifier. enum: - none - parameter - entitlement - identifierMapping identifier: nullable: true type: string 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. ratings: nullable: false type: array items: type: object nullable: false x-property-sort: - system - current - previous - change properties: system: nullable: false type: object x-property-sort: - id - name description: Rating system. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the rating system. name: nullable: true type: string description: 'Official name of the rating system in the original language, as supplied by the rating agency.' current: nullable: false type: object x-property-sort: - id - grade - rank - date description: Current rating. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the rating grade. grade: nullable: true type: string description: Rating grade. rank: nullable: true type: number format: int32 description: 'Rank of the rating grade according to the sort order of the rating system.' date: nullable: true type: string format: date description: Date on which the instrument was rated. previous: nullable: false type: object x-property-sort: - id - grade - rank - date description: Previous rating. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the rating grade. grade: nullable: true type: string description: Rating grade. rank: nullable: true type: number format: int32 description: 'Rank of the rating grade according to the sort order of the rating system.' date: nullable: true type: string format: date description: Date on which the instrument was rated. change: nullable: true type: number format: int32 description: 'Rating grade change which is the difference between the rank of the current rating and the rank of the previous rating. Example: If a rating system has AAA, AA, A, B, C, D as possible ratings (from best to worst), then a change from AA to B is represented as -2 and a change from C to AAA is represented as +4.' description: Rating details. See endpoint `/rating/system/get` for details regarding a rating system, endpoint `/rating/grade/listBySystem` for all rating grades of a rating system, and endpoint `/rating/grade/get` for details regarding a rating grade. description: 'Unsorted list of instruments with their respective rating grade per rating system.' 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 PostDebtInstrumentNotationScreenerValueRangesGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: description: Possible values and value ranges of the parameters. nullable: false type: object x-property-sort: - totalCount - valueUnit - market - categorization - lifeCycle - subordinated - ratingSystem1 - ratingSystem2 - issuer - issue - tradingVolume - compliance - coupon - yield - macaulayDuration - sensitivities - tradedValue properties: totalCount: nullable: true type: number format: int32 description: Number of notations that satisfy the request parameters, hence have been used to retrieve the possible values and value ranges. valueUnit: nullable: false description: List of value unit identifiers. See endpoint `/basic/valueUnit/list` for possible values. type: array items: type: object nullable: false x-property-sort: - id - code - count properties: id: nullable: true description: Identifer of a value unit. type: number format: id32 x-positive: true code: nullable: true description: 'Code of the value unit: If assigned, a code according to ISO 4217, otherwise a local code, for a main currency; a code such as GBp (for British pence) for a fractional currency; or a code such as PT (points) for non-currency value units.' type: string count: nullable: true description: Number of notations. type: number format: int32 market: nullable: false description: List of market identifiers. See endpoint `/basic/market/list` for possible values. type: array items: type: object nullable: false x-property-sort: - id - name - count properties: id: nullable: true description: Identifier of a market. type: number format: id32 x-positive: true name: nullable: true description: Name of the market. type: string format: localizedString count: nullable: true description: Number of notations. type: number format: int32 categorization: nullable: false description: Lists of categories of the debt instruments' categorization. Starting with the most coarse level (one), for each level of the category system, the list of categories of the debt instruments, matching the parameters, is returned. See endpoint `/category/listBySystem` with `id=18` for possible values. type: array items: type: object nullable: false x-property-sort: - level - categories properties: level: nullable: false description: Category level. type: object x-property-sort: - number properties: number: nullable: true description: Number of the category level, indicating the distance to the root of the category hierarchy. type: number format: int32 categories: nullable: false description: List of categories for the given level of the debt instruments' categorization. type: array items: type: object nullable: false x-property-sort: - id - name - parent - count properties: id: nullable: true description: Identifier of a category. type: number format: id32 x-positive: true name: nullable: true description: Name of the category. type: string format: localizedString parent: nullable: false description: Parent category or `null` if this category is on the first level. type: object x-property-sort: - id properties: id: nullable: true description: Identifier of the category. type: number format: id32 x-positive: true count: nullable: true description: Number of notations. type: number format: int32 lifeCycle: nullable: false type: object x-property-sort: - issue - maturity - callable description: Values and value ranges related to important dates. properties: issue: nullable: false type: object x-property-sort: - minimum - maximum description: Date range of the issue date. properties: minimum: nullable: true type: string format: date description: Minimum date. maximum: nullable: true type: string format: date description: Maximum date. maturity: nullable: false type: object x-property-sort: - date - remainingTermYears - perpetual description: Ranges related to the maturity. properties: date: nullable: false type: object x-property-sort: - minimum - maximum description: Date range of the maturity date. properties: minimum: nullable: true type: string format: date description: Minimum date. maximum: nullable: true type: string format: date description: Maximum date. remainingTermYears: nullable: false type: object x-property-sort: - minimum - maximum description: Value range for the remaining term to maturity expressed in years. properties: minimum: nullable: true type: number format: real description: Minimum value. maximum: nullable: true type: number format: real description: Maximum value. perpetual: nullable: false type: array items: type: object nullable: false x-property-sort: - value - count properties: value: nullable: true type: boolean description: Attribute value. count: nullable: true type: number format: int32 description: Number of notations. description: Indicates whether perpetual and non-perpetual debt instruments are among the results. A perpetual debt instrument is one that does not mature. callable: nullable: false type: array items: type: object nullable: false x-property-sort: - value - count properties: value: nullable: true type: boolean description: Attribute value. count: nullable: true type: number format: int32 description: Number of notations. description: Indicates whether callable and non-callable debt instruments are among the results. A callable debt instrument is one that may be redeemed by the issuer prior to maturity. subordinated: nullable: false type: array items: type: object nullable: false x-property-sort: - value - count properties: value: nullable: true type: boolean description: Attribute value. count: nullable: true type: number format: int32 description: Number of notations. description: Indicates whether subordinated and non-subordinated are among the results. In case of default, subordinated debt instruments are redeemed with a lower priority than non-subordinated. ratingSystem1: nullable: false type: object x-property-sort: - rating description: Ratings of the debt instruments according to the rating system specified by either the first identifier provided in the parameter `rating.system.ids`, or of the rating system implied by the first identifier provided in the parameter `rating.minimum.grade.ids`. Not available, if a rating system has not been specified via the mentioned parameters. properties: rating: nullable: false type: array items: type: object nullable: false x-property-sort: - id - grade - count properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a rating grade. grade: nullable: true type: string description: Rating grade. count: nullable: true type: number format: int32 description: Number of notations. description: List of rating grades. ratingSystem2: nullable: false type: object x-property-sort: - rating description: Ratings of the debt instruments according to the rating system specified by either the second identifier provided in the parameter `rating.system.ids`, or of the rating system implied by the second identifier provided in the parameter `rating.minimum.grade.ids`. Not available, if a rating system has not been specified via the mentioned parameters. properties: rating: nullable: false type: array items: type: object nullable: false x-property-sort: - id - grade - count properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a rating grade. grade: nullable: true type: string description: Rating grade. count: nullable: true type: number format: int32 description: Number of notations. description: List of rating grades. issuer: nullable: false type: object x-property-sort: - juristicPerson - country description: Values and value ranges related to the issuer of the debt instruments. properties: juristicPerson: nullable: false type: array items: type: object nullable: false x-property-sort: - id - name - count properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of an issuer. name: nullable: true type: string description: Name of the issuer. count: nullable: true type: number format: int32 description: Number of notations. description: List of juristic persons in the role of an issuer. See endpoint `/debtInstrument/issuer/search` for possible values. country: nullable: false type: array items: type: object nullable: false x-property-sort: - id - name - count properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of an issuer. name: nullable: true type: string description: Name of the issuer. count: nullable: true type: number format: int32 description: Number of notations. description: List of countries where the issuers of the debt instruments are registered. See endpoint `/basic/region/country/list` for possible values. issue: nullable: false type: object x-property-sort: - volume description: Values and value ranges related to the issue of the debt instruments. properties: volume: nullable: false type: object x-property-sort: - currency description: Values and value ranges related to the issue volumes of the debt instruments. properties: currency: nullable: false type: array items: type: object nullable: false x-property-sort: - id - isoCode - count properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a currency. isoCode: nullable: true type: string description: ISO 4217 code of the currency. count: nullable: true type: number format: int32 description: Number of notations. description: List of main currencies of denomination of the the issue volumes. See endpoint `/basic/valueUnit/currency/main/list` for possible values. tradingVolume: nullable: false type: object x-property-sort: - otc description: Value ranges regarding requirements related to the trading volume. The currency is the currency of denomination (see attribute `issue.volume.currency`). Not available, if the parameter `issue.volume.currency.restrict.ids` has not been set to a single currency. properties: otc: nullable: false type: object x-property-sort: - minimum description: Value ranges of the volume applicable to the over-the-counter (non-exchange based) trading. properties: minimum: nullable: true description: Minimum trading volume. type: object format: realRange properties: minimum: nullable: true type: number format: real description: Minimum value. maximum: nullable: true type: number format: real description: Maximum value. x-property-sort: - minimum - maximum compliance: nullable: false description: Compliance properties. type: object x-property-sort: - germany properties: germany: nullable: false description: Compliance properties in accordance with the German law. type: object x-property-sort: - trusteeEligible properties: trusteeEligible: nullable: false description: Indicates whether debt instruments eligible for investments by trustees according to §§1806ff of the BGB (German Civil Code) are among the results. The German legislative has declared it to be virtually free of the risk of loss, such as government and state bonds. Eligible are primarily German debt instruments. type: array items: type: object nullable: false x-property-sort: - value - count properties: value: nullable: true description: Attribute value. type: boolean count: nullable: true description: Number of notations. type: number format: int32 coupon: nullable: false description: Values and value ranges related to the interest rate. type: object x-property-sort: - occurrence - currentInterestRate properties: occurrence: nullable: false description: Occurrence and frequency of the coupon payments. type: object x-property-sort: - type - frequency properties: type: nullable: false description: Occurrence types of the coupon payments. type: array items: type: object nullable: false x-property-sort: - value - count properties: value: nullable: true description: Attribute value. type: string x-enum-description: - The debt instrument does not pay out a coupon. - The debt instrument pays out a coupon only once. - The debt instrument pays out a coupon on a repeated basis. enum: - never - once - repeated count: nullable: true description: Number of notations. type: number format: int32 frequency: nullable: false type: array items: type: object nullable: false x-property-sort: - id - name - count properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a frequency. name: nullable: true type: string format: localizedString description: Name of the frequency. count: nullable: true type: number format: int32 description: Number of notations. description: Frequency of the coupon payments; applicable only to debt instruments with an occurrence type `repeated`. See endpoint `/basic/frequency/type/list` for possible values. currentInterestRate: nullable: false description: Values and value ranges applicable to the current coupon period. type: object x-property-sort: - type - value properties: type: nullable: false type: array items: type: object nullable: false x-property-sort: - id - name - count properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a type. name: nullable: true type: string format: localizedString description: Name of the type. count: nullable: true type: number format: int32 description: Number of notations. description: Interest rate types. See endpoint `/instrument/coupon/interestRate/type/list` for possible values. value: nullable: true description: Value range of the interest rate; annualized if the payment frequency is not annually. type: object format: relativeValueRange properties: minimum: nullable: true type: number format: relativeValue description: Minimum value. maximum: nullable: true type: number format: relativeValue description: Maximum value. x-property-sort: - minimum - maximum yield: nullable: false description: Value ranges of the yield-related key figures. type: object x-property-sort: - current - toMaturity - spread properties: current: nullable: true 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. type: object format: relativeValueRange properties: minimum: nullable: true type: number format: relativeValue description: Minimum value. maximum: nullable: true type: number format: relativeValue description: Maximum value. x-property-sort: - minimum - maximum toMaturity: nullable: true description: Yield to maturity, which is the annual rate of return, assuming the instrument is held until maturity. type: object format: relativeValueRange properties: minimum: nullable: true type: number format: relativeValue description: Minimum value. maximum: nullable: true type: number format: relativeValue description: Maximum value. x-property-sort: - minimum - maximum spread: nullable: true 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. type: object format: relativeValueRange properties: minimum: nullable: true type: number format: relativeValue description: Minimum value. maximum: nullable: true type: number format: relativeValue description: Maximum value. x-property-sort: - minimum - maximum macaulayDuration: nullable: true description: Value range of the Macaulay duration, which is the average period (in years) of capital commitment. type: object format: realRange properties: minimum: nullable: true type: number format: real description: Minimum value. maximum: nullable: true type: number format: real description: Maximum value. x-property-sort: - minimum - maximum sensitivities: nullable: false description: Value ranges of the price sensitivities of the debt instruments with respect to the prevailing market interest rate. type: object x-property-sort: - basePointValue - modifiedDuration - elasticity - convexity properties: basePointValue: nullable: true 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). The unit of the base point value is the value unit of the notation (see attribute `valueUnit`). Not available, if the parameter `validation.valueUnit.restrict.ids` has not been set to a single value unit. type: object format: realRange properties: minimum: nullable: true type: number format: real description: Minimum value. maximum: nullable: true type: number format: real description: Maximum value. x-property-sort: - minimum - maximum modifiedDuration: nullable: true 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. type: object format: relativeValueRange properties: minimum: nullable: true type: number format: relativeValue description: Minimum value. maximum: nullable: true type: number format: relativeValue description: Maximum value. x-property-sort: - minimum - maximum elasticity: nullable: true 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. type: object format: relativeValueRange properties: minimum: nullable: true type: number format: relativeValue description: Minimum value. maximum: nullable: true type: number format: relativeValue description: Maximum value. x-property-sort: - minimum - maximum convexity: nullable: true description: Convexity, which is a measure for the change of the modified duration as the prevailing market interest rate changes. type: object format: realRange properties: minimum: nullable: true type: number format: real description: Minimum value. maximum: nullable: true type: number format: real description: Maximum value. x-property-sort: - minimum - maximum tradedValue: nullable: false description: Value ranges of the cash flow for all transactions over a given time range. The currency is the currency of denomination (see attribute `issue.volume.currency`). Not available, if the parameter `issue.volume.currency.restrict.ids` has not been set to a single currency. type: object x-property-sort: - days30 properties: days30: nullable: false description: Cash flow for the time range 30 trading days. type: object x-property-sort: - sum - average properties: sum: nullable: true description: Sum of the cash flow. type: object format: realRange properties: minimum: nullable: true type: number format: real description: Minimum value. maximum: nullable: true type: number format: real description: Maximum value. x-property-sort: - minimum - maximum average: nullable: true description: Average daily cash flow. type: object format: realRange properties: minimum: nullable: true type: number format: real description: Minimum value. maximum: nullable: true type: number format: real description: Maximum value. x-property-sort: - minimum - maximum meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status PostInstrumentSelectionListMembersList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of instruments. nullable: false items: type: object nullable: false x-property-sort: - id - name - isin - nsin - fsym - assetClass - category properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of an instrument. name: nullable: false description: Instrument names. type: object x-property-sort: - default - assetClassSpecific properties: default: nullable: false description: Default instrument names. Sorting does not require an asset class selection, see parameter `assetClass.ids`. type: object x-property-sort: - long - short properties: long: nullable: true x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string format: localizedString description: Long name. short: nullable: true x-sortable: true type: string format: localizedString description: Short name. assetClassSpecific: nullable: false description: Asset class-specific instrument names. Sorting requires that a single asset-class has been selected, see parameter `assetClass.ids`. type: object x-property-sort: - long - short properties: long: nullable: true x-sortable: true type: string format: localizedString description: Long name. short: nullable: true x-sortable: true type: string format: localizedString description: Short name. isin: nullable: true type: string description: International Securities Identification Number of the instrument. nsin: nullable: false description: NSIN data of the instrument. type: object x-property-sort: - wkn - valor - cusip properties: wkn: nullable: true type: string description: The WKN (Wertpapierkennnummer, German for Securities Identification Number) of the instrument. The WKN is a 6-character code of digits and upper-case letters that uniquely identifies an instrument. valor: nullable: true type: string description: 'The Valor number (German: Valorennummer) of the instrument. The Valor number is an integer number that uniquely identifies an instrument.' cusip: nullable: true type: string description: The CUSIP (Committee on Uniform Security Identification Procedures) or CINS (CUSIP International Numbering System) identifier of the instrument. These numbers are 9-character codes of digits and upper-case letters that uniquely identify an instrument. fsym: nullable: false description: Instrument-level FactSet identifier of the financial instrument used primarily in FactSet products other than the MDG. type: object x-property-sort: - security properties: security: nullable: false description: Security-level identifier. type: object x-property-sort: - permanentIdentifier properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for an instrument. The format is six alpha numeric characters, excluding vowels, with an S suffix (XXXXXX-S). assetClass: nullable: false description: Asset class of the instrument. See endpoint `/basic/assetClass/list` for possible values. type: object x-property-sort: - id - name properties: id: nullable: true description: Identifier of the asset class. type: number format: id32 x-positive: true name: nullable: true description: English name of the asset class. type: string format: localizedString category: nullable: false description: Set of categories assigned to the instrument. The set of returned categories is limited to the values provided in the request parameter `category.restrict.ids.` Empty, if `category.restrict.ids` has not been used. type: array items: type: object nullable: false x-property-sort: - id - name properties: id: nullable: true description: Identifier of a category. type: number format: id32 x-positive: true name: nullable: true description: Name of the category. type: string format: localizedString x-partial: true meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' pagination: $ref: '#/components/schemas/OffsetBasedPaginationOutputObject' partial: $ref: '#/components/schemas/PartialOutputObject' x-property-sort: - status - pagination - partial x-property-sort: - data - meta PostInstrumentBenchmarkList200Response: 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. benchmarks: nullable: false description: List of benchmarks. type: array items: type: object nullable: false x-property-sort: - notation - type properties: notation: nullable: false type: object x-property-sort: - id - fsym - instrument description: Notation data of a benchmark. properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the notation. fsym: nullable: false type: object x-property-sort: - listing - regional description: Notation-level FactSet identifiers of the financial instrument used primarily in FactSet products other than the MDG. properties: listing: nullable: false type: object x-property-sort: - permanentIdentifier - tickerExchange - isPrimary description: Listing-level identifiers. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for a notation. The format is six alpha numeric characters, excluding vowels, with an L suffix (XXXXXX-L). tickerExchange: nullable: true type: string description: 'FactSet market symbol of the notation, usually consisting of the ticker (e.g. "DAI" for Daimler AG) and the three-character code of the exchange on which the listing is traded (example: DAI-ETR).' isPrimary: nullable: true type: boolean description: Indicates whether the notation is the primary notation among all notations within the same region (`true`) or not (`false`). regional: nullable: false type: object x-property-sort: - permanentIdentifier - tickerRegion - isPrimary description: Regional-level identifiers. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for a set of one or more notations of the same region with the same value unit. The format is six alpha numeric characters, excluding vowels, with an R suffix (XXXXXX-R). tickerRegion: nullable: true type: string description: 'FactSet regional symbol of the notation, consisting of the ticker and the two-character code of the country or region where the listing is traded (example: DAI-DE).' isPrimary: nullable: true type: boolean description: Indicates whether the notation is in the primary region of the security (`true`) or not (`false`). instrument: nullable: false type: object x-property-sort: - id - name - fsym description: Instrument data of the benchmark. properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the instrument. name: nullable: true type: string format: localizedString description: Name of the instrument. fsym: nullable: false type: object x-property-sort: - security description: Instrument-level FactSet identifier of the financial instrument used primarily in FactSet products other than the MDG. properties: security: nullable: false type: object x-property-sort: - permanentIdentifier description: Security-level identifier. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for an instrument. The format is six alpha numeric characters, excluding vowels, with an S suffix (XXXXXX-S). type: nullable: false type: object x-property-sort: - id - name description: Type of the benchmark. For possible values, see endpoint `/basic/benchmark/type/list`. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the type. name: nullable: true type: string format: localizedString description: Name of the type. description: List of benchmarks of a financial instrument. nullable: false x-property-sort: - idInstrument - sourceIdentifier - benchmarks 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 GetInstrumentCrossReferenceHistoryGetByISIN200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of instruments. nullable: false items: type: object nullable: false x-property-sort: - id - validity properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the instrument. validity: nullable: true type: object format: timeRange properties: start: nullable: true type: string format: datetime description: The starting point of the time range (inclusive). end: nullable: true type: string format: datetime description: The ending point of the time range (exclusive), or `null` to indicate that the time range extends indefinitely into the future. x-property-sort: - start - end required: - start - end description: Time range that this translation is valid for. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' pagination: $ref: '#/components/schemas/OffsetBasedPaginationOutputObject' x-property-sort: - status - pagination x-property-sort: - data - meta GetInstrumentSelectionListListByInstrument200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: Set of instrument-level selection lists for each given instrument. nullable: false items: type: object nullable: false x-property-sort: - idInstrument - sourceIdentifier - selectionList - status properties: idInstrument: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the index instrument. sourceIdentifier: nullable: true type: string description: Identifier used in the request. selectionList: nullable: false description: Set of selection lists. type: array items: type: object nullable: false x-property-sort: - id - name properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a selection list. name: nullable: true type: string description: Name of the selection list, as provided by the customer. 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 instrument level identifier. - Not entitled to see data for the identifier. - Unable to resolve the provided identifier. enum: - none - parameter - entitlement - identifierMapping identifier: nullable: true type: string 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 PostNotationCrossReferenceListByInstrument200Response: 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. notations: nullable: false description: List of notations. type: array items: type: object nullable: false x-property-sort: - id - symbol - active - market - valueUnit - fsym properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the notation. symbol: nullable: true type: string description: The symbol of the notation. It is a market-specific code to identify the notation. Which characters can be part of a symbol depends on the market. If a market does not define a proprietary symbol, but uses a different identifier (for example, the ISIN or the WKN) to identify notations, no symbol will be set for the notations of that market. active: nullable: true type: boolean description: Indicates whether the notation is active. market: nullable: false type: object x-property-sort: - id - name description: Market of the notation. See endpoint `/basic/market/list` for possible values. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the market. name: nullable: true type: string format: localizedString description: Name of the market. valueUnit: nullable: false type: object x-property-sort: - id - code - isoCode - name description: Value unit of the notation. 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: If assigned, a code according to ISO 4217, otherwise a local code, for a main currency; a code such as GBp (for British pence) for a fractional currency; or a code such as PT (points) for non-currency value units.' isoCode: nullable: true type: string description: ISO 4217 code of the value unit. Empty if the ISO 4217 standard does not define a code for the currency. name: nullable: true type: string format: localizedString description: Name of the value unit. fsym: nullable: false type: object x-property-sort: - listing - regional description: Notation-level FactSet identifiers of the financial instrument used primarily in FactSet products other than the MDG. properties: listing: nullable: false type: object x-property-sort: - permanentIdentifier - tickerExchange - isPrimary description: Listing-level identifiers. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for a notation. The format is six alpha numeric characters, excluding vowels, with an L suffix (XXXXXX-L). tickerExchange: nullable: true type: string description: 'FactSet market symbol of the notation, usually consisting of the ticker (e.g. "DAI" for Daimler AG) and the three-character code of the exchange on which the listing is traded (example: DAI-ETR).' isPrimary: nullable: true type: boolean description: Indicates whether the notation is the primary notation among all notations within the same region (`true`) or not (`false`). regional: nullable: false type: object x-property-sort: - permanentIdentifier - tickerRegion - isPrimary description: Regional-level identifiers. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for a set of one or more notations of the same region with the same value unit. The format is six alpha numeric characters, excluding vowels, with an R suffix (XXXXXX-R). tickerRegion: nullable: true type: string description: 'FactSet regional symbol of the notation, consisting of the ticker and the two-character code of the country or region where the listing is traded (example: DAI-DE).' isPrimary: nullable: true type: boolean description: Indicates whether the notation is in the primary region of the security (`true`) or not (`false`). description: List of notations. nullable: false x-property-sort: - idInstrument - sourceIdentifier - notations 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 PostInstrumentCategoryList200Response: 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. datasets: nullable: false description: List of datasets with assigned categories. type: array items: type: object nullable: false x-property-sort: - dataset - categories properties: dataset: nullable: false type: object x-property-sort: - id - name description: Category dataset of the assigned categories. For a list of possible values see endpoint `/category/dataset/list`. properties: id: nullable: true x-sortable: true type: number format: id32 x-positive: true description: Identifier of the category dataset. name: nullable: true x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string description: Name of the category dateset in English. categories: nullable: false type: array items: type: object nullable: false x-property-sort: - id - name properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the category. name: nullable: true type: string format: localizedString description: Name of the category. description: List of categories covering the full path (without gaps) from the most coarse granularity to the most detailed. description: List of categories assigned to a specific instrument. nullable: false x-property-sort: - idInstrument - sourceIdentifier - datasets 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 GetInstrumentCouponList200Response: 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. currency: nullable: false type: object x-property-sort: - id - code - isoCode description: 'Main currency of the coupon payments. See endpoint `/basic/valueUnit/currency/main/list` for possible values. ' properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the main currency. code: nullable: true type: string description: 'Code of the currency: If assigned, a code according to ISO 4217, otherwise a local code.' isoCode: nullable: true type: string description: ISO 4217 code of the value unit. Empty if the ISO 4217 standard does not define a code for the currency. coupons: nullable: false type: array items: type: object nullable: false x-property-sort: - period - paymentDate - interestRate properties: period: nullable: true type: object format: dateRange properties: start: nullable: true type: string format: date description: Starting date. end: nullable: true type: string format: date description: Ending date (inclusive). x-property-sort: - start - end required: - start - end description: Coupon period. paymentDate: nullable: true type: string format: date description: Payment date of the coupon, usually 2 days after the ending date of the coupon period. For the latter, see attribute `coupons.period.end`. interestRate: nullable: false type: object x-property-sort: - type - annualized - periodic description: Interest rate for the coupon period. properties: 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 type. name: nullable: true type: string format: localizedString description: Name of the type. annualized: nullable: false type: object x-property-sort: - fixed - minimum - maximum description: Interest rate on an annual basis. Minimum/maximum interest rates and a fixed interest rate are, in general, mutually exclusive. However, for an instrument with a variable interest rate (i.e. the attribute `coupons.interestRate.type` has the value 4 or 6), a fixed interest rate might be provided if already determined for the respective period (current or past). properties: fixed: nullable: true type: number format: relativeValue description: Fixed interest rate. minimum: nullable: true type: number format: relativeValue description: Minimum interest rate. maximum: nullable: true type: number format: relativeValue description: Maximum interest rate. periodic: nullable: false type: object x-property-sort: - fixed - amount description: Interest rate based on the coupon period, i.e. not annualized. Period-based data is not available for instruments with a variable interest rate (i.e. the attribute `coupons.interestRate.type` has the value 4 or 6). properties: fixed: nullable: true type: number format: relativeValue description: Fixed interest rate. For coupon periods different from one year, the value differs from the fixed annualized interest rate (see attribute `coupons.interestRate.annualized.fixed`). amount: nullable: true type: number format: real description: Coupon amount corresponding to the fixed interest rate (see attribute `coupons.interestRate.periodic.fixed`). The attribute is available only for instruments with a declared nominal value, e.g. securitized derivatives. description: List of coupons in chronological order. description: List of coupons and currency details. nullable: false x-property-sort: - idInstrument - sourceIdentifier - currency - coupons 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 GetInstrumentGet200Response: 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. name: nullable: true type: string format: localizedString description: Name of the instrument. shortName: nullable: true type: string format: localizedString description: Short name of the instrument. isin: nullable: true type: string format: isin description: International Securities Identification Number of the instrument. nsin: nullable: false type: object x-property-sort: - wkn - valor - cusip - sedol description: NSIN data of the instrument. properties: wkn: nullable: true type: string description: The WKN (Wertpapierkennnummer, German for Securities Identification Number) of the instrument. The WKN is a 6-character code of digits and upper-case letters that uniquely identifies an instrument. valor: nullable: true type: string description: 'The Valor number (German: Valorennummer) of the instrument. The Valor number is an integer number that uniquely identifies an instrument.' cusip: nullable: true type: string description: The CUSIP (Committee on Uniform Security Identification Procedures) or CINS (CUSIP International Numbering System) identifier of the instrument. These numbers are 9-character codes of digits and upper-case letters that uniquely identify an instrument. sedol: nullable: true type: string description: The SEDOL or IDII for the instrument. fsym: nullable: false type: object x-property-sort: - security description: Instrument-level FactSet identifier of the financial instrument used primarily in FactSet products other than the MDG. properties: security: nullable: false type: object x-property-sort: - permanentIdentifier description: Security-level identifier. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for an instrument. The format is six alpha numeric characters, excluding vowels, with an S suffix (XXXXXX-S). assetClass: nullable: false type: object x-property-sort: - id - code description: 'Asset class of the instrument. For possible values see endpoint /basic/assetClass/list.' properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the asset class. code: nullable: true type: string description: code of the asset class. type: nullable: false description: Instrument type as defined by FactSet Digital Solutions. Instrument types are arranged in a hierarchy, with level 1 representing the most coarse granularity and further levels successively refining the granularity (see MDG category system 18). type: array items: type: object nullable: false x-property-sort: - id - name properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the instrument type. name: nullable: true type: string format: localizedString description: Name of the instrument type. description: Set of basic data for the instrument. nullable: false x-property-sort: - idInstrument - sourceIdentifier - name - shortName - isin - nsin - fsym - assetClass - type 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 PostDebtInstrumentIssuerSearch200Response: description: Successful Response content: application/json: schema: type: object properties: data: nullable: false type: array items: type: object nullable: false x-property-sort: - id - name - count properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of an issuer. name: nullable: true type: string description: Name of the issuer. count: nullable: true type: number format: int32 description: Number of debt instruments issued. description: List of issuers, sorted descending by the number of debt instruments issued. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status PostInstrumentCrossReferenceListByWKN200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of instruments. nullable: false items: type: object nullable: false x-property-sort: - id - fsym - validity - sourceWKN - status properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the instrument. fsym: nullable: false type: object x-property-sort: - security description: Instrument-level FactSet identifier of the financial instrument used primarily in FactSet products other than the MDG. properties: security: nullable: false type: object x-property-sort: - permanentIdentifier description: Security-level identifier. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for an instrument. The format is six alpha numeric characters, excluding vowels, with an S suffix (XXXXXX-S). validity: nullable: true type: object format: timeRange properties: start: nullable: true type: string format: datetime description: The starting point of the time range (inclusive). end: nullable: true type: string format: datetime description: The ending point of the time range (exclusive), or `null` to indicate that the time range extends indefinitely into the future. x-property-sort: - start - end required: - start - end description: Time range that this translation is valid for. sourceWKN: nullable: true type: string description: The source WKN that the instrument is translated for. status: nullable: false type: object x-property-sort: - code - identifier 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 WKN. - Not entitled to see data for the instrument. enum: - none - parameter - entitlement identifier: nullable: true type: string description: Provided identifier. 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 PostNewsArticleListByInstrument200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: identifiers: nullable: false description: List of identifiers. type: array items: type: object nullable: false x-property-sort: - idInstrument - sourceIdentifier - status 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. 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 instrument level identifier. - Not entitled to see data for the identifier. - Unable to resolve the provided identifier. enum: - none - parameter - entitlement - identifierMapping identifier: nullable: true type: string 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. articles: nullable: false description: News articles that match the filter criteria ordered by descending article time. type: array items: type: object nullable: false x-property-sort: - code - time - headline - summary - types - language - distributor - publisher - categories - chain - instruments properties: code: nullable: true description: Identifier of the news article. type: string time: nullable: true x-pushable: true description: Date and time of the news article. type: string format: datetime headline: nullable: true x-pushable: true description: Headline of the news article represented as text with HTML entity encoding but without HTML tags. type: string summary: nullable: true x-pushable: true description: Textual summary of the body of the news article or `null` if no summary was provided by the news article distributor. type: string types: nullable: false description: Types of news article. See endpoint `/news/article/type/list` for possible values. type: array items: type: object nullable: false x-property-sort: - id properties: id: nullable: true description: Identifier of the type of news article. type: number format: id32 x-positive: true language: nullable: false description: Language of the news article. See endpoint `/basic/language/list` for possible values. type: object x-property-sort: - id properties: id: nullable: true description: Identifier of the language. type: number format: id32 x-positive: true distributor: nullable: false description: Distributor of the news article. See endpoint `/news/distributor/list` for possible values. type: object x-property-sort: - id properties: id: nullable: true description: Identifier of the distributor. type: number format: id32 x-positive: true publisher: nullable: false description: Publisher of the news article. See endpoint `/news/publisher/list` for possible values. type: object x-property-sort: - id properties: id: nullable: true description: Identifier of the publisher. type: number format: id32 x-positive: true categories: nullable: false description: Categories related to the news article. See endpoint `/category/list` for possible values. type: array items: type: object nullable: false x-property-sort: - id properties: id: nullable: true x-pushable: true description: Identifier of the category. type: number format: id32 x-positive: true chain: nullable: false description: Article chain. type: object x-property-sort: - id properties: id: nullable: true x-pushable: true description: Identifier of the news article chain. type: string format: id64 x-positive: true instruments: nullable: false description: Set of stock instruments related to the article. The set is not updated in the course of corporate actions, e.g. when the related company obtains a new instrument after a spin-off. type: array items: type: object nullable: false x-property-sort: - id - fsym properties: id: nullable: true x-pushable: true description: Identifier of the instrument. type: string format: id64 x-positive: true fsym: nullable: false type: object x-property-sort: - security description: Instrument-level FactSet identifier of the financial instrument used primarily in FactSet products other than the MDG. properties: security: nullable: false type: object x-property-sort: - permanentIdentifier description: Security-level identifier. properties: permanentIdentifier: nullable: true x-pushable: true description: FactSet Permanent Identifier for an instrument. The format is six alpha numeric characters, excluding vowels, with an S suffix (XXXXXX-S). type: string description: News articles for instruments. nullable: false x-property-sort: - identifiers - articles meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' pagination: $ref: '#/components/schemas/CursorBasedPaginationOutputObjectWithoutTotal' x-property-sort: - status - pagination x-property-sort: - data - meta PostNotationCrossReferenceFactSetIdentifierListByInstrument200Response: 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. permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for an instrument. The format is six alpha numeric characters, excluding vowels, with an S suffix (XXXXXX-S). regional: nullable: false type: array items: type: object nullable: false x-property-sort: - isPrimary - permanentIdentifier - tickerRegion - listing properties: isPrimary: nullable: true type: boolean description: Indicates whether the regional identifier is the primary regional identifier of the security (`true`) or not (`false`). permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for a set of one or more notations of the same region with the same value unit. The format is six alpha numeric characters, excluding vowels, with an R suffix (XXXXXX-R). tickerRegion: nullable: true type: string description: 'FactSet regional symbol of the notation, consisting of the ticker and the two-character code of the country or region where the listing is traded (example: FDS-US).' listing: nullable: false type: array items: type: object nullable: false x-property-sort: - notation - isPrimary - permanentIdentifier - tickerExchange properties: notation: nullable: false type: object x-property-sort: - id - market - valueUnit description: Notation data. properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of a notation. market: nullable: false type: object x-property-sort: - id - name description: Market of the notation. See endpoint `/basic/market/list` for possible values. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the market. name: nullable: true type: string format: localizedString description: Name of the market. valueUnit: nullable: false type: object x-property-sort: - id - code - isoCode - name description: Value unit of the notation. 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: If assigned, a code according to ISO 4217, otherwise a local code, for a main currency; a code such as GBp (for British pence) for a fractional currency; or a code such as PT (points) for non-currency value units.' isoCode: nullable: true type: string description: ISO 4217 code of the value unit. Empty if the ISO 4217 standard does not define a code for the currency. name: nullable: true type: string format: localizedString description: Name of the value unit. isPrimary: nullable: true type: boolean description: Indicates whether the listing identifier is the one for the primary listing among all listings with the same regional identifier (`true`) or not (`false`). permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for a notation. The format is six alpha numeric characters, excluding vowels, with an L suffix (XXXXXX-L). tickerExchange: nullable: true type: string description: 'FactSet market symbol of the notation, usually consisting of the ticker (e.g. "FDS" for FactSet Research Systems Inc.) and the three-character code of the exchange on which the listing is traded (example: FDS-NYS).' description: Listing-level data with a list of notations. If the set of listing identifiers contains an element for which the attribute `isPrimary = true`, then this element is the first one in the array. description: Regional-level data with assigned listing-level data. If the set of regional identifiers contains an element for which the attribute `isPrimary = true`, then this element is the first one in the array. description: Instrument data with a list of regional-level data and assigned listing-level data. nullable: false x-property-sort: - idInstrument - sourceIdentifier - permanentIdentifier - regional 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 PostInstrumentBackgroundTextTypeList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of background text types, sorted by increasing identifier value. nullable: false items: type: object nullable: false x-property-sort: - id - name - description properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a type. name: nullable: true type: string format: localizedString description: Name of the type. description: nullable: true type: string format: localizedString description: Description of the type. 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 GetInstrumentBackgroundTextList200Response: 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. texts: nullable: false description: Background texts of the instrument. type: array items: type: object nullable: false x-property-sort: - type - body properties: type: nullable: false type: object x-property-sort: - id - name description: Type of background text. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the type. name: nullable: true type: string format: localizedString description: Name of the type. body: nullable: true type: string format: localizedString description: Body of the background text. description: Background texts of the instrument, sorted by increasing type identifier value. nullable: false x-property-sort: - idInstrument - sourceIdentifier - texts 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 GetInstrumentGetByNotation200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the instrument. name: nullable: true type: string format: localizedString description: Name of the instrument. shortName: nullable: true type: string format: localizedString description: Short name of the instrument. isin: nullable: true type: string format: isin description: International Securities Identification Number of the instrument. nsin: nullable: false type: object x-property-sort: - wkn - valor - cusip - sedol description: NSIN data of the instrument. properties: wkn: nullable: true type: string description: The WKN (Wertpapierkennnummer, German for Securities Identification Number) of the instrument. The WKN is a 6-character code of digits and upper-case letters that uniquely identifies an instrument. valor: nullable: true type: string description: 'The Valor number (German: Valorennummer) of the instrument. The Valor number is an integer number that uniquely identifies an instrument.' cusip: nullable: true type: string description: The CUSIP (Committee on Uniform Security Identification Procedures) or CINS (CUSIP International Numbering System) identifier of the instrument. These numbers are 9-character codes of digits and upper-case letters that uniquely identify an instrument. sedol: nullable: true type: string description: The SEDOL or IDII for the instrument. fsym: nullable: false type: object x-property-sort: - security description: Instrument-level FactSet identifier of the financial instrument used primarily in FactSet products other than the MDG. properties: security: nullable: false type: object x-property-sort: - permanentIdentifier description: Security-level identifier. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for an instrument. The format is six alpha numeric characters, excluding vowels, with an S suffix (XXXXXX-S). assetClass: nullable: false type: object x-property-sort: - id - code description: 'Asset class of the instrument. For possible values see endpoint /basic/assetClass/list.' properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the asset class. code: nullable: true type: string description: code of the asset class. type: nullable: false description: Instrument type as defined by FactSet Digital Solutions. Instrument types are arranged in a hierarchy, with level 1 representing the most coarse granularity and further levels successively refining the granularity (see MDG category system 18). type: array items: type: object nullable: false x-property-sort: - id - name properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the instrument type. name: nullable: true type: string format: localizedString description: Name of the instrument type. description: Set of basic data for the instrument. nullable: false x-property-sort: - id - name - shortName - isin - nsin - fsym - assetClass - type 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 PostInstrumentNotationList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of instruments (one for each element in the parameter `identifier.values` and in the same order) with a list of entitled notations. nullable: false items: type: object nullable: false x-property-sort: - idInstrument - sourceIdentifier - status - notations 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. 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 instrument level identifier. - Not entitled to see data for the identifier. - Unable to resolve the provided identifier. enum: - none - parameter - entitlement - identifierMapping identifier: nullable: true type: string 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. notations: nullable: false description: List of entitled notations. type: array items: type: object nullable: false x-property-sort: - id - symbol - market - valueUnit - fsym - tradingVolume properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of a notation. symbol: nullable: true type: string description: The symbol of the notation. It is a market-specific code to identify the notation. Which characters can be part of a symbol depends on the market. If a market does not define a proprietary symbol, but uses a different identifier (for example, the ISIN or the WKN) to identify notations, no symbol will be set for the notations of that market. market: nullable: false type: object x-property-sort: - id - name description: Market of the notation. See endpoint `/basic/market/list` for possible values. properties: id: nullable: true x-sortable: true type: number format: id32 x-positive: true description: Identifier of the market. name: nullable: true x-sortable: true type: string format: localizedString description: Name of the market. valueUnit: nullable: false type: object x-property-sort: - id - code - name description: Value unit of the notation. See endpoint `/basic/valueUnit/list` for possible values. properties: id: nullable: true x-sortable: 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: If assigned, a code according to ISO 4217, otherwise a local code, for a main currency; a code such as GBp (for British pence) for a fractional currency; or a code such as PT (points) for non-currency value units.' name: nullable: true x-sortable: true type: string format: localizedString description: Name of the value unit. fsym: nullable: false type: object x-property-sort: - listing - regional description: Notation-level FactSet identifiers of the financial instrument used primarily in FactSet products other than the MDG. properties: listing: nullable: false type: object x-property-sort: - permanentIdentifier - tickerExchange - isPrimary description: Listing-level identifiers. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for a notation. The format is six alpha numeric characters, excluding vowels, with an L suffix (XXXXXX-L). tickerExchange: nullable: true type: string description: 'FactSet market symbol of the notation, usually consisting of the ticker (e.g. "DAI" for Daimler AG) and the three-character code of the exchange on which the listing is traded (example: DAI-ETR).' isPrimary: nullable: true type: boolean description: Indicates whether the notation is the primary notation among all notations within the same region (`true`) or not (`false`). regional: nullable: false type: object x-property-sort: - permanentIdentifier - tickerRegion - isPrimary description: Regional-level identifiers. properties: permanentIdentifier: nullable: true type: string description: FactSet Permanent Identifier for a set of one or more notations of the same region with the same value unit. The format is six alpha numeric characters, excluding vowels, with an R suffix (XXXXXX-R). tickerRegion: nullable: true type: string description: 'FactSet regional symbol of the notation, consisting of the ticker and the two-character code of the country or region where the listing is traded (example: DAI-DE).' isPrimary: nullable: true type: boolean description: Indicates whether the notation is in the primary region of the security (`true`) or not (`false`). tradingVolume: nullable: false type: object x-property-sort: - month1 description: Trading volume. properties: month1: nullable: false type: object x-property-sort: - average description: Trading volume for the time range of one month. properties: average: nullable: true x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: number format: real description: Arithmetic mean of the daily trading volumes. 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 securitySchemes: basicAuth: type: http scheme: basic externalDocs: url: https://developer.factset.com/api-catalog/analytics-datastore-api description: API Documentation