openapi: 3.0.0 info: version: 3.0.0 title: Factset Quotes API For Digital Portals description: > The Quotes API combines endpoints for retrieving security end-of-day, delayed, and realtime prices with performance key figures and basic reference data on the security and market level. The API supports over 20 different price types for each quote and comes with basic search endpoints based on security identifiers and instrument names. Market coverage is included in the *Sample Use Cases* section below. The Digital Portal use case is focused on high-performance applications that are * serving millions of end-users, * accessible by client browsers via the internet, * supporting subscriptions for streamed updates out-of-the-box, * typically combining a wide variety of *for Digital Portals*-APIs into a highly use-case specific solution for customers, * integrated into complex infrastructures such as existing frontend frameworks, authentication services. All APIs labelled *for Digital Portals* have been designed for direct use by client web applications and feature extreme low latency: The average response time across all endpoints is 30 ms whereas 99% of all requests are answered in close to under 300ms. See the [Time Series API for Digital Portals](https://developer.factset.com/api-catalog/time-series-api-digital-portals) for direct access to price histories, and the [News API for Digital Portals](https://developer.factset.com/api-catalog/news-api-digital-portals) for searching and fetching related news. 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 servers: - url: https://api.factset.com/wealth/v3 paths: /basic/assetClass/list: get: tags: - Basic operationId: get/basic/assetClass/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 asset classes as defined by FactSet Digital Solutions. summary: Factset List of asset classes. responses: '200': $ref: '#/components/responses/GetBasicAssetClassList200Response' 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. /basic/backgroundText/type/list: post: tags: - Basic operationId: post/basic/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. description: List of background text types. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostBasicBackgroundTextTypeListRequest' required: false responses: '200': $ref: '#/components/responses/PostBasicBackgroundTextTypeList200Response' parameters: [] /basic/benchmark/type/list: get: tags: - Basic operationId: get/basic/benchmark/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 benchmark types. description: List of benchmark types. responses: '200': $ref: '#/components/responses/GetBasicBenchmarkTypeList200Response' 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 /basic/delivery/list: post: tags: - Basic operationId: post/basic/delivery/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 deliveries. description: List of deliveries. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostBasicDeliveryListRequest' required: false responses: '200': $ref: '#/components/responses/PostBasicDeliveryList200Response' parameters: [] /basic/frequency/type/list: get: tags: - Basic operationId: get/basic/frequency/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 frequency types. description: List of frequency types. responses: '200': $ref: '#/components/responses/GetBasicFrequencyTypeList200Response' 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 /basic/language/get: get: tags: - Basic operationId: get/basic/language/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: Details for a language. summary: Factset Details for a language. parameters: - name: id in: query schema: type: number format: id32 x-positive: true description: Identifier of a language. 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/GetBasicLanguageGet200Response' /basic/language/getByCode: get: tags: - Basic operationId: get/basic/language/getByCode 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: Details for a language identified by code. summary: Factset Details for a language identified by code. parameters: - name: code in: query schema: type: string maxLength: 2 exclusiveMaximum: false description: ISO 639-1 code of the language. 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/GetBasicLanguageGetByCode200Response' /basic/language/list: get: tags: - Basic operationId: get/basic/language/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 description: List of languages. summary: Factset List of languages. responses: '200': $ref: '#/components/responses/GetBasicLanguageList200Response' 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 - 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. schema: type: array items: type: string enum: - code - '-code' - name - '-name' maxItems: 2 uniqueItems: true default: - name style: form explode: false name: _sort in: query /basic/market/get: get: tags: - Basic operationId: get/basic/market/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: Details of a market. summary: Factset Details of a market. parameters: - name: id in: query schema: type: number format: id32 x-positive: true description: Identifier of a market. 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/GetBasicMarketGet200Response' /basic/market/list: post: tags: - Basic operationId: post/basic/market/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: true x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 5 x-supportsPermissionDeniedResponse: false description: List of markets. summary: Factset List of markets. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostBasicMarketListRequest' required: false responses: '200': $ref: '#/components/responses/PostBasicMarketList200Response' parameters: [] /basic/market/group/list: get: tags: - Basic operationId: get/basic/market/group/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 description: List of market groups. summary: Factset List of market groups. responses: '200': $ref: '#/components/responses/GetBasicMarketGroupList200Response' 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 - 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. schema: type: array items: type: string enum: - name - '-name' - shortName - '-shortName' maxItems: 2 uniqueItems: true default: - name style: form explode: false name: _sort in: query /basic/market/type/list: get: tags: - Basic operationId: get/basic/market/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: 1 x-supportsPermissionDeniedResponse: false description: List of market types. summary: Factset List of market types. responses: '200': $ref: '#/components/responses/GetBasicMarketTypeList200Response' 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 - 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. schema: type: array items: type: string enum: - name - '-name' maxItems: 1 uniqueItems: true default: - name style: form explode: false name: _sort in: query /basic/media/kind/list: get: tags: - Basic operationId: get/basic/media/kind/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 media kinds. description: List of media kinds. responses: '200': $ref: '#/components/responses/GetBasicMediaKindList200Response' 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. /basic/media/type/list: post: tags: - Basic operationId: post/basic/media/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: 2 x-supportsPermissionDeniedResponse: false description: >- List of Internet media types. See http://www.iana.org/assignments/media-types/ for further details. Not all such Internet media types are available on the MDG. summary: Factset List of Internet media types. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostBasicMediaTypeListRequest' required: false responses: '200': $ref: '#/components/responses/PostBasicMediaTypeList200Response' parameters: [] /basic/mic/operating/list: post: tags: - Basic operationId: post/basic/mic/operating/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: true 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 operating market identifier codes (MIC). description: List of operating market identifier codes (MIC). requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostBasicMicOperatingListRequest' required: false responses: '200': $ref: '#/components/responses/PostBasicMicOperatingList200Response' parameters: [] /basic/region/get: get: tags: - Basic operationId: get/basic/region/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 Details for a region. description: Details for a geographic, political, or economic region. parameters: - name: id in: query schema: type: number format: id32 x-positive: true description: Identifier of a region. 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/GetBasicRegionGet200Response' /basic/region/list: get: tags: - Basic operationId: get/basic/region/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 regions. description: List of geographic, political, and economic regions. responses: '200': $ref: '#/components/responses/GetBasicRegionList200Response' 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 - 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. schema: type: array items: type: string enum: - code - '-code' - name - '-name' maxItems: 2 uniqueItems: true default: - name style: form explode: false name: _sort in: query /basic/region/continent/get: get: tags: - Basic operationId: get/basic/region/continent/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 Details for a continent. description: Details for a continent. parameters: - name: id in: query schema: type: number format: id32 x-positive: true description: Identifier of a continent. 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/GetBasicRegionContinentGet200Response' /basic/region/continent/list: get: tags: - Basic operationId: get/basic/region/continent/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 continents. description: List of continents. responses: '200': $ref: '#/components/responses/GetBasicRegionContinentList200Response' 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 - 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. schema: type: array items: type: string enum: - name - '-name' maxItems: 1 uniqueItems: true default: - name style: form explode: false name: _sort in: query /basic/region/country/get: get: tags: - Basic operationId: get/basic/region/country/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 Details for a country. description: Details for a country. parameters: - name: id in: query schema: type: number format: id32 x-positive: true description: Identifier of a country. 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/GetBasicRegionCountryGet200Response' /basic/region/country/getByCode: get: tags: - Basic operationId: get/basic/region/country/getByCode 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 Details for a country identified by code. description: Details for a country identified by code. parameters: - name: code in: query schema: type: string maxLength: 2 exclusiveMaximum: false description: ISO 3166-1 alpha-2 code of a country. 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/GetBasicRegionCountryGetByCode200Response' /basic/region/country/list: get: tags: - Basic operationId: get/basic/region/country/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 countries. description: List of countries. responses: '200': $ref: '#/components/responses/GetBasicRegionCountryList200Response' 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 - 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. schema: type: array items: type: string enum: - code - '-code' - name - '-name' maxItems: 2 uniqueItems: true default: - name style: form explode: false name: _sort in: query /basic/timezone/get: get: tags: - Basic operationId: get/basic/timezone/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: >- Details of a timezone identified by id, as specified by the Internet Assigned Numbers Authority. See http://www.iana.org/time-zones for further details. Not all such timezones are available on the MDG. summary: Factset Details of a timezone. parameters: - name: id in: query schema: type: number format: id32 x-positive: true description: >- Identifier of a timezone. An invalid or unsupported identifier will result in an error. 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/GetBasicTimezoneGet200Response' /basic/timezone/getByName: get: tags: - Basic operationId: get/basic/timezone/getByName 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: >- Details of a timezone identified by name, as specified by the Internet Assigned Numbers Authority. See http://www.iana.org/time-zones for further details. Not all such timezones are available on the MDG. summary: Factset Details of a timezone identified by name. parameters: - name: name in: query schema: type: string pattern: ^[A-Za-z_/-]+$ minLength: 1 exclusiveMinimum: false maxLength: 100 exclusiveMaximum: false description: >- Name of a timezone. The result is determined by a case-sensitive equality comparison with the stored timezone names. An invalid or unsupported name will result in an error. 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/GetBasicTimezoneGetByName200Response' /basic/timezone/list: post: tags: - Basic operationId: post/basic/timezone/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 timezones identified by id, as specified by the Internet Assigned Numbers Authority. See http://www.iana.org/time-zones for further details. Not all such timezones are available on the MDG. summary: Factset List of timezones. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostBasicTimezoneListRequest' required: false responses: '200': $ref: '#/components/responses/PostBasicTimezoneList200Response' parameters: [] /basic/valueUnit/get: get: tags: - Basic operationId: get/basic/valueUnit/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 Details of a value unit. description: Details of a value unit. parameters: - name: id in: query schema: type: number format: id32 x-positive: true description: Identifier of a value unit. 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/GetBasicValueUnitGet200Response' /basic/valueUnit/list: post: tags: - Basic operationId: post/basic/valueUnit/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 value units. description: List of value units. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostBasicValueUnitListRequest' required: false responses: '200': $ref: '#/components/responses/PostBasicValueUnitList200Response' parameters: [] /basic/valueUnit/alternative/list: get: tags: - Basic operationId: get/basic/valueUnit/alternative/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 description: List of alternative units. summary: Factset List of alternative units. responses: '200': $ref: '#/components/responses/GetBasicValueUnitAlternativeList200Response' 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 - 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. schema: type: array items: type: string enum: - name - '-name' maxItems: 1 uniqueItems: true default: - name style: form explode: false name: _sort in: query /basic/valueUnit/currency/list: post: tags: - Basic operationId: post/basic/valueUnit/currency/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 currencies. description: List of currencies. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostBasicValueUnitCurrencyListRequest' required: false responses: '200': $ref: '#/components/responses/PostBasicValueUnitCurrencyList200Response' parameters: [] /basic/valueUnit/currency/fractional/get: get: tags: - Basic operationId: get/basic/valueUnit/currency/fractional/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 Details of a fractional currency. description: Details of a fractional currency. parameters: - name: id in: query schema: type: number format: id32 x-positive: true description: Identifier of a fractional 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/GetBasicValueUnitCurrencyFractionalGet200Response /basic/valueUnit/currency/fractional/list: get: tags: - Basic operationId: get/basic/valueUnit/currency/fractional/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 fractional currencies. description: List of fractional currencies. responses: '200': $ref: >- #/components/responses/GetBasicValueUnitCurrencyFractionalList200Response 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 - 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. schema: type: array items: type: string enum: - name - '-name' maxItems: 1 uniqueItems: true default: - name style: form explode: false name: _sort in: query /basic/valueUnit/currency/main/list: post: tags: - Basic operationId: post/basic/valueUnit/currency/main/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 main currencies. description: List of main currencies. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostBasicValueUnitCurrencyMainListRequest' required: false responses: '200': $ref: '#/components/responses/PostBasicValueUnitCurrencyMainList200Response' parameters: [] /category/get: get: tags: - Category operationId: get/category/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 Details of a category. description: Details of a category. parameters: - name: id in: query schema: type: number format: id32 x-positive: true description: Identifier of a category. 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/GetCategoryGet200Response' /category/list: get: tags: - Category operationId: get/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: 10 x-supportsPermissionDeniedResponse: false summary: Factset List of categories. description: List of categories. parameters: - name: ids in: query schema: type: array nullable: false items: type: number format: id32 x-positive: true description: List of categories belonging to the same category system. uniqueItems: true minItems: 1 maxItems: 100 style: form explode: 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. - 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/GetCategoryList200Response' /category/listByLevel: get: tags: - Category operationId: get/category/listByLevel 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 categories assigned to a category level. description: List of categories assigned to a category level. parameters: - name: id in: query schema: type: number format: id32 x-positive: true description: >- Identifier of a category level. See attribute `levels` in endpoint `/category/system/get` 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 - 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/GetCategoryListByLevel200Response' /category/listBySystem: get: tags: - Category operationId: get/category/listBySystem 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 categories assigned to a category system. description: List of categories assigned to a category system. parameters: - name: id in: query schema: type: number format: id32 x-positive: true description: >- Identifier of a category system. See endpoint `/category/system/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 - 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/GetCategoryListBySystem200Response' /category/dataset/list: get: tags: - Category operationId: get/category/dataset/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 entitled category datasets. description: List of entitled category datasets. responses: '200': $ref: '#/components/responses/GetCategoryDatasetList200Response' 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 /category/instrument/list: get: tags: - Category 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' /category/level/get: get: tags: - Category operationId: get/category/level/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 Details of a category level. description: Details of a category level. parameters: - name: id in: query schema: type: number format: id32 x-positive: true description: >- Identifier of a category level. See attribute `levels` in endpoint `/category/system/get` 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/GetCategoryLevelGet200Response' /category/path/get: get: tags: - Category operationId: get/category/path/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 Path from the first level to the level of a specific category. description: Path from the first level to the level of a specific category. parameters: - name: id in: query schema: type: number format: id32 x-positive: true description: Identifier of a category. 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/GetCategoryPathGet200Response' /category/system/get: get: tags: - Category operationId: get/category/system/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 Details of an entitled category system. description: Details of an entitled category system. parameters: - name: id in: query schema: type: number format: id32 x-positive: true description: >- Identifier of a category system. See endpoint `/category/system/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/GetCategorySystemGet200Response' /category/system/list: get: tags: - Category operationId: get/category/system/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 entitled category systems. description: List of entitled category systems. parameters: - name: idType in: query schema: description: >- Filter for a specific category system type. See endpoint `/category/system/type/list` for valid values. type: number format: id32 x-positive: 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/GetCategorySystemList200Response' /category/system/type/list: get: tags: - Category operationId: get/category/system/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 category system types. description: List of category system types. responses: '200': $ref: '#/components/responses/GetCategorySystemTypeList200Response' 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 /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' /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' /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' /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: [] /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: [] /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: [] /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: [] /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 /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' /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. If 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' /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 /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 /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' /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 /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 /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: [] /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: [] /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 /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 /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. 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' /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. 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: 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 /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 /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 /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' /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: [] /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: [] /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. /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 /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: [] /notation/get: get: tags: - Notation operationId: get/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 description: Basic data for a notation. summary: Factset Basic data for a notation. parameters: - name: identifier in: query schema: type: string pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. - 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/GetNotationGet200Response' /notation/list: get: tags: - Notation operationId: get/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: 10 x-supportsPermissionDeniedResponse: false description: Basic data for a list of notations. summary: Factset Basic data for a list of notations. parameters: - name: identifiers in: query schema: description: Set of identifiers to resolve. type: array nullable: false items: type: string minLength: 3 exclusiveMinimum: false maxLength: 50 exclusiveMaximum: false pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ uniqueItems: true minItems: 1 maxItems: 100 required: true style: form explode: false - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. - 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/GetNotationList200Response' /notation/category/list: post: tags: - Notation operationId: post/notation/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 description: >- List of categories assigned to a specific notation the application is entitled to see. Optionally it is possible to restrict the output to only list those for a specific category dataset. summary: >- Factset List of categories assigned to a specific notation the application is entitled to see. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostNotationCategoryListRequest' required: false responses: '200': $ref: '#/components/responses/PostNotationCategoryList200Response' parameters: [] /notation/crossReference/getByFactSetMarketSymbol: get: tags: - Notation operationId: get/notation/crossReference/getByFactSetMarketSymbol 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: Translate a FactSet market symbol to a notation. description: >- Translate a FactSet market symbol to a notation. This symbol is also known as TICKER_EXCHANGE. parameters: - name: factSetMarketSymbol in: query schema: type: string maxLength: 32 exclusiveMaximum: false minLength: 1 exclusiveMinimum: false description: >- Market symbol defined by FactSet to identify a notation (i.e. TICKER_EXCHANGE). 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/GetNotationCrossReferenceGetByFactSetMarketSymbol200Response /notation/crossReference/listByInstrument: post: tags: - Notation 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: [] /notation/crossReference/listByISIN: post: tags: - Notation operationId: post/notation/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 summary: Factset List of entitled notations. description: List of entitled notations. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostNotationCrossReferenceListByISINRequest' required: false responses: '200': $ref: >- #/components/responses/PostNotationCrossReferenceListByISIN200Response parameters: [] /notation/crossReference/listBySymbol: post: tags: - Notation operationId: post/notation/crossReference/listBySymbol 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. Symbols are not globally unique; therefore, a given symbol interpreted in different markets might refer to different instruments. requestBody: description: Request Body content: application/json: schema: $ref: >- #/components/schemas/PostNotationCrossReferenceListBySymbolRequest required: false responses: '200': $ref: >- #/components/responses/PostNotationCrossReferenceListBySymbol200Response parameters: [] /notation/crossReference/factSetIdentifier/get: get: tags: - Notation operationId: get/notation/crossReference/factSetIdentifier/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: Retrieve FactSet identifiers for a given notation. description: >-

Retrieve FactSet identifiers for a given notation. Security and listing-level identifiers are always included, regional level identifiers are included, if available. parameters: - name: identifier in: query schema: type: string pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: >- #/components/responses/GetNotationCrossReferenceFactSetIdentifierGet200Response /notation/crossReference/factSetIdentifier/listByFactSetIdentifier: post: tags: - Notation operationId: post/notation/crossReference/factSetIdentifier/listByFactSetIdentifier 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 notations for a given FactSet identifier. description: >-

Retrieve a list of notations for a given FactSet identifier, 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.

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

requestBody: description: Request Body content: application/json: schema: $ref: >- #/components/schemas/PostNotationCrossReferenceFactSetIdentifierListByFactSetIdentifierRequest required: true responses: '200': $ref: >- #/components/responses/PostNotationCrossReferenceFactSetIdentifierListByFactSetIdentifier200Response parameters: [] /notation/crossReference/factSetIdentifier/listByInstrument: post: tags: - Notation 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: [] /notation/keyFigures/year/10/get: get: tags: - Notation operationId: get/notation/keyFigures/year/10/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (EOD) key figures for the time range of ten years. description: End-of-day (EOD) key figures for the time range of ten years. parameters: - name: identifier in: query schema: type: string pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresYear10Get200Response' /notation/keyFigures/year/10/list: get: tags: - Notation operationId: get/notation/keyFigures/year/10/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: >- Factset End-of-day (EOD) key figures for the time range of ten years, for a list of notations. description: >- End-of-day (EOD) key figures for the time range of ten years, for a list of notations. parameters: - name: identifiers in: query schema: description: Set of identifiers to resolve. type: array nullable: false items: type: string minLength: 3 exclusiveMinimum: false maxLength: 50 exclusiveMaximum: false pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ uniqueItems: true minItems: 1 maxItems: 100 required: true style: form explode: false - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresYear10List200Response' /notation/keyFigures/month/1/get: get: tags: - Notation operationId: get/notation/keyFigures/month/1/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (EOD) key figures for the time range of one month. description: End-of-day (EOD) key figures for the time range of one month. parameters: - name: identifier in: query schema: type: string pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresMonth1Get200Response' /notation/keyFigures/month/1/list: get: tags: - Notation operationId: get/notation/keyFigures/month/1/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: >- Factset End-of-day (EOD) key figures for the time range of one month, for a list of notations. description: >- End-of-day (EOD) key figures for the time range of one month, for a list of notations. parameters: - name: identifiers in: query schema: description: Set of identifiers to resolve. type: array nullable: false items: type: string minLength: 3 exclusiveMinimum: false maxLength: 50 exclusiveMaximum: false pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ uniqueItems: true minItems: 1 maxItems: 100 required: true style: form explode: false - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresMonth1List200Response' /notation/keyFigures/week/1/get: get: tags: - Notation operationId: get/notation/keyFigures/week/1/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (EOD) key figures for the time range of one week. description: End-of-day (EOD) key figures for the time range of one week. parameters: - name: identifier in: query schema: type: string pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresWeek1Get200Response' /notation/keyFigures/week/1/list: get: tags: - Notation operationId: get/notation/keyFigures/week/1/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: >- Factset End-of-day (EOD) key figures for the time range of one week, for a list of notations. description: >- End-of-day (EOD) key figures for the time range of one week, for a list of notations. parameters: - name: identifiers in: query schema: description: Set of identifiers to resolve. type: array nullable: false items: type: string minLength: 3 exclusiveMinimum: false maxLength: 50 exclusiveMaximum: false pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ uniqueItems: true minItems: 1 maxItems: 100 required: true style: form explode: false - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresWeek1List200Response' /notation/keyFigures/year/1/get: get: tags: - Notation operationId: get/notation/keyFigures/year/1/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (EOD) key figures for the time range of one year. description: End-of-day (EOD) key figures for the time range of one year. parameters: - name: identifier in: query schema: type: string pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresYear1Get200Response' /notation/keyFigures/year/1/list: get: tags: - Notation operationId: get/notation/keyFigures/year/1/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: >- Factset End-of-day (EOD) key figures for the time range of one year, for a list of notations. description: >- End-of-day (EOD) key figures for the time range of one year, for a list of notations. parameters: - name: identifiers in: query schema: description: Set of identifiers to resolve. type: array nullable: false items: type: string minLength: 3 exclusiveMinimum: false maxLength: 50 exclusiveMaximum: false pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ uniqueItems: true minItems: 1 maxItems: 100 required: true style: form explode: false - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresYear1List200Response' /notation/keyFigures/month/3/get: get: tags: - Notation operationId: get/notation/keyFigures/month/3/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (EOD) key figures for the time range of three months. description: End-of-day (EOD) key figures for the time range of three months. parameters: - name: identifier in: query schema: type: string pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresMonth3Get200Response' /notation/keyFigures/month/3/list: get: tags: - Notation operationId: get/notation/keyFigures/month/3/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: >- Factset End-of-day (EOD) key figures for the time range of three months, for a list of notations. description: >- End-of-day (EOD) key figures for the time range of three months, for a list of notations. parameters: - name: identifiers in: query schema: description: Set of identifiers to resolve. type: array nullable: false items: type: string minLength: 3 exclusiveMinimum: false maxLength: 50 exclusiveMaximum: false pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ uniqueItems: true minItems: 1 maxItems: 100 required: true style: form explode: false - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresMonth3List200Response' /notation/keyFigures/year/3/get: get: tags: - Notation operationId: get/notation/keyFigures/year/3/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (EOD) key figures for the time range of three years. description: End-of-day (EOD) key figures for the time range of three years. parameters: - name: identifier in: query schema: type: string pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresYear3Get200Response' /notation/keyFigures/year/3/list: get: tags: - Notation operationId: get/notation/keyFigures/year/3/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: >- Factset End-of-day (EOD) key figures for the time range of three years, for a list of notations. description: >- End-of-day (EOD) key figures for the time range of three years, for a list of notations. parameters: - name: identifiers in: query schema: description: Set of identifiers to resolve. type: array nullable: false items: type: string minLength: 3 exclusiveMinimum: false maxLength: 50 exclusiveMaximum: false pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ uniqueItems: true minItems: 1 maxItems: 100 required: true style: form explode: false - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresYear3List200Response' /notation/keyFigures/year/5/get: get: tags: - Notation operationId: get/notation/keyFigures/year/5/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (EOD) key figures for the time range of five years. description: End-of-day (EOD) key figures for the time range of five years. parameters: - name: identifier in: query schema: type: string pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresYear5Get200Response' /notation/keyFigures/year/5/list: get: tags: - Notation operationId: get/notation/keyFigures/year/5/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: >- Factset End-of-day (EOD) key figures for the time range of five years, for a list of notations. description: >- End-of-day (EOD) key figures for the time range of five years, for a list of notations. parameters: - name: identifiers in: query schema: description: Set of identifiers to resolve. type: array nullable: false items: type: string minLength: 3 exclusiveMinimum: false maxLength: 50 exclusiveMaximum: false pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ uniqueItems: true minItems: 1 maxItems: 100 required: true style: form explode: false - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresYear5List200Response' /notation/keyFigures/month/6/get: get: tags: - Notation operationId: get/notation/keyFigures/month/6/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (EOD) key figures for the time range of six months. description: End-of-day (EOD) key figures for the time range of six months. parameters: - name: identifier in: query schema: type: string pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresMonth6Get200Response' /notation/keyFigures/month/6/list: get: tags: - Notation operationId: get/notation/keyFigures/month/6/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: >- Factset End-of-day (EOD) key figures for the time range of six months, for a list of notations. description: >- End-of-day (EOD) key figures for the time range of six months, for a list of notations. parameters: - name: identifiers in: query schema: description: Set of identifiers to resolve. type: array nullable: false items: type: string minLength: 3 exclusiveMinimum: false maxLength: 50 exclusiveMaximum: false pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ uniqueItems: true minItems: 1 maxItems: 100 required: true style: form explode: false - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresMonth6List200Response' /notation/keyFigures/year/7/get: get: tags: - Notation operationId: get/notation/keyFigures/year/7/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (EOD) key figures for the time range of seven years. description: End-of-day (EOD) key figures for the time range of seven years. parameters: - name: identifier in: query schema: type: string pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresYear7Get200Response' /notation/keyFigures/year/7/list: get: tags: - Notation operationId: get/notation/keyFigures/year/7/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: >- Factset End-of-day (EOD) key figures for the time range of seven years, for a list of notations. description: >- End-of-day (EOD) key figures for the time range of seven years, for a list of notations. parameters: - name: identifiers in: query schema: description: Set of identifiers to resolve. type: array nullable: false items: type: string minLength: 3 exclusiveMinimum: false maxLength: 50 exclusiveMaximum: false pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ uniqueItems: true minItems: 1 maxItems: 100 required: true style: form explode: false - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresYear7List200Response' /notation/keyFigures/yearToDate/get: get: tags: - Notation operationId: get/notation/keyFigures/yearToDate/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (EOD) key figures for the time range year-to-date (YTD).. description: >- End-of-day (EOD) key figures for the time range year-to-date (YTD). The time range YTD begins with the last trading day of the previous calendar year for which EOD prices are available and ends with the most recent trading day of the current calendar year for which EOD prices are available.. parameters: - name: identifier in: query schema: type: string pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresYearToDateGet200Response' /notation/keyFigures/yearToDate/list: get: tags: - Notation operationId: get/notation/keyFigures/yearToDate/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: >- Factset End-of-day (EOD) key figures for the time range year-to-date (YTD), for a list of notations.. description: >- End-of-day (EOD) key figures for the time range year-to-date (YTD), for a list of notations. The time range YTD begins with the last trading day of the previous calendar year for which EOD prices are available and ends with the most recent tradingday of the current calendar year for which EOD prices are available.. parameters: - name: identifiers in: query schema: description: Set of identifiers to resolve. type: array nullable: false items: type: string minLength: 3 exclusiveMinimum: false maxLength: 50 exclusiveMaximum: false pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ uniqueItems: true minItems: 1 maxItems: 100 required: true style: form explode: false - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: >- #/components/responses/GetNotationKeyFiguresYearToDateList200Response /notation/keyFigures/tradingDay/average/get: get: tags: - Notation operationId: get/notation/keyFigures/tradingDay/average/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: >- Average end-of-day (EOD) key figures for different trading days periods. A trading day is a calendar day on that trading of the notation was possible. summary: Factset Average end-of-day (EOD) key figures for different trading days periods. parameters: - name: identifier in: query schema: type: string pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: >- #/components/responses/GetNotationKeyFiguresTradingDayAverageGet200Response /notation/market/list: post: tags: - Notation operationId: post/notation/market/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: true 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 description: >- List of markets with entitled notations. The list contains only markets with at least one active and entitled notation. All identifiers used as parameters must be valid and entitled. summary: Factset List of markets with entitled notations. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostNotationMarketListRequest' required: false responses: '200': $ref: '#/components/responses/PostNotationMarketList200Response' parameters: [] /notation/selectionList/list: get: tags: - Notation operationId: get/notation/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 notation-level selection lists. summary: Factset Set of custom notation-level selection lists. responses: '200': $ref: '#/components/responses/GetNotationSelectionListList200Response' 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. /notation/selectionList/listByNotation: get: tags: - Notation operationId: get/notation/selectionList/listByNotation 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 notation, returns the notation-level selection lists of which the notation is a member. summary: >- Factset For each given notation, returns the notation-level selection lists of which the notation 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}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ uniqueItems: true minItems: 1 maxItems: 100 required: true style: form explode: false - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: >- #/components/responses/GetNotationSelectionListListByNotation200Response /notation/selectionList/members/list: post: tags: - Notation operationId: post/notation/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: 6 x-supportsPermissionDeniedResponse: false summary: Factset List of notations belonging to a notation-level selection list. description: List of notations belonging to a notation-level selection list. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostNotationSelectionListMembersListRequest' required: false responses: '200': $ref: >- #/components/responses/PostNotationSelectionListMembersList200Response parameters: [] /notation/status/get: get: tags: - Notation operationId: get/notation/status/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: true x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: >- Intraday trading status of a notation.
The endpoint is subscribable to provide push updates. See attribute `_subscriptionMinimalInterval` for valid update rates. summary: Factset Intraday trading status of a notation. parameters: - name: identifier in: query schema: type: string pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: quality in: query schema: type: string description: >- Quality of the trading status. The trading status and related data for a notation cannot be retrieved in end-of-day quality (EOD). default: DLY x-enum-description: - >- Real-time: trading status with minimal technical processing delays. - >- Delayed: trading status with an exchange-imposed delay of usually 15 to 30 minutes. - >- Best: choose the trading status quality with the least delay, as entitled for the client. enum: - RLT - DLY - BST 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. - description: Minimum number of milliseconds at which updates are sent. name: _subscriptionMinimumInterval in: query schema: type: number format: int32 default: 5000 x-enum-description: - 1 second - 5 seconds - 10 seconds - 30 seconds - 60 seconds - 300 seconds enum: - 1000 - 5000 - 10000 - 30000 - 60000 - 300000 responses: '200': $ref: '#/components/responses/GetNotationStatusGet200Response' /prices/get: get: tags: - Prices operationId: get/prices/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: true x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: >- Factset Overview of trading on the most recent trading day, including the latest price, for a notation. description: >- Overview of trading on the most recent trading day, including the latest price, for a notation. The endpoint is subscribable to provide push updates. See attribute `_subscriptionMinimalInterval` for valid update rates. parameters: - name: identifier in: query schema: type: string pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: quality in: query schema: type: string description: Quality of the price. default: DLY x-enum-description: - >- Real-time: intraday prices with minimal technical processing delays. - >- 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. - >- Best: choose the price quality with the least delay, as entitled for the client. enum: - RLT - DLY - EOD - BST 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. - description: Minimum number of milliseconds at which updates are sent. name: _subscriptionMinimumInterval in: query schema: type: number format: int32 default: 5000 x-enum-description: - 1 second - 5 seconds - 10 seconds - 30 seconds - 60 seconds - 300 seconds enum: - 1000 - 5000 - 10000 - 30000 - 60000 - 300000 responses: '200': $ref: '#/components/responses/GetPricesGet200Response' /prices/list: get: tags: - Prices operationId: get/prices/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 Overview of trading on the most recent trading day, including the latest price, for a list of notations. description: >- Overview of trading on the most recent trading day, including the latest price, for a list of notations. parameters: - name: identifiers in: query schema: description: Set of identifiers to resolve. type: array nullable: false items: type: string minLength: 3 exclusiveMinimum: false maxLength: 50 exclusiveMaximum: false pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ uniqueItems: true minItems: 1 maxItems: 100 required: true style: form explode: false - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: quality in: query schema: type: string description: Quality of the price. default: DLY x-enum-description: - >- Real-time: intraday prices with minimal technical processing delays. - >- 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. - >- Best: choose the price quality with the least delay, as entitled for the client. enum: - RLT - DLY - EOD - BST required: false - name: sameQuality in: query schema: type: boolean default: true description: Ensure that the prices for all notations are of the same quality. 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. responses: '200': $ref: '#/components/responses/GetPricesList200Response' /prices/bidAsk/get: get: tags: - Prices operationId: get/prices/bidAsk/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: true x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset Most recent bid and ask prices (best bid / offer) for a notation. description: >- Most recent bid and ask prices (best bid / offer) for a notation. The endpoint is subscribable to provide push updates. See attribute `_subscriptionMinimalInterval` for valid update rates. parameters: - name: identifier in: query schema: type: string pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: quality in: query schema: type: string description: Quality of the price. default: DLY x-enum-description: - >- Real-time: intraday prices with minimal technical processing delays. - >- 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. - >- Best: choose the price quality with the least delay, as entitled for the client. enum: - RLT - DLY - EOD - BST 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. - description: Minimum number of milliseconds at which updates are send. name: _subscriptionMinimumInterval in: query schema: type: number format: int32 default: 5000 x-enum-description: - 1 second - 5 seconds - 10 seconds - 30 seconds - 60 seconds - 300 seconds enum: - 1000 - 5000 - 10000 - 30000 - 60000 - 300000 responses: '200': $ref: '#/components/responses/GetPricesBidAskGet200Response' /prices/bidAsk/list: get: tags: - Prices operationId: get/prices/bidAsk/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 Most recent bid and ask prices (best bid / offer) for a list of notations. description: >- Most recent bid and ask prices (best bid / offer) for a list of notations. parameters: - name: identifiers in: query schema: description: Set of identifiers to resolve. type: array nullable: false items: type: string minLength: 3 exclusiveMinimum: false maxLength: 50 exclusiveMaximum: false pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ uniqueItems: true minItems: 1 maxItems: 100 required: true style: form explode: false - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: quality in: query schema: type: string description: Quality of the price. default: DLY x-enum-description: - >- Real-time: intraday prices with minimal technical processing delays. - >- 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. - >- Best: choose the price quality with the least delay, as entitled for the client. enum: - RLT - DLY - EOD - BST required: false - name: sameQuality in: query schema: type: boolean default: true description: Ensure that the prices for all notations are of the same quality. 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. responses: '200': $ref: '#/components/responses/GetPricesBidAskList200Response' /prices/orderbook/aggregated/get: get: tags: - Prices operationId: get/prices/orderbook/aggregated/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: true x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset Orderbook aggregated by price. description: Orderbook aggregated by price. parameters: - name: identifier in: query schema: type: string pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: quality in: query schema: type: string description: Quality of the price. default: RLT x-enum-description: - >- Real-time: intraday prices with minimal technical processing delays. - >- Delayed: intraday prices with an exchange-imposed delay of usually 15 to 30 minutes. - >- Best: choose the price quality with the least delay, as entitled for the client. enum: - RLT - DLY - BST 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. - description: Non-negative number of milliseconds to throttle the update rate. name: _subscriptionMinimumInterval in: query schema: type: number format: int32 minimum: 1000 exclusiveMinimum: false maximum: 300000 exclusiveMaximum: false default: 5000 x-enum-description: - 1 second - 5 seconds - 10 seconds - 30 seconds - 1 minute - 5 minutes enum: - 1000 - 5000 - 10000 - 30000 - 60000 - 300000 responses: '200': $ref: '#/components/responses/GetPricesOrderbookAggregatedGet200Response' /prices/orderbook/full/get: get: tags: - Prices operationId: get/prices/orderbook/full/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: true x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset Full orderbook description: Full orderbook parameters: - name: identifier in: query schema: type: string pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: quality in: query schema: type: string description: Quality of the price. default: RLT x-enum-description: - >- Real-time: intraday prices with minimal technical processing delays. - >- Delayed: intraday prices with an exchange-imposed delay of usually 15 to 30 minutes. - >- Best: choose the price quality with the least delay, as entitled for the client. enum: - RLT - DLY - BST 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. - description: Non-negative number of milliseconds to throttle the update rate. name: _subscriptionMinimumInterval in: query schema: type: number format: int32 minimum: 1000 exclusiveMinimum: false maximum: 300000 exclusiveMaximum: false default: 5000 x-enum-description: - 1 second - 5 seconds - 10 seconds - 30 seconds - 1 minute - 5 minutes enum: - 1000 - 5000 - 10000 - 30000 - 60000 - 300000 responses: '200': $ref: '#/components/responses/GetPricesOrderbookFullGet200Response' /prices/tradingSchedule/event/list: post: tags: - Prices operationId: post/prices/tradingSchedule/event/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: true x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset Sequence of market-related events. description: >- Sequence of market-related events like the opening time or closing time of a market of a specific notation.

Pagination to a previous page is not supported and `pagination.previous` is always `null`. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostPricesTradingScheduleEventListRequest' required: true responses: '200': $ref: '#/components/responses/PostPricesTradingScheduleEventList200Response' parameters: [] /prices/tradingSchedule/event/type/list: get: tags: - Prices operationId: get/prices/tradingSchedule/event/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 Trading schedule event types. description: >- Trading schedule event types define the events which may occur during any period of trading. Types of trading schedule events are for instance OPEN, CLOSE, END_OF_DAY. responses: '200': $ref: >- #/components/responses/GetPricesTradingScheduleEventTypeList200Response 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. /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' /notation/search/basic: get: tags: - Notation operationId: get/notation/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 notations. description: >- Search for a notation whose ISIN, specified NSINs, name, or symbol match the search value according to a tolerant full-text match algorithm. If more than one notation of an instrument matches, only the notation with the highest monetary trading volume, averaged over one month, is considered. Better matching results appear in the response before less relevant matches. If the parameter popularity is set to true, the popularity of the notation is the primary sort criterion. Popularity is affected mostly by the request frequency of the notation. parameters: - name: searchValue in: query schema: type: string minLength: 3 exclusiveMinimum: false maxLength: 200 exclusiveMaximum: false pattern: ^[ -!#-&(-+--/0-:=?-Za-z\w"]*$ description: >- Full-text search string. 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 notation; 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 notations. default: true required: false - name: popularity in: query schema: type: boolean default: false description: If true, the results are sorted by descending popularity. 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/GetNotationSearchBasic200Response' /notation/searchByText: post: tags: - Notation operationId: post/notation/searchByText 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: 6 x-supportsPermissionDeniedResponse: false summary: Factset Text-based search for notations. description: >- Text-based search for notations in selected identifier and name attributes according to a tolerant full-text match algorithm. The results satisfy all selected filters; sorting by various attributes is possible. If more than one notation of an instrument matches, only the notation with the best market priority (according to the parameter `market.priority`) or, in the absence of market priorities, only the notation with the highest trading volume, averaged over one month, is considered. All identifiers used as parameters must be valid and entitled. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostNotationSearchByTextRequest' required: true responses: '200': $ref: '#/components/responses/PostNotationSearchByText200Response' parameters: [] components: schemas: ErrorMetaObject: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' ErrorObject: type: array description: >- The errors member contains additional information about a failed request. items: type: object properties: details: type: string description: >- A human-readable, unstructured explanation specific to this occurrence of the failure. encryptedDetails: type: string description: >- Base64-encoded, internal details about the error, in addition to "details". type: type: number format: int32 description: Internal error type of the Foundation API protocol. attribute: type: array description: >- For a validation error, a reference to the request parameter that failed validation; otherwise, an empty array. items: type: object properties: name: type: string description: Element of the path denoting the request parameter. index: type: number format: int32 description: >- If the attribute "name" designates an array, index of the array element; otherwise the special value -1. x-property-sort: - name - index x-property-sort: - details - encryptedDetails - type - attribute 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 LanguageMember: type: string format: isoLanguage description: ISO 639-1 code of the language. maxLength: 2 minLength: 2 exclusiveMinimum: false exclusiveMaximum: false 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). description: The status member contains the status code of the response. required: - code CursorBasedPaginationOutputObject: type: object description: Pagination attributes for the cursor-based pagination strategy. properties: total: type: number format: int32 description: Total number of entries in the result set. isEstimatedTotal: type: boolean description: Flag indicating that the value of `total` is estimated. 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`. 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`. required: - total - isEstimatedTotal - next - previous x-property-sort: - total - isEstimatedTotal - next - previous 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`. 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`. required: - next - previous x-property-sort: - next - previous 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. isEstimatedTotal: type: boolean description: Flag indicating that the value of "total" is estimated. required: - total - isEstimatedTotal x-property-sort: - total - isEstimatedTotal OffsetBasedPaginationOutputObjectWithoutTotal: type: object description: >- Pagination attributes for the offset-based pagination strategy; a total element count is not supported. properties: hasNext: type: boolean description: >- Flag indicating that a subsequent request with the same parameters, except that the parameter `pagination.offset` is incremented by `pagination.limit`, would yield additional results. required: - hasNext x-property-sort: - hasNext 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. description: Object denoting that the endpoint response is possibly incomplete. required: - isPartial x-property-sort: - isPartial PostBasicBackgroundTextTypeListRequest: 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 minItems: 1 maxItems: 100 uniqueItems: true description: >- List of background text type identifiers. Invalid identifiers result in an error. meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' x-property-sort: - attributes PostBasicDeliveryListRequest: 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 minItems: 1 maxItems: 100 uniqueItems: true description: >- List of delivery identifiers. Invalid identifiers result in an error. meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' 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: - name - '-name' maxItems: 1 uniqueItems: true default: - name x-property-sort: - attributes - sort PostBasicMarketListRequest: 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: - markets - 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 minItems: 1 maxItems: 100 uniqueItems: true description: >- List of market identifiers. Invalid identifiers result in an error. onlyActive: type: boolean default: true description: Indicates whether the market exists. 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 5 (possibly prefixed) attribute name(s) is allowed. type: array items: type: string enum: - name - '-name' - shortName - '-shortName' - country.name - '-country.name' - type.name - '-type.name' - group.name - '-group.name' maxItems: 5 uniqueItems: true default: - 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 PostBasicMediaTypeListRequest: 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: 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: - ids properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true minItems: 1 maxItems: 100 uniqueItems: true description: >- List of Internet media type identifiers. Invalid identifiers result in an error. meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' 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: - id - '-id' - name - '-name' maxItems: 2 uniqueItems: true default: - name x-property-sort: - attributes - sort PostBasicMicOperatingListRequest: 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: - status description: >- Criteria that filter the items in the response list; only items that match all of the criteria are returned. properties: status: type: string description: Filter for the status. default: active x-enum-description: - Show all operating MICs. - Show only active operating MICs. - Show only inactive operating MICs. enum: - all - active - inactive meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' 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: - isoCode - '-isoCode' - name - '-name' maxItems: 2 uniqueItems: true default: - 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 - sort - pagination PostBasicTimezoneListRequest: 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 minItems: 1 maxItems: 100 uniqueItems: true description: >- List of timezone identifiers. Invalid identifiers result in an error. meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' x-property-sort: - attributes PostBasicValueUnitListRequest: 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: - status description: >- Criteria that filter the items in the response list; only items that match all of the criteria are returned. properties: status: type: string description: Filter for the status. default: active x-enum-description: - Show all currencies. - Show only active currencies. - Show only inactive currencies. enum: - all - active - inactive 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: - name - '-name' maxItems: 1 uniqueItems: true default: - name x-property-sort: - attributes - language - sort PostBasicValueUnitCurrencyListRequest: 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: - status description: >- Criteria that filter the items in the response list; only items that match all of the criteria are returned. properties: status: type: string description: Filter for the status. default: active x-enum-description: - Show all currencies. - Show only active currencies. - Show only inactive currencies. enum: - all - active - inactive 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: - name - '-name' maxItems: 1 uniqueItems: true default: - name x-property-sort: - attributes - language - sort PostBasicValueUnitCurrencyMainListRequest: 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: - status description: >- Criteria that filter the items in the response list; only items that match all of the criteria are returned. properties: status: type: string description: Filter for the status. default: active x-enum-description: - Show all main currencies. - Show only active main currencies. - Show only inactive main currencies. enum: - all - active - inactive 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: - name - '-name' maxItems: 1 uniqueItems: true default: - name x-property-sort: - attributes - language - sort 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. 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 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 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 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 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 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. 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 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 meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' x-property-sort: - attributes 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 meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' x-property-sort: - attributes 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 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 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 meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' x-property-sort: - attributes 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 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 PostNotationCategoryListRequest: x-property-sort: - data - meta description: Request Body type: object properties: data: type: object x-property-sort: - identifier - identifierType - filter description: The data member contains the request's primary data. properties: identifier: type: string pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. identifierType: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional 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 - identifierType 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: - dataset.id - '-dataset.id' - dataset.name - '-dataset.name' maxItems: 2 uniqueItems: true default: - dataset.name x-property-sort: - attributes - language - sort 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 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 PostNotationCrossReferenceListByISINRequest: x-property-sort: - data - meta description: Request Body type: object properties: data: type: object x-property-sort: - isin - filter description: The data member contains the request's primary data. properties: isin: type: string format: isin description: International Securities Identification Number. 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: - isin 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 PostNotationCrossReferenceListBySymbolRequest: x-property-sort: - data - meta description: Request Body type: object properties: data: type: object x-property-sort: - symbol - filter description: The data member contains the request's primary data. properties: symbol: type: string maxLength: 32 exclusiveMaximum: false minLength: 1 exclusiveMinimum: false description: Market-specific code to identify a notation. 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: - symbol 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 PostNotationCrossReferenceFactSetIdentifierListByFactSetIdentifierRequest: x-property-sort: - data - meta description: Request Body required: - data type: object properties: data: type: object x-property-sort: - symbologyIdentifier description: The data member contains the request's primary data. properties: symbologyIdentifier: type: string pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[SLR]$|[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$ maxLength: 50 exclusiveMaximum: false minLength: 4 exclusiveMinimum: false description: >- FactSet Symbology Identifier. See the endpoint description for valid FactSet Symbology Identifier types. required: - symbologyIdentifier 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 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 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 PostNotationMarketListRequest: 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: - assetClass - country - group - type 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. Restricts the result to only markets with notations whose instruments belong to the selected asset classes. properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true maxItems: 13 uniqueItems: true description: >- Set of asset class identifiers. See endpoint `/basic/assetClass/list` for valid values. country: type: object x-property-sort: - ids description: Country of the markets. properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true maxItems: 100 uniqueItems: true description: >- List of country identifiers. See endpoint `/basic/region/country/list` for valid values. group: type: object x-property-sort: - ids description: Market group of the markets. properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true maxItems: 100 uniqueItems: true description: >- Set of market group identifiers. See endpoint `/basic/market/group/list` for valid values. type: type: object x-property-sort: - ids description: Type of the markets. properties: ids: type: array nullable: false items: type: number format: id32 x-positive: true maxItems: 7 uniqueItems: true description: >- Set of market type identifiers. See endpoint `/basic/market/type/list` for valid values. 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: - name - '-name' - count - '-count' maxItems: 2 uniqueItems: true default: - 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 PostNotationSelectionListMembersListRequest: 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: - market - valueUnit - assetClass - instrumentCategory description: >- Criteria that filter the items in the response list; only items that match all of the criteria are returned. properties: market: type: object x-property-sort: - restrict - exclude description: >- Market-related parameters. See endpoint `/basic/market/list` for valid values. x-atMostOne: true 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 valueUnit: type: object x-property-sort: - restrict - exclude description: >- Value unit-related parameters. See endpoint `/basic/valueUnit/list` for valid values. x-atMostOne: true 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 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 instrumentCategory: 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 instrument categories that the instruments of the notations 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 instrument categories that the instruments of the notations 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 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 6 (possibly prefixed) attribute name(s) is allowed. type: array items: type: string enum: - market.name - '-market.name' - valueUnit.name - '-valueUnit.name' - instrument.name.default.long - '-instrument.name.default.long' - instrument.name.default.short - '-instrument.name.default.short' - instrument.name.assetClassSpecific.long - '-instrument.name.assetClassSpecific.long' - instrument.name.assetClassSpecific.short - '-instrument.name.assetClassSpecific.short' maxItems: 6 uniqueItems: true default: - instrument.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 PostPricesTradingScheduleEventListRequest: 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: - value - type description: Identifier and type. properties: value: type: string pattern: >- ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. type: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - >- Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - >- Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: - value - type filter: type: object x-property-sort: - types - range 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 minItems: 1 description: >- List of trading schedule event types to return. See endpoint `/prices/tradingSchedule/event/type/list` for valid values. range: type: object format: timeRange properties: start: type: string format: datetime description: The starting point of the time range (inclusive). end: type: string format: datetime description: The ending point of the time range (exclusive). x-property-sort: - start - end required: - start - end description: >- Date and time range for the time series. A valid time range is between 1900-01-01 and 24 hours and 5 minutes into the future. required: - types - range required: - identifier meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' 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: 0 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 - pagination PostNotationSearchByTextRequest: x-property-sort: - data - meta description: Request Body required: - data type: object properties: data: type: object x-property-sort: - text - validation - assetClass - instrumentCategory - market description: The data member contains the request's primary data. properties: text: description: Text-related parameters. type: object x-property-sort: - attributes - value - minimumMatchScore properties: attributes: description: >- List of attributes to be searched in. The value `allEntitled` cannot appear with any other value. type: array nullable: false items: type: string x-enum-description: - All entitled attributes are searched in. - >- International Securities Identification Number of the instrument. - >- 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 SEDOL or IDII for the notation; see entity class "SEDOL or IDII" for details. - >- 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 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. - >- Symbol of an option or a future, as normalized by FactSet. - Long name of the instrument. - Short name of the instrument. enum: - allEntitled - isin - wkn - valor - sedol - cusip - symbol - normalizedSymbol - longName - shortName uniqueItems: true maxItems: 8 default: - allEntitled value: type: string minLength: 2 exclusiveMinimum: false maxLength: 50 exclusiveMaximum: false pattern: ^[ -+--/0-:=?@\p{L}]*$ description: >- Full-text search string. 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". If only two characters are submitted, the search is executed as an exact search. minimumMatchScore: type: number format: real minimum: 0.1 exclusiveMinimum: false maximum: 1 exclusiveMaximum: false description: >- Minimum match score for the text string. The match score has a value between 0 and 1 (inclusive), where a higher value indicates a better match than a lower one. Examples for the two most relevant thresholds: 0.25: Exact substring match after case-folding and modifier elimination - "Münchner Rück" is a match for the search string "Munch" but not for "Muench". 0.50: Exact substring match - "Münchner Rück" is a match for the search string "Münch" but not for "Munch" or "münch". default: 0.25 required: - value validation: description: Validation parameters. type: object x-property-sort: - onlyActive - prices - valueUnit - market - instrumentSelectionList - notationSelectionList 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 prices: description: Price-related parameters. type: object x-property-sort: - quality - latest - previous properties: quality: type: string description: Quality of the price. default: EOD 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-related parameters. 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: 100 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: 100 market: description: >- Market-related parameters. 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. 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 of 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 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 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 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 assetClass: description: Asset class restriction. type: object x-property-sort: - ids 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 exclusiveMaximum: false uniqueItems: true maxItems: 12 instrumentCategory: 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. type: object x-property-sort: - restrict - exclude x-atMostOne: true properties: restrict: description: >- Specifies the instrument categories that the instruments of the notations may have 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 maxItems: 20 uniqueItems: true exclude: description: >- Specifies the instrument categories that the instruments of the notations may not have. 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 maxItems: 20 uniqueItems: true market: description: Market-related notation sorting. type: object x-property-sort: - order properties: order: description: >- Sequence of market identifiers specifying the first-order sort criterion for the resulting notation list; 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 second-order sorting of the result is given by the attribute `meta.sort`. The list does not restrict the request to only those markets (use the parameter `market.selection` for that purpose) and does not specify the priority order of the markets for selecting one notation per instrument (use the parameter `market.priority` for that purpose). type: object x-property-sort: - ids properties: ids: description: >- List of market identifiers. See endpoint `/basic/market/list` for valid values. type: array nullable: false items: type: number format: id32 x-positive: true uniqueItems: true maxItems: 100 required: - text 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 6 (possibly prefixed) attribute name(s) is allowed. type: array items: type: string enum: - instrument.name.default.long - '-instrument.name.default.long' - instrument.name.default.short - '-instrument.name.default.short' - instrument.name.assetClassSpecific.long - '-instrument.name.assetClassSpecific.long' - instrument.name.assetClassSpecific.short - '-instrument.name.assetClassSpecific.short' - match.score - '-match.score' - averageIndicativeTradingValue30TD - '-averageIndicativeTradingValue30TD' maxItems: 6 uniqueItems: true default: - '-match.score' 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 responses: ErrorResponse: description: Generic error response for all errors (400 ... 599 error codes) headers: {} content: application/json: schema: type: object properties: meta: $ref: '#/components/schemas/ErrorMetaObject' errors: $ref: '#/components/schemas/ErrorObject' x-property-sort: - meta - errors GetBasicAssetClassList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array nullable: false items: type: object nullable: false x-property-sort: - id - code - description properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of an asset class. code: nullable: true type: string description: Code of the asset class. description: nullable: true type: string description: Description of the asset class in English. description: >- List of asset classes sorted ascending by identifier of the asset class. 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 PostBasicBackgroundTextTypeList200Response: 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 description: English name of the type. description: nullable: true type: string description: English description of the type. description: List of background text 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 GetBasicBenchmarkTypeList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of benchmark types. 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 benchmark type. name: nullable: true type: string format: localizedString description: Name of the benchmark type. description: nullable: true type: string format: localizedString description: Description of the benchmark 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 PostBasicDeliveryList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of deliveries. 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 delivery. name: nullable: true x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string description: English name of the delivery. description: nullable: true type: string description: English description of the delivery. 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 GetBasicFrequencyTypeList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of frequency types. nullable: false 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 type. name: nullable: true type: string format: localizedString description: Name 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 GetBasicLanguageGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: code: nullable: true type: string description: ISO 639-1 code of the language. name: nullable: true type: string format: localizedString description: Name of the language. description: Details of a language. nullable: false x-property-sort: - code - name 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 GetBasicLanguageGetByCode200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a language. name: nullable: true type: string format: localizedString description: Name of the language. description: Details of a language. nullable: false x-property-sort: - id - name 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 GetBasicLanguageList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of languages. nullable: false items: type: object nullable: false x-property-sort: - id - code - name properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a language. code: nullable: true x-sortable: true type: string description: ISO 639-1 code of the language. name: nullable: true x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string format: localizedString description: Name of the language. 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 GetBasicMarketGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: name: nullable: true type: string format: localizedString description: Name of the market. shortName: nullable: true type: string format: localizedString description: Short name of the market. active: nullable: true type: boolean description: Indicates whether the market exists. country: nullable: false type: object x-property-sort: - id - name description: Country of the market. 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. type: nullable: false type: object x-property-sort: - id - name description: Type of the market. 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. group: nullable: false type: object x-property-sort: - id - name description: Market group of the market. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the market group. name: nullable: true type: string format: localizedString description: Name of the market group. timezone: nullable: false type: object x-property-sort: - id - name description: Timezone of the market. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the timezone. name: nullable: true type: string format: localizedString description: Name of the timezone. description: Details of a market nullable: false x-property-sort: - name - shortName - active - country - type - group - timezone 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 PostBasicMarketList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of markets. nullable: false items: type: object nullable: false x-property-sort: - id - name - shortName - active - country - type - group - timezone properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the market. name: nullable: true x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string format: localizedString description: Name of the market. shortName: nullable: true x-sortable: true type: string format: localizedString description: Short name of the market. active: nullable: true type: boolean description: Indicates whether the market exists. country: nullable: false type: object x-property-sort: - id - name description: Country of the market. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the country. name: nullable: true x-sortable: true type: string format: localizedString description: Name of the country. type: nullable: false type: object x-property-sort: - id - name description: Type of the market. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the type. name: nullable: true x-sortable: true type: string format: localizedString description: Name of the type. group: nullable: false type: object x-property-sort: - id - name description: Market group of the market. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the market group. name: nullable: true x-sortable: true type: string format: localizedString description: Name of the market group. timezone: nullable: false type: object x-property-sort: - id - name description: Timezone of the market. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the timezone. name: nullable: true type: string format: localizedString description: Name of the timezone. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' pagination: $ref: >- #/components/schemas/OffsetBasedPaginationOutputObjectWithoutTotal x-property-sort: - status - pagination x-property-sort: - data - meta GetBasicMarketGroupList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of market groups. nullable: false items: type: object nullable: false x-property-sort: - id - name - shortName properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the market group. name: nullable: true x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string format: localizedString description: Name of the market group. shortName: nullable: true x-sortable: true type: string format: localizedString description: Short name of the market group. 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 GetBasicMarketTypeList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of market types. nullable: false 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 market type. name: nullable: true x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string format: localizedString description: Name of the market 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 GetBasicMediaKindList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of media kinds. 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 media kind. name: nullable: true type: string description: English name of the media kind. description: nullable: true type: string description: English description of the media kind. 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 PostBasicMediaTypeList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of Internet media types. nullable: false items: type: object nullable: false x-property-sort: - id - name - description - kind properties: id: nullable: true description: Identifier of an Internet media type. x-sortable: true type: number format: id32 x-positive: true name: nullable: true description: >- Name according to the Internet Assigned Numbers Authority. x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string description: nullable: true description: English description of the Internet media type. type: string kind: nullable: false description: >- Kind of media. See endpoint `/basic/media/kind/list` for possible values. type: object x-property-sort: - id - name properties: id: nullable: true description: Identifier of the media kind. type: number format: id32 x-positive: true name: nullable: true description: English name of the media kind. 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 PostBasicMicOperatingList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of operating MICs. nullable: false items: type: object nullable: false x-property-sort: - id - isoCode - name - active properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the operating MIC. isoCode: nullable: true x-sortable: true type: string description: ISO 10383 code of the operating MIC. name: nullable: true x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string description: English name of the operating MIC. active: nullable: true type: boolean description: Indicates whether the operating MIC is active. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' pagination: $ref: >- #/components/schemas/OffsetBasedPaginationOutputObjectWithoutTotal x-property-sort: - status - pagination x-property-sort: - data - meta GetBasicRegionGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: code: nullable: true type: string description: >- ISO 3166-1 alpha-2 code of the country. This attribute is set for each country, may be set for miscellaneous regions and is empty for regions of other types. name: nullable: true type: string format: localizedString description: Name of the region. type: nullable: true type: string description: Type of the region. x-enum-description: - >- Regions that are considered to be a continent in the context of the Market Data Gateway. - >- A region that represents a country that has been assigned an official ISO 3166-1 code. - >- A region that represents a subdivision of a country that has been assigned an official ISO 3166-2 code. - >- A miscellaneous region represents a region that is neither a continent, nor a country, nor a subdivision of a country. - >- A compound miscellaneous region consists of member regions which are uniquely and undoubtedly defined. enum: - continent - country - subdivision - misc - compound nestedRegions: nullable: false type: array items: type: object nullable: false x-property-sort: - id - code - name - type properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a region. code: nullable: true type: string description: >- ISO 3166-1 alpha-2 code of the country. This attribute is set for each country, may be set for miscellaneous regions and is empty for regions of other types. name: nullable: true type: string format: localizedString description: Name of the region. type: nullable: true type: string description: Type of the region. x-enum-description: - >- Regions that are considered to be a continent in the context of the Market Data Gateway. - >- A region that represents a country that has been assigned an official ISO 3166-1 code. - >- A region that represents a subdivision of a country that has been assigned an official ISO 3166-2 code. - >- A miscellaneous region represents a region that is neither a continent, nor a country, nor a subdivision of a country. - >- A compound miscellaneous region consists of member regions which are uniquely and undoubtedly defined. enum: - continent - country - subdivision - misc - compound description: Nested regions of this region. description: Details of a region. nullable: false x-property-sort: - code - name - type - nestedRegions 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 GetBasicRegionList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of regions. nullable: false items: type: object nullable: false x-property-sort: - id - code - name - type properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a region. code: nullable: true x-sortable: true type: string description: >- ISO 3166-1 alpha-2 code of the country. This attribute is set for each country, may be set for miscellaneous regions and is empty for regions of other types. name: nullable: true x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string format: localizedString description: Name of the region. type: nullable: true type: string description: Type of the region. x-enum-description: - >- Regions that are considered to be a continent in the context of the Market Data Gateway. - >- A region that represents a country that has been assigned an official ISO 3166-1 code. - >- A region that represents a subdivision of a country that has been assigned an official ISO 3166-2 code. - >- A miscellaneous region represents a region that is neither a continent, nor a country, nor a subdivision of a country. - >- A compound miscellaneous region consists of member regions which are uniquely and undoubtedly defined. enum: - continent - country - subdivision - misc - compound 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 GetBasicRegionContinentGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: name: nullable: true type: string format: localizedString description: Name of the continent. countries: nullable: false type: array items: type: object nullable: false x-property-sort: - id - name description: Countries of this continent. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a country. name: nullable: true type: string format: localizedString description: Name of a country. description: Details for a continent. nullable: false x-property-sort: - name - countries 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 GetBasicRegionContinentList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of continents. nullable: false 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 continent. name: nullable: true x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string format: localizedString description: Name of the continent. 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 GetBasicRegionCountryGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: code: nullable: true type: string description: ISO 3166-1 alpha-2 code of the country. name: nullable: true type: string format: localizedString description: Name of the country. subdivisions: nullable: false type: array items: type: object nullable: false x-property-sort: - id - name description: Subdivisions of a country in unspecified order. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a country subdivision. name: nullable: true type: string format: localizedString description: Name of the country subdivision. description: Details of a country. nullable: false x-property-sort: - code - name - subdivisions 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 GetBasicRegionCountryGetByCode200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a country. name: nullable: true type: string format: localizedString description: Name of the country. subdivisions: nullable: false type: array items: type: object nullable: false x-property-sort: - id - name description: Subdivisions of this country in unspecified order. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a country subdivision. name: nullable: true type: string format: localizedString description: Name of the country subdivision. description: Details of a country. nullable: false x-property-sort: - id - name - subdivisions 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 GetBasicRegionCountryList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of countries. nullable: false items: type: object nullable: false x-property-sort: - id - code - name properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a country. code: nullable: true x-sortable: true type: string description: ISO 3166-1 alpha-2 code of the country. name: nullable: true x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string format: localizedString description: Name of the country. 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 GetBasicTimezoneGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a timezone. name: nullable: true type: string description: Name according to the Internet Assigned Numbers Authority. description: Details of a timezone. nullable: false x-property-sort: - id - name 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 GetBasicTimezoneGetByName200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a timezone. name: nullable: true type: string description: Name according to the Internet Assigned Numbers Authority. description: Details of a timezone. nullable: false x-property-sort: - id - name 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 PostBasicTimezoneList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of timezones in unspecified order. nullable: false 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 timezone. name: nullable: true type: string description: >- Name according to the Internet Assigned Numbers Authority. 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 GetBasicValueUnitGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: 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. type: nullable: true type: string description: Type of the value unit. x-enum-description: - Main currency. - Fractional currency. - Alternative value unit. enum: - main - fractional - alternative active: nullable: true type: boolean description: Indicates whether the value unit is active. description: Details of a value unit. nullable: false x-property-sort: - code - isoCode - name - type - active 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 PostBasicValueUnitList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of value units. nullable: false items: type: object nullable: false x-property-sort: - id - code - isoCode - name - type - active properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a 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 x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string format: localizedString description: Name of the value unit. type: nullable: true type: string description: Type of the value unit. x-enum-description: - Main currency. - Fractional currency. - Alternative value unit. enum: - main - fractional - alternative active: nullable: true type: boolean description: Indicates whether the currency is active. 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 GetBasicValueUnitAlternativeList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of alternative units. nullable: false items: type: object nullable: false x-property-sort: - id - code - name properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of an alternative unit. code: nullable: true type: string description: Code of the alternative unit. name: nullable: true x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string format: localizedString description: Name of the alternative unit. 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 PostBasicValueUnitCurrencyList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of currencies. nullable: false items: type: object nullable: false x-property-sort: - id - code - isoCode - name - type - active properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a currency. code: nullable: true type: string description: >- Code of the currency: 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. 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 x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string format: localizedString description: Name of the currency. type: nullable: true type: string description: Type of the currency. x-enum-description: - Currency that is a main currency. - Currency that is a fractional currency. enum: - main - fractional active: nullable: true type: boolean description: Indicates whether the currency is active. 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 GetBasicValueUnitCurrencyFractionalGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: code: nullable: true type: string description: >- Code of the fractional currency such as GBp (for British pence), USc (for U.S. cents), EUc for (Euro cent). name: nullable: true type: string format: localizedString description: Name of the fractional currency. factor: nullable: true type: number format: real description: >- Conversion factor between the fractional and its main currency. For example, the value 100 indicates that 100 US cents are equivalent to one US dollar. mainCurrency: nullable: false type: object x-property-sort: - id - code - isoCode - name - active description: Main currency corresponding to the fractional currency. 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 currency. name: nullable: true type: string format: localizedString description: Name of the main currency. active: nullable: true type: boolean description: Indicates whether the currency is active. description: Details of a fractional currency. nullable: false x-property-sort: - code - name - factor - mainCurrency 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 GetBasicValueUnitCurrencyFractionalList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of fractional currencies. nullable: false items: type: object nullable: false x-property-sort: - id - code - name - factor - mainCurrency properties: id: nullable: true type: number format: id32 x-positive: true description: >- Identifier of the fractional currency, which is a value unit. code: nullable: true type: string description: >- Code of the fractional currency such as GBp (for British pence), USc (for U.S. cents), EUc for (Euro cent). name: nullable: true x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string format: localizedString description: Name of the fractional currency. factor: nullable: true type: number format: real description: >- Conversion factor between the fractional and its main currency. For example, the value 100 indicates that 100 US cents are equivalent to one US dollar. mainCurrency: nullable: false type: object x-property-sort: - id - code - isoCode - name - active description: Main currency corresponding to the fractional currency. properties: id: nullable: true type: number format: id32 x-positive: true description: >- Identifier of the main currency of the fractional 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. name: nullable: true type: string format: localizedString description: Name of the main currency. active: nullable: true type: boolean description: Indicates whether the currency is active. 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 PostBasicValueUnitCurrencyMainList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of main currencies. nullable: false items: type: object nullable: false x-property-sort: - id - code - isoCode - name - active properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a 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. name: nullable: true x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string format: localizedString description: Name of the currency. active: nullable: true type: boolean description: Indicates whether the currency is active. 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 GetCategoryGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: code: nullable: true type: string description: Code commonly used for this category. name: nullable: true type: string format: localizedString description: Name of the category. description: nullable: true type: string format: localizedString description: Description of the category. active: nullable: true type: boolean description: Indicates whether this category is active. level: nullable: false type: object x-property-sort: - id - name - number description: Category level. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the category level. name: nullable: true type: string format: localizedString description: Name of the category level. number: nullable: true type: number format: int32 description: >- Number of the category level starting with 1, indicating the distance to the root of the category hierarchy. parent: nullable: false type: object x-property-sort: - id - name - level description: >- Parent category. The attributes of the parent category are `null` if this category is on the first level. 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. level: nullable: false type: object x-property-sort: - id - name description: Parent level. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the category level. name: nullable: true type: string format: localizedString description: Name of the category level. system: nullable: false type: object x-property-sort: - id - name description: Category system. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the category system. name: nullable: true type: string format: localizedString description: Name of the category system. description: Details of the category. nullable: false x-property-sort: - code - name - description - active - level - parent - 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 GetCategoryList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: system: nullable: false type: object x-property-sort: - id - name description: Category system. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the category system. name: nullable: true type: string format: localizedString description: Name of the category system. categories: nullable: false type: array items: type: object nullable: false x-property-sort: - id - code - name - description - active - level - parent properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the category. code: nullable: true type: string description: Code commonly used for this category. name: nullable: true type: string format: localizedString description: Name of the category. description: nullable: true type: string format: localizedString description: Description of the category. active: nullable: true type: boolean description: Indicates whether this category is active. level: nullable: false type: object x-property-sort: - id - name - number description: Category level. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the category level. name: nullable: true type: string format: localizedString description: Name of the category level. number: nullable: true type: number format: int32 description: >- Number of the category level starting with 1, indicating the distance to the root of the category hierarchy. parent: nullable: false type: object x-property-sort: - id - name - level description: >- Parent category. The attributes of the parent category are `null` if this category is on the first level. 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. level: nullable: false type: object x-property-sort: - id - name description: Parent level. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the category level. name: nullable: true type: string format: localizedString description: Name of the category level. description: List of categories. description: List of categories. nullable: false x-property-sort: - system - categories 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 GetCategoryListByLevel200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: system: nullable: false type: object x-property-sort: - id - name description: Category system. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the category system. name: nullable: true type: string format: localizedString description: Name of the category system. parent: nullable: false type: object x-property-sort: - id - name description: >- Parent level. The attributes of the parent level are `null` if this category level is the first level. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the category level. name: nullable: true type: string format: localizedString description: Name of the category level. categories: nullable: false type: array items: type: object nullable: false x-property-sort: - id - code - name - description - active - parent properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the category. code: nullable: true type: string description: Code commonly used for this category. name: nullable: true type: string format: localizedString description: Name of the category. description: nullable: true type: string format: localizedString description: Description of the category. active: nullable: true type: boolean description: Indicates whether this category is active. parent: nullable: false type: object x-property-sort: - id - name description: >- Parent category. The attributes of the parent category are `null` if this category is on the first level. 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. description: List of the categories. nullable: false x-property-sort: - system - parent - categories 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 GetCategoryListBySystem200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: categories: nullable: false type: array items: type: object nullable: false x-property-sort: - id - code - name - description - active - level - parent properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the category. code: nullable: true type: string description: Code commonly used for this category. name: nullable: true type: string format: localizedString description: Name of the category. description: nullable: true type: string format: localizedString description: Description of the category. active: nullable: true type: boolean description: Indicates whether this category is active. level: nullable: false type: object x-property-sort: - id - number description: Category level. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the category level. number: nullable: true type: number format: int32 description: >- Number of the category level starting with 1, indicating the distance to the root of the category hierarchy. parent: nullable: false type: object x-property-sort: - id description: >- Parent category. The attributes of the parent category are `null` if this category is on the first level. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the category. description: List of categories. description: List of the categories. nullable: false x-property-sort: - categories 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 GetCategoryDatasetList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of category datasets. nullable: false items: type: object nullable: false x-property-sort: - id - name - depth - system - delivery properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the dataset. name: nullable: true type: string format: localizedString description: Name of the dataset. depth: nullable: true type: number format: int32 description: >- Number of levels covered by this dataset for the category system. system: nullable: false type: object x-property-sort: - id - name - numberOfLevels - firstLevelWithLeafCategories description: Category system. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the category system. name: nullable: true type: string format: localizedString description: Name of the category system. numberOfLevels: nullable: true type: number format: int32 description: Number of levels of the category system. firstLevelWithLeafCategories: nullable: true type: number format: int32 description: >- Number of the least detailed level of the category system that has leaf categories. delivery: nullable: false type: object x-property-sort: - id - name description: >- Delivery which provides this category dataset. For possible values, see endpoint `/basic/delivery/list`. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the delivery. name: nullable: true type: string description: English name of the delivery. 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 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 GetCategoryLevelGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: name: nullable: true type: string format: localizedString description: Name of the level. number: nullable: true type: number format: int32 description: Number of the category level, starting with 1. hasLeafCategories: nullable: true type: boolean description: Indicates whether the category level has leaf categories. system: nullable: false type: object x-property-sort: - id - name description: Details of the system this level belongs to. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the category system. name: nullable: true type: string format: localizedString description: Name of the category system. description: Details of the category level. nullable: false x-property-sort: - name - number - hasLeafCategories - 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 GetCategoryPathGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: 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 level of the specified category. nullable: false x-property-sort: - categories description: Path to the category. 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 GetCategorySystemGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the category system. name: nullable: true type: string format: localizedString description: Name of the category system. type: nullable: false description: >- Type of the category system. See endpoint `/category/system/type/list` for possible values. type: object x-property-sort: - id - name properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the type of the category system. name: nullable: true type: string format: localizedString description: Name of the type of the category system. numberOfLevels: nullable: true type: number format: int32 description: Number of levels of the category system. firstLevelWithLeafCategories: nullable: true type: number format: int32 description: >- Number of the least detailed level of the category system that has leaf categories. levels: nullable: false type: array items: type: object nullable: false x-property-sort: - id - name - number - hasLeafCategories properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the level. name: nullable: true type: string format: localizedString description: Name of the level. number: nullable: true type: number format: int32 description: Number of the category level, starting with 1. hasLeafCategories: nullable: true type: boolean description: >- Indicates whether the category level has leaf categories. description: >- List of category levels ordered by the number of the level in ascending order. description: Details of the category system. nullable: false x-property-sort: - id - name - type - numberOfLevels - firstLevelWithLeafCategories - levels 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 GetCategorySystemList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of category systems. nullable: false items: type: object nullable: false x-property-sort: - id - name - type - numberOfLevels - firstLevelWithLeafCategories properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the category system. name: nullable: true type: string format: localizedString description: Name of the category system. type: nullable: false description: >- Type of the category system. See endpoint `/category/system/type/list` for possible values. type: object x-property-sort: - id - name properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the type of the category system. name: nullable: true type: string format: localizedString description: Name of the type of the category system. numberOfLevels: nullable: true type: number format: int32 description: Number of levels of the category system. firstLevelWithLeafCategories: nullable: true type: number format: int32 description: >- Number of the least detailed level of the category system that has leaf categories. 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 GetCategorySystemTypeList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: >- List of category system types, sorted by ascending 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 the category system type. name: nullable: true type: string format: localizedString description: Name of the category system type. description: nullable: true type: string format: localizedString description: Description of the category system 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 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 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 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 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 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 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 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 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 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 (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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 GetNotationGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. 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. factSetMarketSymbol: nullable: true type: string description: >- The FactSet market symbol of the notation (i.e. TICKER_EXCHANGE). valueUnit: nullable: false type: object x-property-sort: - id - code - isoCode - name description: >- The identifier of the unit in which prices of the notation are expressed. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the value unit. code: nullable: true type: string description: >- Currency code according to ISO 4217, a code such as GBp (for British pence), USc (for U.S. cents), EUc for (Euro cent), or a code for an alternative unit such as PT (points), % (percent). isoCode: nullable: true type: string description: Currency code according to ISO 4217. name: nullable: true type: string format: localizedString description: Name of the value unit. market: nullable: false type: object x-property-sort: - id - name description: Market of the notation. 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. instrument: nullable: false type: object x-property-sort: - id description: Instrument data for the notation. properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the instrument. description: Set of basic data for the notation. nullable: false x-property-sort: - idNotation - sourceIdentifier - symbol - factSetMarketSymbol - valueUnit - market - 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 GetNotationList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: Set of basic data for a list of notations. nullable: false items: type: object nullable: false x-property-sort: - idNotation - sourceIdentifier - symbol - factSetMarketSymbol - valueUnit - market - instrument - status properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. 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. factSetMarketSymbol: nullable: true type: string description: >- The FactSet market symbol of the notation (i.e. TICKER_EXCHANGE). valueUnit: nullable: false type: object x-property-sort: - id - code - isoCode - name description: >- The identifier of the unit in which prices of the notation are expressed. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the value unit. code: nullable: true type: string description: >- Currency code according to ISO 4217, a code such as GBp (for British pence), USc (for U.S. cents), EUc for (Euro cent), or a code for an alternative unit such as PT (points), % (percent). isoCode: nullable: true type: string description: Currency code according to ISO 4217. name: nullable: true type: string format: localizedString description: Name of the value unit. market: nullable: false type: object x-property-sort: - id - name description: Market of the notation. 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. instrument: nullable: false type: object x-property-sort: - id description: Instrument data for the notation. properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the instrument. status: nullable: false type: object x-property-sort: - code - identifier - details - encryptedDetails description: Error status for the requested identifier properties: code: nullable: true type: string description: Code of the error condition. x-enum-description: - No error. - >- The provided identifier does not refer to a valid notation. - >- Not entitled to see data for the notation in the requested quality. enum: - none - parameter - entitlement identifier: nullable: true type: string format: id64 x-positive: true description: Provided identifier. details: nullable: true type: string description: >- A human-readable, unstructured explanation specific to this occurrence of the problem. encryptedDetails: nullable: true type: string description: Base64-encoded internal details about the error. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta PostNotationCategoryList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: >- List of datasets with their categories as assigned to the notation. nullable: false 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 dataset 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. 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 GetNotationCrossReferenceGetByFactSetMarketSymbol200Response: 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 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. instrument: nullable: false type: object x-property-sort: - id description: Instrument referenced by the notation. properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the instrument. description: Notation identified by the FactSet market symbol. nullable: false x-property-sort: - id - market - valueUnit - 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 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 PostNotationCrossReferenceListByISIN200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of notations. nullable: false 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`). 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 PostNotationCrossReferenceListBySymbol200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of notations. nullable: false items: type: object nullable: false x-property-sort: - id - active - market - valueUnit - fsym - instrument properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the notation. 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`). instrument: nullable: false type: object x-property-sort: - id - fsym description: Instrument referenced by the notation. 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). 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 GetNotationCrossReferenceFactSetIdentifierGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. instrument: nullable: false type: object x-property-sort: - id description: Instrument data. properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the instrument. 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: object x-property-sort: - isPrimary - permanentIdentifier - tickerRegion - listing 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. 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: object x-property-sort: - isPrimary - permanentIdentifier - tickerExchange 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. properties: 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: >- Instrument data with a list of regional-level data and assigned listing-level data. nullable: false x-property-sort: - idNotation - sourceIdentifier - instrument - 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 PostNotationCrossReferenceFactSetIdentifierListByFactSetIdentifier200Response: 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 description: Instrument data. 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. 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: - instrument - 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 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 GetNotationKeyFiguresYear10Get200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: >- Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: >- Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: >- EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: >- Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: >- Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. tradingVolume: nullable: true type: number format: real description: >- Sum of the trading volume of a notation in number of shares for the time-range between the date of the most recent end-of-day (EOD) closing price (inclusive) and the reference date (exclusive). volatility: nullable: true type: number format: real description: >- Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - tradingVolume - volatility description: EOD key figures. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresYear10List200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: EOD key figures for a list of notations. nullable: false items: type: object nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - tradingVolume - volatility - status properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: >- Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: >- Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: >- EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: >- Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: >- Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. tradingVolume: nullable: true type: number format: real description: >- Sum of the trading volume of a notation in number of shares for the time-range between the date of the most recent end-of-day (EOD) closing price (inclusive) and the reference date (exclusive). volatility: nullable: true type: number format: real description: >- Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. status: nullable: false type: object x-property-sort: - code - identifier - details - encryptedDetails description: Error status for the requested identifier. properties: code: nullable: true type: string description: Code of the error condition. x-enum-description: - No error. - >- The provided identifier does not refer to a valid notation. - Not entitled to see data for the notation. - Unable to resolve the provided identifier. enum: - none - parameter - entitlement - identifierMapping identifier: nullable: true type: string format: id64 x-positive: true description: Provided identifier. details: nullable: true type: string description: >- A human-readable, unstructured explanation specific to this occurrence of the problem. encryptedDetails: nullable: true type: string description: Base64-encoded internal details about the error. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresMonth1Get200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: >- Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: >- Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: >- EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: >- Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: >- Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. averagePrice: nullable: true type: number format: real description: >- Arithmetic mean of the notation's EOD closing prices for the given time range. tradingVolume: nullable: false type: object x-property-sort: - average - sum description: Average and total trading volume for the given time range. properties: average: nullable: true type: number format: real description: Arithmetic mean of the daily trading volumes. sum: nullable: true type: number format: real description: Sum of the daily trading volumes. tradingValue: nullable: true type: number format: real description: >- Sum of the cash flow for all transactions of one notation over a certain time range. The cash flow of a transaction is its volume multiplied by its trade price. volatility: nullable: true type: number format: real description: >- Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - averagePrice - tradingVolume - tradingValue - volatility description: EOD key figures. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresMonth1List200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: EOD key figures for a list of notations. nullable: false items: type: object nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - averagePrice - tradingVolume - tradingValue - volatility - status properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: >- Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: >- Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: >- EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: >- Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: >- Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. averagePrice: nullable: true type: number format: real description: >- Arithmetic mean of the notation's EOD closing prices for the given time range. tradingVolume: nullable: false type: object x-property-sort: - average - sum description: >- Average and total trading volume for the given time range. properties: average: nullable: true type: number format: real description: Arithmetic mean of the daily trading volumes. sum: nullable: true type: number format: real description: Sum of the daily trading volumes. tradingValue: nullable: true type: number format: real description: >- Sum of the cash flow for all transactions of one notation over a certain time range. The cash flow of a transaction is its volume multiplied by its trade price. volatility: nullable: true type: number format: real description: >- Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. status: nullable: false type: object x-property-sort: - code - identifier - details - encryptedDetails description: Error status for the requested identifier. properties: code: nullable: true type: string description: Code of the error condition. x-enum-description: - No error. - >- The provided identifier does not refer to a valid notation. - Not entitled to see data for the notation. - Unable to resolve the provided identifier. enum: - none - parameter - entitlement - identifierMapping identifier: nullable: true type: string format: id64 x-positive: true description: Provided identifier. details: nullable: true type: string description: >- A human-readable, unstructured explanation specific to this occurrence of the problem. encryptedDetails: nullable: true type: string description: Base64-encoded internal details about the error. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresWeek1Get200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: >- Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: >- Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: >- EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: >- Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: >- Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. averagePrice: nullable: true type: number format: real description: >- Arithmetic mean of the notation's EOD closing prices for the given time range. tradingVolume: nullable: false type: object x-property-sort: - average - sum description: Average and total trading volume for the given time range. properties: average: nullable: true type: number format: real description: Arithmetic mean of the daily trading volumes. sum: nullable: true type: number format: real description: Sum of the daily trading volumes. tradingValue: nullable: true type: number format: real description: >- Sum of the cash flow for all transactions of one notation over a certain time range. The cash flow of a transaction is its volume multiplied by its trade price. volatility: nullable: true type: number format: real description: >- Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - averagePrice - tradingVolume - tradingValue - volatility description: EOD key figures. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresWeek1List200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: EOD key figures for a list of notations. nullable: false items: type: object nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - averagePrice - tradingVolume - tradingValue - volatility - status properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: >- Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: >- Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: >- EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: >- Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: >- Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. averagePrice: nullable: true type: number format: real description: >- Arithmetic mean of the notation's EOD closing prices for the given time range. tradingVolume: nullable: false type: object x-property-sort: - average - sum description: >- Average and total trading volume for the given time range. properties: average: nullable: true type: number format: real description: Arithmetic mean of the daily trading volumes. sum: nullable: true type: number format: real description: Sum of the daily trading volumes. tradingValue: nullable: true type: number format: real description: >- Sum of the cash flow for all transactions of one notation over a certain time range. The cash flow of a transaction is its volume multiplied by its trade price. volatility: nullable: true type: number format: real description: >- Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. status: nullable: false type: object x-property-sort: - code - identifier - details - encryptedDetails description: Error status for the requested identifier. properties: code: nullable: true type: string description: Code of the error condition. x-enum-description: - No error. - >- The provided identifier does not refer to a valid notation. - Not entitled to see data for the notation. - Unable to resolve the provided identifier. enum: - none - parameter - entitlement - identifierMapping identifier: nullable: true type: string format: id64 x-positive: true description: Provided identifier. details: nullable: true type: string description: >- A human-readable, unstructured explanation specific to this occurrence of the problem. encryptedDetails: nullable: true type: string description: Base64-encoded internal details about the error. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresYear1Get200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: >- Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: >- Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: >- EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: >- Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: >- Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. averagePrice: nullable: true type: number format: real description: >- Arithmetic mean of the notation's EOD closing prices for the given time range. tradingVolume: nullable: false type: object x-property-sort: - average - sum description: Average and total trading volume for the given time range. properties: average: nullable: true type: number format: real description: Arithmetic mean of the daily trading volumes. sum: nullable: true type: number format: real description: Sum of the daily trading volumes. tradingValue: nullable: true type: number format: real description: >- Sum of the cash flow for all transactions of one notation over a certain time range. The cash flow of a transaction is its volume multiplied by its trade price. volatility: nullable: true type: number format: real description: >- Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - averagePrice - tradingVolume - tradingValue - volatility description: EOD key figures. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresYear1List200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: EOD key figures for a list of notations. nullable: false items: type: object nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - averagePrice - tradingVolume - tradingValue - volatility - status properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: >- Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: >- Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: >- EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: >- Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: >- Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. averagePrice: nullable: true type: number format: real description: >- Arithmetic mean of the notation's EOD closing prices for the given time range. tradingVolume: nullable: false type: object x-property-sort: - average - sum description: >- Average and total trading volume for the given time range. properties: average: nullable: true type: number format: real description: Arithmetic mean of the daily trading volumes. sum: nullable: true type: number format: real description: Sum of the daily trading volumes. tradingValue: nullable: true type: number format: real description: >- Sum of the cash flow for all transactions of one notation over a certain time range. The cash flow of a transaction is its volume multiplied by its trade price. volatility: nullable: true type: number format: real description: >- Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. status: nullable: false type: object x-property-sort: - code - identifier - details - encryptedDetails description: Error status for the requested identifier. properties: code: nullable: true type: string description: Code of the error condition. x-enum-description: - No error. - >- The provided identifier does not refer to a valid notation. - Not entitled to see data for the notation. - Unable to resolve the provided identifier. enum: - none - parameter - entitlement - identifierMapping identifier: nullable: true type: string format: id64 x-positive: true description: Provided identifier. details: nullable: true type: string description: >- A human-readable, unstructured explanation specific to this occurrence of the problem. encryptedDetails: nullable: true type: string description: Base64-encoded internal details about the error. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresMonth3Get200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: >- Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: >- Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: >- EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: >- Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: >- Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. tradingVolume: nullable: true type: number format: real description: >- Sum of the trading volume of a notation in number of shares for the time-range between the date of the most recent end-of-day (EOD) closing price (inclusive) and the reference date (exclusive). volatility: nullable: true type: number format: real description: >- Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - tradingVolume - volatility description: EOD key figures. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresMonth3List200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: EOD key figures for a list of notations. nullable: false items: type: object nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - tradingVolume - volatility - status properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: >- Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: >- Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: >- EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: >- Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: >- Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. tradingVolume: nullable: true type: number format: real description: >- Sum of the trading volume of a notation in number of shares for the time-range between the date of the most recent end-of-day (EOD) closing price (inclusive) and the reference date (exclusive). volatility: nullable: true type: number format: real description: >- Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. status: nullable: false type: object x-property-sort: - code - identifier - details - encryptedDetails description: Error status for the requested identifier. properties: code: nullable: true type: string description: Code of the error condition. x-enum-description: - No error. - >- The provided identifier does not refer to a valid notation. - Not entitled to see data for the notation. - Unable to resolve the provided identifier. enum: - none - parameter - entitlement - identifierMapping identifier: nullable: true type: string format: id64 x-positive: true description: Provided identifier. details: nullable: true type: string description: >- A human-readable, unstructured explanation specific to this occurrence of the problem. encryptedDetails: nullable: true type: string description: Base64-encoded internal details about the error. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresYear3Get200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: >- Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: >- Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: >- EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: >- Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: >- Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. tradingVolume: nullable: true type: number format: real description: >- Sum of the trading volume of a notation in number of shares for the time-range between the date of the most recent end-of-day (EOD) closing price (inclusive) and the reference date (exclusive). volatility: nullable: true type: number format: real description: >- Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - tradingVolume - volatility description: EOD key figures. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresYear3List200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: EOD key figures for a list of notations. nullable: false items: type: object nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - tradingVolume - volatility - status properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: >- Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: >- Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: >- EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: >- Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: >- Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. tradingVolume: nullable: true type: number format: real description: >- Sum of the trading volume of a notation in number of shares for the time-range between the date of the most recent end-of-day (EOD) closing price (inclusive) and the reference date (exclusive). volatility: nullable: true type: number format: real description: >- Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. status: nullable: false type: object x-property-sort: - code - identifier - details - encryptedDetails description: Error status for the requested identifier. properties: code: nullable: true type: string description: Code of the error condition. x-enum-description: - No error. - >- The provided identifier does not refer to a valid notation. - Not entitled to see data for the notation. - Unable to resolve the provided identifier. enum: - none - parameter - entitlement - identifierMapping identifier: nullable: true type: string format: id64 x-positive: true description: Provided identifier. details: nullable: true type: string description: >- A human-readable, unstructured explanation specific to this occurrence of the problem. encryptedDetails: nullable: true type: string description: Base64-encoded internal details about the error. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresYear5Get200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: >- Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: >- Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: >- EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: >- Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: >- Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. tradingVolume: nullable: true type: number format: real description: >- Sum of the trading volume of a notation in number of shares for the time-range between the date of the most recent end-of-day (EOD) closing price (inclusive) and the reference date (exclusive). volatility: nullable: true type: number format: real description: >- Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - tradingVolume - volatility description: EOD key figures. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresYear5List200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: EOD key figures for a list of notations. nullable: false items: type: object nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - tradingVolume - volatility - status properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: >- Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: >- Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: >- EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: >- Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: >- Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. tradingVolume: nullable: true type: number format: real description: >- Sum of the trading volume of a notation in number of shares for the time-range between the date of the most recent end-of-day (EOD) closing price (inclusive) and the reference date (exclusive). volatility: nullable: true type: number format: real description: >- Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. status: nullable: false type: object x-property-sort: - code - identifier - details - encryptedDetails description: Error status for the requested identifier. properties: code: nullable: true type: string description: Code of the error condition. x-enum-description: - No error. - >- The provided identifier does not refer to a valid notation. - Not entitled to see data for the notation. - Unable to resolve the provided identifier. enum: - none - parameter - entitlement - identifierMapping identifier: nullable: true type: string format: id64 x-positive: true description: Provided identifier. details: nullable: true type: string description: >- A human-readable, unstructured explanation specific to this occurrence of the problem. encryptedDetails: nullable: true type: string description: Base64-encoded internal details about the error. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresMonth6Get200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: >- Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: >- Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: >- EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: >- Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: >- Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. tradingVolume: nullable: true type: number format: real description: >- Sum of the trading volume of a notation in number of shares for the time-range between the date of the most recent end-of-day (EOD) closing price (inclusive) and the reference date (exclusive). volatility: nullable: true type: number format: real description: >- Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - tradingVolume - volatility description: EOD key figures. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresMonth6List200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: EOD key figures for a list of notations. nullable: false items: type: object nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - tradingVolume - volatility - status properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: >- Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: >- Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: >- EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: >- Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: >- Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. tradingVolume: nullable: true type: number format: real description: >- Sum of the trading volume of a notation in number of shares for the time-range between the date of the most recent end-of-day (EOD) closing price (inclusive) and the reference date (exclusive). volatility: nullable: true type: number format: real description: >- Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. status: nullable: false type: object x-property-sort: - code - identifier - details - encryptedDetails description: Error status for the requested identifier. properties: code: nullable: true type: string description: Code of the error condition. x-enum-description: - No error. - >- The provided identifier does not refer to a valid notation. - Not entitled to see data for the notation. - Unable to resolve the provided identifier. enum: - none - parameter - entitlement - identifierMapping identifier: nullable: true type: string format: id64 x-positive: true description: Provided identifier. details: nullable: true type: string description: >- A human-readable, unstructured explanation specific to this occurrence of the problem. encryptedDetails: nullable: true type: string description: Base64-encoded internal details about the error. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresYear7Get200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: >- Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: >- Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: >- EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: >- Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: >- Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. tradingVolume: nullable: true type: number format: real description: >- Sum of the trading volume of a notation in number of shares for the time-range between the date of the most recent end-of-day (EOD) closing price (inclusive) and the reference date (exclusive). volatility: nullable: true type: number format: real description: >- Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - tradingVolume - volatility description: EOD key figures. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresYear7List200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: EOD key figures for a list of notations. nullable: false items: type: object nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - tradingVolume - volatility - status properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: >- Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: >- Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: >- EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: >- Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: >- Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. tradingVolume: nullable: true type: number format: real description: >- Sum of the trading volume of a notation in number of shares for the time-range between the date of the most recent end-of-day (EOD) closing price (inclusive) and the reference date (exclusive). volatility: nullable: true type: number format: real description: >- Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. status: nullable: false type: object x-property-sort: - code - identifier - details - encryptedDetails description: Error status for the requested identifier. properties: code: nullable: true type: string description: Code of the error condition. x-enum-description: - No error. - >- The provided identifier does not refer to a valid notation. - Not entitled to see data for the notation. - Unable to resolve the provided identifier. enum: - none - parameter - entitlement - identifierMapping identifier: nullable: true type: string format: id64 x-positive: true description: Provided identifier. details: nullable: true type: string description: >- A human-readable, unstructured explanation specific to this occurrence of the problem. encryptedDetails: nullable: true type: string description: Base64-encoded internal details about the error. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresYearToDateGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: >- Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: >- Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: >- EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: >- Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: >- Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. volatility: nullable: true type: number format: real description: >- Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - volatility description: EOD key figures. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresYearToDateList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: EOD key figures for a list of notations. nullable: false items: type: object nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - volatility - status properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: >- Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: >- Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: >- EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: >- Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: >- Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. volatility: nullable: true type: number format: real description: >- Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. status: nullable: false type: object x-property-sort: - code - identifier - details - encryptedDetails description: Error status for the requested identifier. properties: code: nullable: true type: string description: Code of the error condition. x-enum-description: - No error. - >- The provided identifier does not refer to a valid notation. - Not entitled to see data for the notation. - Unable to resolve the provided identifier. enum: - none - parameter - entitlement - identifierMapping identifier: nullable: true type: string format: id64 x-positive: true description: Provided identifier. details: nullable: true type: string description: >- A human-readable, unstructured explanation specific to this occurrence of the problem. encryptedDetails: nullable: true type: string description: Base64-encoded internal details about the error. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresTradingDayAverageGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. price: nullable: false type: object x-property-sort: - days5 - days20 - days30 - days38 - days50 - days100 - days200 - days250 description: >- Average price. See attribute `valueUnit` in endpoint `/notation/get` for its unit. properties: days5: nullable: true type: number format: real description: Five trading days. days20: nullable: true type: number format: real description: 20 trading days. days30: nullable: true type: number format: real description: 30 trading days. days38: nullable: true type: number format: real description: 38 trading days. days50: nullable: true type: number format: real description: 50 trading days. days100: nullable: true type: number format: real description: 100 trading days. days200: nullable: true type: number format: real description: 200 trading days. days250: nullable: true type: number format: real description: 250 trading days. volume: nullable: false type: object x-property-sort: - days5 - days30 - days50 - days100 - days200 - days250 description: Average trading volume. properties: days5: nullable: true type: number format: real description: Five trading days. days30: nullable: true type: number format: real description: 30 trading days. days50: nullable: true type: number format: real description: 50 trading days. days100: nullable: true type: number format: real description: 100 trading days. days200: nullable: true type: number format: real description: 200 trading days. days250: nullable: true type: number format: real description: 250 trading days. value: nullable: false type: object x-property-sort: - days5 - days30 - days100 - days250 description: >- Average trading value. See attribute `valueUnit` in endpoint `/notation/get` for its unit. properties: days5: nullable: true type: number format: real description: Five trading days. days30: nullable: true type: number format: real description: 30 trading days. days100: nullable: true type: number format: real description: 100 trading days. days250: nullable: true type: number format: real description: 250 trading days. description: Average end-of-day (EOD) key figures for various time ranges. nullable: false x-property-sort: - idNotation - sourceIdentifier - price - volume - value meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta PostNotationMarketList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of entitled markets. nullable: false items: type: object nullable: false x-property-sort: - id - name - shortName - country - type - group - timezone - count properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of a market. name: nullable: true x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 1 type: string format: localizedString description: Name of the market. shortName: nullable: true type: string format: localizedString description: Short name of the market. country: nullable: false type: object x-property-sort: - id - name description: >- Country of the market. See endpoint `/basic/region/country/list` for possible values. 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. type: nullable: false type: object x-property-sort: - id - name description: >- Type of the market. See endpoint `/basic/market/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. group: nullable: false type: object x-property-sort: - id - name description: >- Market group of the market. See endpoint `/basic/market/list` for possible values. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the market group. name: nullable: true type: string format: localizedString description: Name of the market group. timezone: nullable: false type: object x-property-sort: - id - name description: >- Timezone of the market. See endpoint `/basic/timezone/list` for possible values. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the timezone. name: nullable: true type: string description: Name of the timezone. count: nullable: true x-sortable: true type: number format: int32 description: Number of entitled notations. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' pagination: $ref: >- #/components/schemas/OffsetBasedPaginationOutputObjectWithoutTotal x-property-sort: - status - pagination x-property-sort: - data - meta GetNotationSelectionListList200Response: 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 GetNotationSelectionListListByNotation200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: Set of notation-level selection lists for each given notation. nullable: false items: type: object nullable: false x-property-sort: - idNotation - sourceIdentifier - selectionList - status properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. 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 listing 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 PostNotationSelectionListMembersList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of notations. nullable: false items: type: object nullable: false x-property-sort: - id - market - valueUnit - symbol - nsin - fsym - instrument properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of a notation. market: nullable: false description: >- Market of the notation. See endpoint `/basic/market/list` for possible values. type: object x-property-sort: - id - name properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the market. name: nullable: true x-sortable: true description: Name of the market. type: string format: localizedString 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 - name properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the value unit. name: nullable: true x-sortable: true type: string format: localizedString 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. 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. type: string nsin: nullable: false type: object x-property-sort: - sedol description: NSIN data of the instrument. properties: sedol: nullable: true type: string description: The SEDOL or IDII for the notation. fsym: nullable: false description: >- Notation-level FactSet identifiers of the financial instrument used primarily in FactSet products other than the MDG. type: object x-property-sort: - listing - regional properties: listing: nullable: false description: Listing-level identifiers. type: object x-property-sort: - permanentIdentifier - tickerExchange - isPrimary 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 description: Regional-level identifiers. type: object x-property-sort: - permanentIdentifier - tickerExchange - isPrimary 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). tickerExchange: 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 - isin - nsin - fsym - assetClass - instrumentCategory properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the 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 aninteger 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 instrumentCategory: 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 GetNotationStatusGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. suspended: nullable: true type: boolean description: >- Indicates whether the notation is currently suspended from trading. The notation is tradable if it is not suspended and the market is open, see attribute `market.isOpen`. tradingStatus: nullable: true type: string description: >- Market-specific code of the trading status and/or the suspension of the notation. priceDelay: nullable: true type: number format: int32 description: >- Exchange-imposed delay in seconds for delayed-quality tick data. tickSize: nullable: true type: number format: real description: >- The minimum price movement of the notation. Prices can only be integral multiples of this minimum value. See endpoint `/notation/get` for the value unit of the `tickSize` for this notation. lotSize: nullable: true type: number format: real description: >- The minimum tradable volume of the notation. The number of units traded can only be integral multiples of this minimum value. tradeImbalance: nullable: true x-pushable: true type: number format: real description: >- Trade imbalance after the previous closed auction. A positive value indicates that more buy orders have been placed for the security; a negative value indicates more sell orders. market: nullable: false type: object x-property-sort: - id - isOpen - phase description: Market of the notation. properties: id: nullable: true type: number format: id32 x-positive: true description: >- Identifier of the market. See endpoint `/basic/market/list` for possible values. isOpen: nullable: true type: boolean description: >- Indicates whether the market of the notation is currently open, that is, the current time is between the open and adjusted close of the notation's market, see endpoint `/prices/tradingSchedule/event/list` for the trading schedule of the notation's market. The adjusted close is later than the official closing time specified by the market and includes the time after closing when trades might still be reported. Breaks such as a lunch break are not considered. phase: nullable: true type: string description: Market-specific code of the current market phase. regional: nullable: false type: object x-property-sort: - us description: Region-specific trading indicators. properties: us: nullable: false type: object x-property-sort: - caveatEmptor - proprietaryQuoteEligible description: Trading indicators specific to the United States. properties: caveatEmptor: nullable: true x-pushable: true type: boolean description: >- Indicates whether a Caveat Emptor (Buyer Beware) warning has been applied to the security. proprietaryQuoteEligible: nullable: true x-pushable: true type: boolean description: >- Security is eligible for proprietary quoting under SEC Rule 15c-211. description: '' nullable: false x-property-sort: - idNotation - sourceIdentifier - suspended - tradingStatus - priceDelay - tickSize - lotSize - tradeImbalance - market - 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 GetPricesGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. valueUnit: nullable: false type: object x-property-sort: - id 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. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the valueUnit. currency: nullable: false type: object x-property-sort: - id description: >- Main currency of the monetary attributes. 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. market: nullable: false type: object x-property-sort: - id - isOpen - phase description: Market of the notation. properties: id: nullable: true type: number format: id32 x-positive: true description: >- Identifier of the market. See endpoint `/basic/market/list` for possible values. isOpen: nullable: true x-pushable: true type: boolean description: >- Indicates whether the market of the notation is currently open, that is, the current time is between the open and adjusted close of the notation's market, see endpoint `/prices/tradingSchedule/event/list` for the trading schedule of the notation's market. The adjusted close is later than the official closing time specified by the market and includes the time after closing when trades might still be reported. Breaks such as a lunch break are not considered. The value is `null` if the result quality is EOD. phase: nullable: true x-pushable: true type: string description: >- Market-specific code of the current market phase. The value is `null` if the result quality is EOD. quality: nullable: true type: string description: Quality of the price. x-enum-description: - >- Real-time: intraday prices with minimal technical processing delays. - >- 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: - RLT - DLY - EOD latest: nullable: false type: object x-property-sort: - time - price - quoteCondition - tradingVolume - tradingValue - performance description: Most recent trade or price of the trading day. properties: time: nullable: true x-pushable: true type: string format: datetime description: Date and time. x-cas-attribute: timeLatestTradePrice price: nullable: true x-pushable: true type: number format: real description: Price value. See attribute `valueUnit` for its unit. x-cas-attribute: valueLatestTradePrice quoteCondition: nullable: true x-pushable: true type: string description: >- Quote condition. Possible values depend on the values delivered by the supplier of the price information. x-cas-attribute: quoteConditionLatestTradePrice tradingVolume: nullable: true x-pushable: true type: number format: real description: Number of units (e.g. shares) traded. x-cas-attribute: tradingVolumeLatestTradePrice tradingValue: nullable: true x-pushable: true type: number format: real description: >- Monetary equivalent (cash value) of the trade. See attribute `currency` for its unit. x-cas-attribute: tradingValueLatestTradePrice performance: nullable: false type: object x-property-sort: - intraday description: Performance values. properties: intraday: nullable: false type: object x-property-sort: - absolute - relative description: >- Performance of the most recent price calculated against the latest price which has occurred before the start of the most recent trading day. properties: absolute: nullable: true x-pushable: true type: number format: real description: >- Absolute value. See attribute `valueUnit` for its unit. x-cas-attribute: absolutePerformanceLatestTradePrice relative: nullable: true x-pushable: true type: number format: relativeValue description: Relative value. x-cas-attribute: relativePerformanceLatestTradePrice first: nullable: false type: object x-property-sort: - time - price - tradingVolume description: First trade or price of the trading day. properties: time: nullable: true x-pushable: true type: string format: datetime description: Date and time. x-cas-attribute: timeFirstTradePrice price: nullable: true x-pushable: true type: number format: real description: Price value. See attribute `valueUnit` for its unit. x-cas-attribute: valueFirstTradePrice tradingVolume: nullable: true x-pushable: true type: number format: real description: Number of units (e.g. shares) traded. x-cas-attribute: tradingVolumeFirstTradePrice low: nullable: false type: object x-property-sort: - time - price - tradingVolume description: Trade with the lowest price of the trading day. properties: time: nullable: true x-pushable: true type: string format: datetime description: Date and time. x-cas-attribute: timeLowestTradePrice price: nullable: true x-pushable: true type: number format: real description: Price value. See attribute `valueUnit` for its unit. x-cas-attribute: valueLowestTradePrice tradingVolume: nullable: true x-pushable: true type: number format: real description: Number of units (e.g. shares) traded. x-cas-attribute: tradingVolumeLowestTradePrice high: nullable: false type: object x-property-sort: - time - price - tradingVolume description: Trade with the highest price of the trading day. properties: time: nullable: true x-pushable: true type: string format: datetime description: Date and time. x-cas-attribute: timeHighestTradePrice price: nullable: true x-pushable: true type: number format: real description: Price value. See attribute `valueUnit` for its unit. x-cas-attribute: valueHighestTradePrice tradingVolume: nullable: true x-pushable: true type: number format: real description: Number of units (e.g. shares) traded. x-cas-attribute: tradingVolumeHighestTradePrice previousClose: nullable: false type: object x-property-sort: - time - price description: Close price of the previous day. properties: time: nullable: true x-pushable: true type: string format: datetime description: Date and time. x-cas-attribute: timePreviousClosePrice price: nullable: true x-pushable: true type: number format: real description: Price value. See attribute `valueUnit` for its unit. x-cas-attribute: valuePreviousClosePrice accumulated: nullable: false type: object x-property-sort: - numberTrades - tradingVolume - tradingValue - volumeWeightedAveragePrice description: >- Summary data accumulated over all trades of the most recent trading day. properties: numberTrades: nullable: true x-pushable: true type: number format: real description: Number of trades. x-cas-attribute: accumulatedNumberTrades tradingVolume: nullable: true x-pushable: true type: number format: real description: Number of units (e.g. shares) traded. x-cas-attribute: accumulatedTradingVolume tradingValue: nullable: true x-pushable: true type: number format: real description: >- Monetary equivalent (cash value) of the trades. See attribute `currency` for its unit. x-cas-attribute: accumulatedTradingValue volumeWeightedAveragePrice: nullable: true x-pushable: true type: number format: real description: >- The volume-weighted average price (VWAP). See attribute `valueUnit` for its unit. x-cas-attribute: volumeWeightedAveragePrice description: Set of price related data for the notation. nullable: false x-property-sort: - idNotation - sourceIdentifier - valueUnit - currency - market - quality - latest - first - low - high - previousClose - accumulated 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 GetPricesList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: Set of price related data for a list of notations. nullable: false items: type: object nullable: false x-property-sort: - idNotation - sourceIdentifier - valueUnit - currency - market - quality - latest - first - low - high - previousClose - accumulated - status properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. valueUnit: nullable: false type: object x-property-sort: - id 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. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the valueUnit. currency: nullable: false type: object x-property-sort: - id description: >- Main currency of the monetary attributes. 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. market: nullable: false type: object x-property-sort: - id 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. quality: nullable: true type: string description: Quality of the price. x-enum-description: - >- Real-time: intraday prices with minimal technical processing delays. - >- 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: - RLT - DLY - EOD latest: nullable: false type: object x-property-sort: - time - price - quoteCondition - tradingVolume - tradingValue - performance description: Most recent trade or price of the trading day. properties: time: nullable: true type: string format: datetime description: Date and time. x-cas-attribute: timeLatestTradePrice price: nullable: true type: number format: real description: Price value. See attribute `valueUnit` for its unit. x-cas-attribute: valueLatestTradePrice quoteCondition: nullable: true type: string description: >- Quote condition. Possible values depend on the values delivered by the supplier of the price information. x-cas-attribute: quoteConditionLatestTradePrice tradingVolume: nullable: true type: number format: real description: Number of units (e.g. shares) traded. x-cas-attribute: tradingVolumeLatestTradePrice tradingValue: nullable: true type: number format: real description: >- Monetary equivalent (cash value) of the trade. See attribute `currency` for its unit. x-cas-attribute: tradingValueLatestTradePrice performance: nullable: false type: object x-property-sort: - intraday description: Performance values. properties: intraday: nullable: false type: object x-property-sort: - absolute - relative description: >- Performance of the most recent price calculated against the latest price which has occurred before the start of the most recent trading day. properties: absolute: nullable: true type: number format: real description: >- Absolute value. See attribute `valueUnit` for its unit. x-cas-attribute: absolutePerformanceLatestTradePrice relative: nullable: true type: number format: relativeValue description: Relative value. x-cas-attribute: relativePerformanceLatestTradePrice first: nullable: false type: object x-property-sort: - time - price - tradingVolume description: First trade or price of the trading day. properties: time: nullable: true type: string format: datetime description: Date and time. x-cas-attribute: timeFirstTradePrice price: nullable: true type: number format: real description: Price value. See attribute `valueUnit` for its unit. x-cas-attribute: valueFirstTradePrice tradingVolume: nullable: true type: number format: real description: Number of units (e.g. shares) traded. x-cas-attribute: tradingVolumeFirstTradePrice low: nullable: false type: object x-property-sort: - time - price - tradingVolume description: Trade with the lowest price of the trading day. properties: time: nullable: true type: string format: datetime description: Date and time. x-cas-attribute: timeLowestTradePrice price: nullable: true type: number format: real description: Price value. See attribute `valueUnit` for its unit. x-cas-attribute: valueLowestTradePrice tradingVolume: nullable: true type: number format: real description: Number of units (e.g. shares) traded. x-cas-attribute: tradingVolumeLowestTradePrice high: nullable: false type: object x-property-sort: - time - price - tradingVolume description: Trade with the highest price of the trading day. properties: time: nullable: true type: string format: datetime description: Date and time. x-cas-attribute: timeHighestTradePrice price: nullable: true type: number format: real description: Price value. See attribute `valueUnit` for its unit. x-cas-attribute: valueHighestTradePrice tradingVolume: nullable: true type: number format: real description: Number of units (e.g. shares) traded. x-cas-attribute: tradingVolumeHighestTradePrice previousClose: nullable: false type: object x-property-sort: - time - price description: Close price of the previous day. properties: time: nullable: true type: string format: datetime description: Date and time. x-cas-attribute: timePreviousClosePrice price: nullable: true type: number format: real description: Price value. See attribute `valueUnit` for its unit. x-cas-attribute: valuePreviousClosePrice accumulated: nullable: false type: object x-property-sort: - numberTrades - tradingVolume - tradingValue - volumeWeightedAveragePrice description: >- Summary data accumulated over all trades of the most recent trading day. properties: numberTrades: nullable: true type: number format: real description: Number of trades. x-cas-attribute: accumulatedNumberTrades tradingVolume: nullable: true type: number format: real description: Number of units (e.g. shares) traded. x-cas-attribute: accumulatedTradingVolume tradingValue: nullable: true type: number format: real description: >- Monetary equivalent (cash value) of the trades. See attribute `currency` for its unit. x-cas-attribute: accumulatedTradingValue volumeWeightedAveragePrice: nullable: true type: number format: real description: >- The volume-weighted average price (VWAP). See attribute `valueUnit` for its unit. x-cas-attribute: volumeWeightedAveragePrice 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 listing 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 GetPricesBidAskGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. valueUnit: nullable: false type: object x-property-sort: - id 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. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the valueUnit. currency: nullable: false type: object x-property-sort: - id description: >- Main currency of the monetary attributes. 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. market: nullable: false type: object x-property-sort: - id 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. quality: nullable: true type: string description: Quality of the price. x-enum-description: - >- Real-time: intraday prices with minimal technical processing delays. - >- 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: - RLT - DLY - EOD bid: nullable: false type: object x-property-sort: - time - price - quoteCondition - tradingVolume - tradingValue description: Most recent bid price of the trading day. properties: time: nullable: true x-pushable: true type: string format: datetime description: Date and time. x-cas-attribute: timeLatestBidPrice price: nullable: true x-pushable: true type: number format: real description: Price value. See attribute `valueUnit` for its unit. x-cas-attribute: valueLatestBidPrice quoteCondition: nullable: true x-pushable: true type: string description: >- Quote condition. Possible values depend on the values delivered by the supplier of the price information. x-cas-attribute: quoteConditionLatestBidPrice tradingVolume: nullable: true x-pushable: true type: number format: real description: Number of units (e.g. shares) solicited. x-cas-attribute: tradingVolumeLatestBidPrice tradingValue: nullable: true x-pushable: true type: number format: real description: >- Monetary equivalent (cash value) of the offer. See attribute `currency` for its unit. x-cas-attribute: tradingValueLatestBidPrice ask: nullable: false type: object x-property-sort: - time - price - quoteCondition - tradingVolume - tradingValue description: Most recent ask price of the trading day. properties: time: nullable: true x-pushable: true type: string format: datetime description: Date and time. x-cas-attribute: timeLatestAskPrice price: nullable: true x-pushable: true type: number format: real description: Price value. See attribute `valueUnit` for its unit. x-cas-attribute: valueLatestAskPrice quoteCondition: nullable: true x-pushable: true type: string description: >- Quote condition. Possible values depend on the values delivered by the supplier of the price information. x-cas-attribute: quoteConditionLatestAskPrice tradingVolume: nullable: true x-pushable: true type: number format: real description: Number of units (e.g. shares) offered. x-cas-attribute: tradingVolumeLatestAskPrice tradingValue: nullable: true x-pushable: true type: number format: real description: >- Monetary equivalent (cash value) of the offer. See attribute `currency` for its unit. x-cas-attribute: tradingValueLatestAskPrice description: Bid and ask prices for the notation. nullable: false x-property-sort: - idNotation - sourceIdentifier - valueUnit - currency - market - quality - bid - ask 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 GetPricesBidAskList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: Set of bid and ask prices for a list of notations. nullable: false items: type: object nullable: false x-property-sort: - idNotation - sourceIdentifier - valueUnit - currency - market - quality - bid - ask - status properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. valueUnit: nullable: false type: object x-property-sort: - id 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. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the valueUnit. currency: nullable: false type: object x-property-sort: - id description: >- Main currency of the monetary attributes. 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. market: nullable: false type: object x-property-sort: - id 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. quality: nullable: true type: string description: Quality of the price. x-enum-description: - >- Real-time: intraday prices with minimal technical processing delays. - >- 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: - RLT - DLY - EOD bid: nullable: false type: object x-property-sort: - time - price - quoteCondition - tradingVolume - tradingValue description: Most recent bid price of the trading day. properties: time: nullable: true type: string format: datetime description: Date and time. x-cas-attribute: timeLatestBidPrice price: nullable: true type: number format: real description: Price value. See attribute `valueUnit` for its unit. x-cas-attribute: valueLatestBidPrice quoteCondition: nullable: true type: string description: >- Quote condition. Possible values depend on the values delivered by the supplier of the price information. x-cas-attribute: quoteConditionLatestBidPrice tradingVolume: nullable: true type: number format: real description: Number of units (e.g. shares) solicited. x-cas-attribute: tradingVolumeLatestBidPrice tradingValue: nullable: true type: number format: real description: >- Monetary equivalent (cash value) of the offer. See attribute `currency` for its unit. x-cas-attribute: tradingValueLatestBidPrice ask: nullable: false type: object x-property-sort: - time - price - quoteCondition - tradingVolume - tradingValue description: Most recent ask price of the trading day. properties: time: nullable: true type: string format: datetime description: Date and time. x-cas-attribute: timeLatestAskPrice price: nullable: true type: number format: real description: Price value. See attribute `valueUnit` for its unit. x-cas-attribute: valueLatestAskPrice quoteCondition: nullable: true type: string description: >- Quote condition. Possible values depend on the values delivered by the supplier of the price information. x-cas-attribute: quoteConditionLatestAskPrice tradingVolume: nullable: true type: number format: real description: Number of units (e.g. shares) offered. x-cas-attribute: tradingVolumeLatestAskPrice tradingValue: nullable: true type: number format: real description: >- Monetary equivalent (cash value) of the offer. See attribute `currency` for its unit. x-cas-attribute: tradingValueLatestAskPrice 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 listing 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 GetPricesOrderbookAggregatedGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. quality: nullable: true type: string description: Quality of the price. x-enum-description: - >- Real-time: intraday prices with minimal technical processing delays. - >- Delayed: intraday prices with an exchange-imposed delay of usually 15 to 30 minutes. enum: - RLT - DLY asks: nullable: false description: List of sell orders aggregated by price. type: array items: type: object nullable: false x-property-sort: - type - price - numberOrders - volume - time properties: type: nullable: true description: Order type. x-pushable: true type: number format: int32 x-enum-description: - The order has a fixed price. - >- The order has no price and should be traded to market price. - >- The order represents a quote, which cannot execute against other orders. enum: - 0 - 1 - 2 price: nullable: true description: >- Price value. The value is 0 if the attribute `type` is 1 (market order). See attribute `valueUnit` in endpoint `/prices/get` for the unit of the price value". x-pushable: true type: number format: real numberOrders: nullable: true description: Number of orders for the price level. x-pushable: true type: number format: int32 volume: nullable: true description: Summarized volume for the price level. x-pushable: true type: number format: int32 time: nullable: true description: Date and time of the latest change. x-pushable: true type: string format: datetime bids: nullable: false description: List of buy orders aggregated by price. type: array items: type: object nullable: false x-property-sort: - type - price - numberOrders - volume - time properties: type: nullable: true description: Order type. x-pushable: true type: number format: int32 x-enum-description: - The order has a fixed price. - >- The order has no price and should be traded to market price. - >- The order represents a quote, which cannot execute against other orders. enum: - 0 - 1 - 2 price: nullable: true description: >- Price value. The value is 0 if the attribute `type` is 1 (market order). See attribute `valueUnit` in endpoint `/prices/get` for the unit of the price value". x-pushable: true type: number format: real numberOrders: nullable: true description: Number of orders for the price level. x-pushable: true type: number format: int32 volume: nullable: true description: Summarized volume for the price level. x-pushable: true type: number format: int32 time: nullable: true description: Date and time of the latest change. x-pushable: true type: string format: datetime description: Orderbook. nullable: false x-property-sort: - idNotation - sourceIdentifier - quality - asks - bids 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 GetPricesOrderbookFullGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. quality: nullable: true type: string description: Quality of the price. x-enum-description: - >- Real-time: intraday prices with minimal technical processing delays. - >- Delayed: intraday prices with an exchange-imposed delay of usually 15 to 30 minutes. enum: - RLT - DLY asks: nullable: false description: Ask entries of the full orderbook. type: array items: type: object nullable: false x-property-sort: - id - time - type - price - quoteCondition - volume - marketMaker properties: id: nullable: true description: >- Unique identifier of the order. Possible values depend on the values delivered by the supplier of the price information. x-pushable: true type: string format: id64 x-positive: true time: nullable: true description: Date and time of the latest change. x-pushable: true type: string format: datetime type: nullable: true description: Order type. x-pushable: true type: number format: int32 x-enum-description: - The order has a fixed price. - >- The order has no price and should be traded at market price. - >- The order represents a quote, which cannot execute against other orders. enum: - 0 - 1 - 2 price: nullable: true description: >- Price value. The value is 0 if the attribute `type` is 1 (market order). See attribute `valueUnit` in endpoint `/prices/get` for the unit of the price value". x-pushable: true type: number format: real quoteCondition: nullable: true description: >- Quote condition. Possible values depend on the values delivered by the supplier of the price information. x-pushable: true type: string volume: nullable: true description: Volume of the order. x-pushable: true type: number format: int32 marketMaker: nullable: true description: Code of the market maker. x-pushable: true type: string bids: nullable: false description: Bid entries of the full orderbook. type: array items: type: object nullable: false x-property-sort: - id - time - type - price - quoteCondition - volume - marketMaker properties: id: nullable: true description: >- Unique identifier of the order. Possible values depend on the values delivered by the supplier of the price information. x-pushable: true type: string format: id64 x-positive: true time: nullable: true description: Date and time of the latest change. x-pushable: true type: string format: datetime type: nullable: true description: Order type. x-pushable: true type: number format: int32 x-enum-description: - The order has a fixed price. - >- The order has no price and should be traded at market price. - >- The order represents a quote, which cannot execute against other orders. enum: - 0 - 1 - 2 price: nullable: true description: >- Price value. The value is 0 if the attribute `type` is 1 (market order). See attribute `valueUnit` in endpoint `/prices/get` for the unit of the price value". x-pushable: true type: number format: real quoteCondition: nullable: true description: >- Quote condition. Possible values depend on the values delivered by the supplier of the price information. x-pushable: true type: string volume: nullable: true description: Volume of the order. x-pushable: true type: number format: int32 marketMaker: nullable: true description: Code of the market maker. x-pushable: true type: string description: Orderbook. nullable: false x-property-sort: - idNotation - sourceIdentifier - quality - asks - bids 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 PostPricesTradingScheduleEventList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. range: 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). x-property-sort: - start - end required: - start - end description: Time range for the returned trading schedule events. events: nullable: false type: array items: type: object nullable: false x-property-sort: - time - type properties: time: nullable: true type: string format: datetime description: Date and time of the event. type: nullable: false type: object x-property-sort: - id - code description: Trading schedule event type. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the event type. code: nullable: true type: string description: Code of the event type. description: List of trading schedule events. description: List of trading schedule events for a notation. nullable: false x-property-sort: - idNotation - sourceIdentifier - range - events 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 GetPricesTradingScheduleEventTypeList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of trading schedule event types. nullable: false items: type: object nullable: false x-property-sort: - id - code - description properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the type. code: nullable: true type: string description: Code of the type. description: nullable: true type: string description: Description of the type in english language. 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 GetNotationSearchBasic200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of notations. nullable: false items: type: object nullable: false x-property-sort: - id - symbol - nsin - price - instrument description: The data member contains a list of the matching notations. 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 instruments, no symbol will be set for the notations of that market. nsin: nullable: false type: object x-property-sort: - sedol description: NSIN data of the notation. properties: sedol: nullable: true type: string description: The SEDOL or IDII for the notation. price: nullable: false type: object x-property-sort: - value - time description: >- Most recent trade or price of the trading day. See attribute `valueUnit` for its unit. properties: value: nullable: true type: number format: real description: Value of the latest price. time: nullable: true type: string format: datetime description: >- Date and time of the most recent bid price of the trading day. instrument: nullable: false type: object x-property-sort: - id - name - isin - nsin - assetClass - type description: Instrument data of the notation. properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the instrument of the notation. name: nullable: true type: string description: Asset class-unspecific name in English. isin: nullable: true type: string 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 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. 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 PostNotationSearchByText200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of matching and selected notations. nullable: false items: type: object nullable: false x-property-sort: - id - valueUnit - market - symbol - nsin - fsym - instrument - match - averageIndicativeTradingValue30TD properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of a notation. 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 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. market: nullable: false description: >- Market of the notation. See endpoint `/basic/market/list` for possible values. type: object x-property-sort: - id - name 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. 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 instruments, no symbol will be set for the notations of that market. nsin: nullable: false type: object x-property-sort: - sedol description: NSIN data of the notation. properties: sedol: nullable: true type: string description: The SEDOL or IDII for 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 - isin - nsin - normalizedSymbol - fsym - assetClass - instrumentCategory description: Instrument data of the notation. properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the 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 type: string format: localizedString description: Long name. short: nullable: true x-sortable: true type: string format: localizedString description: Short name. assetClassSpecific: nullable: false type: object x-property-sort: - long - short description: >- Asset class-specific instrument names. Sorting requires that a single asset-class has been selected, see parameter `assetClass.ids`. 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 type: object x-property-sort: - wkn - valor - cusip 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. normalizedSymbol: nullable: true type: string description: >- Symbol of an option or a future, as normalized by FactSet. 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 - name description: >- Asset class of the instrument. See endpoint `/basic/assetClass/list` for possible values. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the asset class. name: nullable: true type: string description: English name of the asset class. instrumentCategory: 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 type: number format: id32 x-positive: true description: Identifier of the category. name: nullable: true type: string format: localizedString description: Name of the category. match: nullable: false description: Details of the match. type: object x-property-sort: - value - score properties: value: nullable: true type: string description: Value matched by the search string. score: nullable: true description: Match score of the string used for the search. x-sortable: true x-default-sort-attribute: true x-default-sort-direction: 2 type: number format: real averageIndicativeTradingValue30TD: nullable: true x-sortable: true type: number format: real description: >- Indicative daily average trading value in US dollars for the past 30 trading days. The average cash flow is converted from the notation's trading currency to US dollars using a single exchange rate determined at the end of the period. 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 parameters: {} examples: {} requestBodies: {} headers: {} securitySchemes: FactSetOAuth2: type: oauth2 flows: clientCredentials: tokenUrl: https://auth.factset.com/as/token.oauth2 scopes: {} FactSetApiKey: type: http scheme: basic links: {} callbacks: {} security: - FactSetApiKey: [] - FactSetOAuth2: [] tags: - name: Basic - name: Category - name: Instrument - name: Notation - name: Prices description: prices endpoints externalDocs: description: API Documentation url: https://developer.factset.com/api-catalog/ x-interface-version: 2 x-documenter-version: 6.3.9 x-api-version: 4.4.0