openapi: 3.0.3 info: title: Factset Analytics Datastore About Basic API description: Allow clients to fetch precalculated Analytics through predeterministic URLs. contact: name: FactSet Research Systems url: https://developer.factset.com/contact email: api@factset.com license: name: Apache License, Version 2.0 url: https://www.apache.org/licenses/LICENSE-2.0 version: 1.0.0 servers: - url: https://api.factset.com description: Production - url: https://api-sandbox.factset.com description: Sandbox security: - basicAuth: [] tags: - name: Basic paths: /alerting/prices/basic/alert/get: get: tags: - Basic operationId: get/alerting/prices/basic/alert/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: true x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: Details of an alert. The details include the trigger definition at the time of alert creation. summary: Factset Details of an Alert. parameters: - name: id in: query schema: description: Identifier of the alert. type: string format: id64 x-positive: true 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/GetAlertingPricesBasicAlertGet200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /alerting/prices/basic/alert/list: get: tags: - Basic operationId: get/alerting/prices/basic/alert/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: true x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: true x-requiresUser: true x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: List of alerts in descending order of creation. summary: Factset List of Alerts. responses: '200': $ref: '#/components/responses/GetAlertingPricesBasicAlertList200Response' 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. - description: Non-negative number of milliseconds to throttle the update rate from 0ms to 5000ms. Set to 0 for sending updates immediately. name: _subscriptionMinimumInterval in: query schema: type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 5000 exclusiveMaximum: false default: 0 - description: Starting point as returned in the attributes `pagination.next` or `pagination.previous` by a prior invocation of this endpoint, or undefined (default). name: _paginationCursor in: query schema: type: string maxLength: 50 exclusiveMaximum: false - 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 x-microcks-operation: delay: 0 dispatcher: FALLBACK /alerting/prices/basic/trigger/get: get: tags: - Basic operationId: get/alerting/prices/basic/trigger/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: true x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: Details of a trigger. summary: Factset Details of a Trigger. parameters: - name: id in: query schema: type: string format: id64 x-positive: true description: Identifier of the trigger. 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/GetAlertingPricesBasicTriggerGet200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /alerting/prices/basic/trigger/list: post: tags: - Basic operationId: post/alerting/prices/basic/trigger/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: true x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: true x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: Returns a list of triggers sorted in descending order of creation. summary: Factset List of Triggers. requestBody: description: Request Body content: application/json: schema: $ref: '#/components/schemas/PostAlertingPricesBasicTriggerListRequest' required: false responses: '200': $ref: '#/components/responses/PostAlertingPricesBasicTriggerList200Response' parameters: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /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. x-microcks-operation: delay: 0 dispatcher: FALLBACK /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: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /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 x-microcks-operation: delay: 0 dispatcher: FALLBACK /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: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /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 x-microcks-operation: delay: 0 dispatcher: FALLBACK /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' x-microcks-operation: delay: 0 dispatcher: FALLBACK /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' x-microcks-operation: delay: 0 dispatcher: FALLBACK /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 x-microcks-operation: delay: 0 dispatcher: FALLBACK /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' x-microcks-operation: delay: 0 dispatcher: FALLBACK /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: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /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 x-microcks-operation: delay: 0 dispatcher: FALLBACK /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 x-microcks-operation: delay: 0 dispatcher: FALLBACK /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. x-microcks-operation: delay: 0 dispatcher: FALLBACK /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: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /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: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /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' x-microcks-operation: delay: 0 dispatcher: FALLBACK /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 x-microcks-operation: delay: 0 dispatcher: FALLBACK /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' x-microcks-operation: delay: 0 dispatcher: FALLBACK /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 x-microcks-operation: delay: 0 dispatcher: FALLBACK /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' x-microcks-operation: delay: 0 dispatcher: FALLBACK /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' x-microcks-operation: delay: 0 dispatcher: FALLBACK /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 x-microcks-operation: delay: 0 dispatcher: FALLBACK /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' x-microcks-operation: delay: 0 dispatcher: FALLBACK /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' x-microcks-operation: delay: 0 dispatcher: FALLBACK /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: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /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' x-microcks-operation: delay: 0 dispatcher: FALLBACK /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: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /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 x-microcks-operation: delay: 0 dispatcher: FALLBACK /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: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /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' x-microcks-operation: delay: 0 dispatcher: FALLBACK /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 x-microcks-operation: delay: 0 dispatcher: FALLBACK /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: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /instrument/search/basic: get: tags: - Basic operationId: get/instrument/search/basic x-supportsOffsetBasedPaging: true x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset Basic Search for Instruments. description: Search for instruments whose ISIN, specified NSINs, or name match the search value according to a tolerant full-text match algorithm. Better matching results appear in the response before less relevant matches. parameters: - name: searchValue in: query schema: type: string minLength: 3 exclusiveMinimum: false maxLength: 200 exclusiveMaximum: false pattern: ^[ -!#-&(-+--/0-:=?-Za-z\w"]*$ description: The search value of the instruments searching for. It may be enclosed in double quotes ("). No escaping is provided, therefore it is impossible to specify a search string containing double quotes. Relevance of word starts is indicated by a phrase starting with a space character, such as " daimler". required: true - name: nsins in: query schema: description: A set of NSIN kinds to consider in the search. If the parameter is absent or the value is empty, all valid NSIN kinds are searched. type: array nullable: false items: type: string x-enum-description: - The WKN (Wertpapierkennnummer, German for Securities Identification Number) of the instrument. The WKN is a 6-character code of digits and upper-case letters that uniquely identifies an instrument. - 'The Valor number (German: Valorennummer) of the instrument. The Valor number is an integer number that uniquely identifies an instrument.' - The CUSIP (Committee on Uniform Security Identification Procedures) or CINS (CUSIP International Numbering System) identifier of the instrument. These numbers are 9-character codes of digits and upper-case letters that uniquely identify an instrument. - The SEDOL or IDII for the instrument; see entity class "SEDOL or IDII" for details. enum: - wkn - valor - cusip - sedol uniqueItems: true style: form explode: false - name: assetClass in: query schema: type: string description: A parameter to limit the output to a particular asset class. x-enum-description: - An index is an instrument representing a statistical measure of changes in a group of data points. An index has a well-defined calculation method. An index may have index constituents, selected according to a well-defined set of rules. - A stock, also known as stock certificate or share, represents the partitioned capital stock of a company. The capital stock of a company constitutes the equity stake of its owners. - A fund is a supply of capital belonging to numerous investors that is used to collectively purchase securities while each investor retains ownership and control of his or her own shares. - An exchange traded fund (ETF) is a security that tracks an index, a commodity or a basket of assets like an index fund, but trades like a stock on an exchange. ETFs experience price changes throughout the day as they are bought and sold. - A debt instrument is an interest-bearing or interest-earning financial instrument, which is generally used for long-term debt financing and investment. - An investment product is a securitized derivatives product which allows the investor to participate in the performance of the underlying financial instrument. - A leveraged product is a securitized derivatives product which allows the investor to participate with a leverage in the performance of the underlying financial instrument. - A currency cross rate is an exchange rate between two main currencies. - A commodity is a marketable item produced to satisfy market requirements. Economic commodities comprise both goods and services. - An option is a derivatives contract that represents a contract sold by one party (the option writer) to another party (the option holder). The contract offers the buyer the right, but not the obligation, to buy (call) or sell (put) a particular underlying asset at an agreed price (the strike price) on a specific exercise date (European-style option) or during a period of time up to that exercise date (American-style option). - A future is a derivatives contract that represents a contractual agreement to buy or sell a particular underlying asset at a pre-determined price on a specific date in the future. A future contract details the quality and quantity of the underlying asset. Some future contracts may require a physical delivery of the asset, whereas others are settled in cash. In contrast to a forward (traded over-the-counter (OTC)), a future is a standardized derivative traded on a futures exchange. - An interest rate is the rate at which interest is paid by borrowers for the use of money borrowed from a lender. Specifically, the interest rate is a percentage of the principal. - Rights are securities that allow the owner to participate at the securitized right. enum: - index - stock - fund - etf - debt - investmentProduct - leveragedProduct - currency - commodity - option - future - interestRate - right - name: onlyActive in: query schema: type: boolean description: If true, restricts the result to active instruments. default: true required: false - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. - name: _language in: query schema: type: string format: isoLanguage description: ISO 639-1 code of the language. maxLength: 2 minLength: 2 exclusiveMinimum: false exclusiveMaximum: false - description: Non-negative number of entries to skip, or 0 (default). name: _paginationOffset in: query schema: type: number format: int32 minimum: 0 exclusiveMinimum: false default: 0 - description: Non-negative maximum number of entries to return. name: _paginationLimit in: query schema: type: number format: int32 minimum: 0 exclusiveMinimum: false maximum: 500 exclusiveMaximum: false default: 20 responses: '200': $ref: '#/components/responses/GetInstrumentSearchBasic200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/search/basic: get: tags: - Basic 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' x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: PartialOutputObject: type: object properties: isPartial: type: boolean description: Flag indicating that the response is a possibly incomplete array or an object containing a possibly incomplete array, due to hitting a processing time limit. If `true`, some matching results might be missing from the array, or elements for matching results might be incorrectly included (for example, when priority sorting would have removed the element). Depending on the use case, such a response may be unsuitable. example: true description: Object denoting that the endpoint response is possibly incomplete. required: - isPartial x-property-sort: - isPartial 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. example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' x-property-sort: - attributes example: example_value 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. example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' language: $ref: '#/components/schemas/LanguageMember' sort: description: Sortable attributes. The sort order is ascending unless it is prefixed with a minus sign, in which case it is descending. A list of at most 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 example: example_value 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. example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' x-property-sort: - attributes example: example_value LanguageMember: type: string format: isoLanguage description: ISO 639-1 code of the language. maxLength: 2 minLength: 2 exclusiveMinimum: false exclusiveMaximum: false 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. example: example_value 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 example: example_value 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 example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' language: $ref: '#/components/schemas/LanguageMember' sort: description: Sortable attributes. The sort order is ascending unless it is prefixed with a minus sign, in which case it is descending. A list of at most 1 (possibly prefixed) attribute name(s) is allowed. type: array items: type: string enum: - name - -name maxItems: 1 uniqueItems: true default: - name x-property-sort: - attributes - language - sort example: example_value AttributesMember: type: array description: Limit the attributes returned in the response to the specified set. items: type: string maxLength: 100 exclusiveMaximum: false maxItems: 50 uniqueItems: true 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 example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' language: $ref: '#/components/schemas/LanguageMember' sort: description: Sortable attributes. The sort order is ascending unless it is prefixed with a minus sign, in which case it is descending. A list of at most 1 (possibly prefixed) attribute name(s) is allowed. type: array items: type: string enum: - name - -name maxItems: 1 uniqueItems: true default: - name x-property-sort: - attributes - language - sort example: example_value 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. example: example_value 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 example: example_value 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 example: example_value meta: type: object description: The meta member contains the meta information of the request. properties: attributes: $ref: '#/components/schemas/AttributesMember' language: $ref: '#/components/schemas/LanguageMember' sort: description: Sortable attributes. The sort order is ascending unless it is prefixed with a minus sign, in which case it is descending. A list of at most 1 (possibly prefixed) attribute name(s) is allowed. type: array items: type: string enum: - name - -name maxItems: 1 uniqueItems: true default: - name x-property-sort: - attributes - language - sort example: example_value 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. example: true required: - hasNext x-property-sort: - hasNext StatusObject: type: object properties: code: type: number format: int32 description: The HTTP status code of the response, mirroring the code from the Status-Line of the HTTP response message (see [RFC2616] section 6.1). example: 42.5 description: The status member contains the status code of the response. required: - code 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. example: 42.5 isEstimatedTotal: type: boolean description: Flag indicating that the value of `total` is estimated. example: true next: type: string description: The next cursor position to use in the parameter `pagination.cursor` for an endpoint that supports cursor-based pagination, otherwise `null`. example: example_value previous: type: string description: The previous cursor position to use in the parameter `pagination.cursor` for an endpoint that supports cursor-based pagination. If a previous cursor position is not supported or available, `previous` is `null`. example: example_value required: - total - isEstimatedTotal - next - previous x-property-sort: - total - isEstimatedTotal - next - previous PostAlertingPricesBasicTriggerListRequest: 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. properties: status: type: object x-property-sort: - code description: Status of the trigger. properties: code: type: string description: Code of the status. x-enum-description: - The trigger is active and trigger conditions are evaluated. - The trigger is inactive and conditions do not generate alerts. - The trigger is in an error state, error details are noted in `details` enum: - active - inactive - error example: example_value 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 example: example_value OffsetBasedPaginationOutputObject: type: object description: Pagination attributes for the offset-based pagination strategy. properties: total: type: number format: int32 description: Total number of entries in the result set. example: 42.5 isEstimatedTotal: type: boolean description: Flag indicating that the value of "total" is estimated. example: true required: - total - isEstimatedTotal x-property-sort: - total - isEstimatedTotal 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 example: example_value 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 example: example_value responses: 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 GetAlertingPricesBasicTriggerGet200Response: 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 trigger. creation: nullable: true type: string format: datetime description: Date and time when the trigger was created. notation: nullable: false type: object x-property-sort: - id description: Notation data of the trigger. properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the notation. price: nullable: false description: Price data of the trigger. type: object x-property-sort: - type - quality properties: type: nullable: true type: string description: Type of the price as configured for the customer. x-enum-description: - Trade price (ordinary, auction, pre or post-trading). - Bid price. - Ask price. enum: - trade - bid - ask 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 range: nullable: false type: object x-property-sort: - upperLimit - lowerLimit description: Price range for the trigger to monitor. properties: upperLimit: nullable: true type: number format: real description: Upper limit. lowerLimit: nullable: true type: number format: real description: Lower limit. comment: nullable: true type: string description: Comment of the trigger. notification: nullable: false type: object x-property-sort: - channel description: Selection of notifications for triggered alerts. properties: channel: nullable: false description: Notification channel selection; see endpoint `/alerting/notification/channel/list` for possible channels. type: array items: type: object nullable: false x-property-sort: - id properties: id: nullable: true description: Identifier of the notification channel. type: number format: id32 x-positive: true status: nullable: false type: object x-property-sort: - code - details - encryptedDetails description: Status of the trigger. properties: code: nullable: true type: string description: Code of the status. x-enum-description: - The trigger is active and trigger conditions are evaluated. - The trigger is inactive and conditions do not generate alerts - The trigger is in an error state, error details are noted in "details" enum: - active - inactive - error details: nullable: true type: string description: A human-readable, unstructured explanation specific to this error. encryptedDetails: nullable: true type: string description: Base64-encoded, internal details about the error, in addition to "details". An issue submitted to Service Desk should contain this data to speed up investigation. description: Details of the trigger. nullable: false x-property-sort: - id - creation - notation - price - range - comment - notification - status 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 PostAlertingPricesBasicTriggerList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of triggers. nullable: false items: type: object nullable: false x-property-sort: - id - creation - notation - price - range - comment - notification - status properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the trigger. creation: nullable: true type: string format: datetime description: Date and time when the trigger was created. notation: nullable: false type: object x-property-sort: - id description: Notation data of the trigger. properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the notation. price: nullable: false description: Price data of the trigger. type: object x-property-sort: - type - quality properties: type: nullable: true type: string description: Type of the price as configured for the customer. x-enum-description: - Trade price (ordinary, auction, pre or post-trading). - Bid price. - Ask price. enum: - trade - bid - ask 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 range: nullable: false type: object x-property-sort: - upperLimit - lowerLimit description: Price range for the trigger to monitor. properties: upperLimit: nullable: true type: number format: real description: Upper limit. lowerLimit: nullable: true type: number format: real description: Lower limit. comment: nullable: true type: string description: Comment of the trigger. notification: nullable: false type: object x-property-sort: - channel description: Selection of notifications for triggered alerts. properties: channel: nullable: false description: Notification channel selection; see endpoint `/alerting/notification/channel/list` for possible channels. type: array items: type: object nullable: false x-property-sort: - id properties: id: nullable: true description: Identifier of the notification channel. type: number format: id32 x-positive: true status: nullable: false type: object x-property-sort: - code - details description: Status of the trigger. properties: code: nullable: true type: string description: Code of the status. x-enum-description: - The trigger is active and trigger conditions are evaluated. - The trigger is inactive and conditions do not generate alerts - The trigger is in an error state, error details are noted in "details" enum: - active - inactive - error details: nullable: true type: string description: A human-readable, unstructured explanation specific to this error. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' pagination: $ref: '#/components/schemas/CursorBasedPaginationOutputObject' x-property-sort: - status - pagination x-property-sort: - data - meta GetAlertingPricesBasicAlertList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: List of alerts. nullable: false items: type: object nullable: false x-property-sort: - id - creation - price - notification - trigger properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the alert. creation: nullable: true type: string format: datetime description: Date and time when the alert was created. price: nullable: false type: object x-property-sort: - value - time description: Price data at the time of alert creation. properties: value: nullable: true type: number format: real description: Depending on `trigger.price.type`, the trade, bid, or ask price. time: nullable: true type: string format: datetime description: Date and time of the price. notification: nullable: false type: object x-property-sort: - status description: Notification information of the alert. properties: status: nullable: false description: Status of a notification per channel. type: array items: type: object nullable: false x-property-sort: - channel - time - code properties: channel: nullable: false type: object x-property-sort: - id description: Details of the notification channel. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the notification channel. time: nullable: true type: string format: datetime description: Date and time of the most recent change. code: nullable: true type: string description: Code of the status. x-enum-description: - Notification has not been processed. - Notification has been sent but delivery status is unknown. - Notification has been delivered. - Notification has not been delivered due to an error. - Notification delivery has been rejected (possibly due to return mails being received for delivery address). enum: - pending - sent - delivered - error - rejected trigger: nullable: false description: Trigger data at the time of alert creation. type: object x-property-sort: - id - creation - notation - price - range - comment - notification - status properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the trigger. creation: nullable: true type: string format: datetime description: Date and time when the trigger was created. notation: nullable: false type: object x-property-sort: - id description: Notation data of the trigger. properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the notation. price: nullable: false description: Price data of the trigger. type: object x-property-sort: - type - quality properties: type: nullable: true type: string description: Type of the price as configured for the customer. x-enum-description: - Trade price (ordinary, auction, pre or post-trading). - Bid price. - Ask price. enum: - trade - bid - ask 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 range: nullable: false type: object x-property-sort: - upperLimit - lowerLimit description: Price range for the trigger to monitor. properties: upperLimit: nullable: true type: number format: real description: Upper limit. lowerLimit: nullable: true type: number format: real description: Lower limit. comment: nullable: true type: string description: Comment of the trigger. notification: nullable: false type: object x-property-sort: - channel description: Notification specific configuration. properties: channel: nullable: false type: object x-property-sort: - id description: Channel specific configuration. properties: id: nullable: false description: Identifier of the notification channel. type: array items: type: number format: id32 x-positive: true status: nullable: false type: object x-property-sort: - code - details description: Status of the trigger. properties: code: nullable: true type: string description: Code of the status. x-enum-description: - The trigger is active and trigger conditions are evaluated. - The trigger is inactive and conditions do not generate alerts - The trigger is in an error state, error details are noted in "details" enum: - active - inactive - error details: nullable: true type: string description: A human-readable, unstructured explanation specific to this error. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' pagination: $ref: '#/components/schemas/CursorBasedPaginationOutputObject' x-property-sort: - status - pagination x-property-sort: - data - meta GetAlertingPricesBasicAlertGet200Response: 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 alert. creation: nullable: true type: string format: datetime description: Date and time when the alert was created. price: nullable: false type: object x-property-sort: - value - time description: Price data at the time of alert creation. properties: value: nullable: true type: number format: real description: Depending on `trigger.price.type`, the trade, bid, or ask price. time: nullable: true type: string format: datetime description: Date and time of the price. notification: nullable: false type: object x-property-sort: - status description: Notification information of the alert. properties: status: nullable: false description: Status of a notification per channel. type: array items: type: object nullable: false x-property-sort: - channel - time - code properties: channel: nullable: false type: object x-property-sort: - id description: Details of the notification channel. properties: id: nullable: true type: number format: id32 x-positive: true description: Identifier of the notification channel. time: nullable: true type: string format: datetime description: Date and time of the most recent change. code: nullable: true type: string description: Code of the status. x-enum-description: - Notification has not been processed. - Notification has been sent but delivery status is unknown. - Notification has been delivered. - Notification has not been delivered due to an error. - Notification delivery has been rejected (possibly due to return mails being received for delivery address). enum: - pending - sent - delivered - error - rejected trigger: nullable: false description: Trigger data at the time of alert creation. type: object x-property-sort: - id - creation - notation - price - range - comment - notification - status properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the trigger. creation: nullable: true type: string format: datetime description: Date and time when the trigger was created. notation: nullable: false type: object x-property-sort: - id description: Notation data of the trigger. properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the notation. price: nullable: false description: Price data of the trigger. type: object x-property-sort: - type - quality properties: type: nullable: true type: string description: Type of the price as configured for the customer. x-enum-description: - Trade price (ordinary, auction, pre or post-trading). - Bid price. - Ask price. enum: - trade - bid - ask quality: nullable: true type: string description: Price quality of the trigger. 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.' enum: - RLT - DLY - EOD range: nullable: false type: object x-property-sort: - upperLimit - lowerLimit description: Price range for the trigger to monitor. properties: upperLimit: nullable: true type: number format: real description: Upper limit. lowerLimit: nullable: true type: number format: real description: Lower limit. comment: nullable: true type: string description: Comment of the trigger. notification: nullable: false type: object x-property-sort: - channel description: Notification specific configuration. properties: channel: nullable: false type: object x-property-sort: - id description: Channel specific configuration. properties: id: nullable: false description: Identifier of the notification channel. type: array items: type: number format: id32 x-positive: true status: nullable: false type: object x-property-sort: - code - details - encryptedDetails description: Status of the trigger. properties: code: nullable: true type: string description: Code of the status. x-enum-description: - The trigger is active and trigger conditions are evaluated. - The trigger is inactive and conditions do not generate alerts - The trigger is in an error state, error details are noted in "details" enum: - active - inactive - error details: nullable: true type: string description: A human-readable, unstructured explanation specific to this error. encryptedDetails: nullable: true type: string description: Base64-encoded, internal details about the error, in addition to "details". An issue submitted to Service Desk should contain this data to speed up investigation. description: Details of the alert. nullable: false x-property-sort: - id - creation - price - notification - trigger 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 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 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 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 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 securitySchemes: basicAuth: type: http scheme: basic externalDocs: url: https://developer.factset.com/api-catalog/analytics-datastore-api description: API Documentation