openapi: 3.0.3 info: title: Factset Analytics Datastore About Date 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: Date paths: /analytics/pub-datastore/swivel/v1/{document}/{accountId}/{date}: get: tags: - Date summary: Factset Redirects to the Raw Ppt/pdf Output Created by the Publisher Service. description: "Takes report parameter inputs and returns the object location for the specified report via a 302 redirect.\r\n\r\nNote: Due to Swagger UI functionality, the redirect is automatically followed when using 'Try it out', so instead of the 302 Header response, a 200 is returned with the Cargo response Body." operationId: getPdfPptMapping parameters: - name: document in: path description: The Publisher document containing the report required: true schema: type: string example: Analytics_Datastore - name: accountId in: path description: The account ID required: true schema: type: string example: LARGE_CORE - name: date in: path description: The as of date for the report required: true schema: type: string format: date example: '2023-01-01' responses: '302': description: Expected response, contains the Cargo URL in the Location header. headers: Location: description: "Redirect URL to get Cargo object. \r\n\n(example: https://api.factset.com/analytics/datastore/cargo/v1/groups/a4186c50f8e74f979d271dd22298c901/objects/fe875bc4150542dea6bc237663a01a0d)" schema: type: string X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '400': description: Invalid parameter provided. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '404': description: The provided request does not exist. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '503': description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK /analytics/pub-datastore/swivel/v1/{document}/{assetName}/{reportId}/{tileId}/{accountId}/{date}: get: tags: - Date summary: Factset Redirects to the Underlying Pa/spar Data Represented in a Stach Format. description: "Takes report parameter inputs and returns the object location for the specified report via a 302 redirect.\r\n\r\nNote: Due to Swagger UI functionality, the redirect is automatically followed when using 'Try it out', so instead of the 302 Header response, a 200 is returned with the Cargo response Body." operationId: getStachMapping parameters: - name: document in: path description: The Publisher or Analytics Datafeed document containing the report required: true schema: type: string example: Analytics_Datastore - name: assetName in: path description: The PA/SPAR asset name and extension required: true schema: type: string example: ADS_Demo.PA3 - name: reportId in: path description: The PA/SPAR report ID required: true schema: type: string example: report7 - name: tileId in: path description: The PA/SPAR tile ID required: true schema: type: string example: tile0 - name: accountId in: path description: The account ID required: true schema: type: string example: LARGE_CORE - name: date in: path description: The as of date for the report required: true schema: type: string format: date example: '2023-01-01' responses: '302': description: Expected response, contains the Cargo URL in the Location header. headers: Location: description: "Redirect URL to get Cargo object. \r\n\n(example: https://api.factset.com/analytics/datastore/cargo/v1/groups/a4186c50f8e74f979d271dd22298c901/objects/fe875bc4150542dea6bc237663a01a0d)" schema: type: string X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '400': description: Invalid parameter provided. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '404': description: The provided request does not exist. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '503': description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK /analytics/pub-datastore/swivel/v1/{document}/{assetName}/{reportId}/{tileId}/{accountId}/{configId}/{date}: get: tags: - Date summary: Factset Redirects to the Underlying Insight/vault Data in a Stach Format. description: "The inclusion of a configId in the path indicates this is for Insight/Vault mappings only, as PA/SPAR mappings do not support the concept of configuration id.\r\n\r\nTakes report parameter inputs and returns the object location for the specified report via a 302 redirect.\r\n\r\nNote: Due to Swagger UI functionality, the redirect is automatically followed when using 'Try it out', so instead of the 302 Header response, a 200 is returned with the Cargo response Body." operationId: getInsightMapping parameters: - name: document in: path description: The Analytics Datafeed document containing the report required: true schema: type: string example: Analytics_Datastore - name: assetName in: path description: The PA/SPAR asset name and extension required: true schema: type: string example: ADS_Demo.PA3 - name: reportId in: path description: The PA/SPAR report ID required: true schema: type: string example: report7 - name: tileId in: path description: The PA/SPAR tile ID required: true schema: type: string example: tile0 - name: accountId in: path description: The account ID required: true schema: type: string example: LARGE_CORE - name: configId in: path description: The Vault configuration ID required: true schema: type: string example: acb5150d-4333-49e7-8e33-4f7fa749691e - name: date in: path description: The as of date for the report required: true schema: type: string format: date example: '2023-01-01' responses: '302': description: Expected response, contains the Cargo URL in the Location header. headers: Location: description: "Redirect URL to get Cargo object. \r\n\n(example: https://api.factset.com/analytics/datastore/cargo/v1/groups/a4186c50f8e74f979d271dd22298c901/objects/fe875bc4150542dea6bc237663a01a0d)" schema: type: string X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '400': description: Invalid parameter provided. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '404': description: The provided request does not exist. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string '503': description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSets request key header. schema: type: string x-microcks-operation: delay: 0 dispatcher: FALLBACK /analytics/accounts/v3/models/{name}/dates/{date}: delete: tags: - Date summary: Factset Delete All Entries for a Date or Specific Symbol Entries for a Date From a Previously Created Account. operationId: deleteModelAccountByDate parameters: - name: name in: path description: The filename of model account to delete required: true schema: type: string description: The filename of model account to delete - name: date in: path description: The date from the given file name to delete required: true schema: type: string description: The date from the given file name to delete - name: symbols in: query description: The symbols from the given file name and date to delete (Maximum 10 symbols are allowed) schema: type: array items: type: string description: The symbols from the given file name and date to delete (Maximum 10 symbols are allowed) responses: '204': description: Expected response, no content headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '400': description: Invalid model account name or date parameter provided headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '401': description: Missing or invalid authentication headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '404': description: The provided account name does not exist at the location provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '503': description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. x-microcks-operation: delay: 0 dispatcher: FALLBACK get: tags: - Date summary: Factset Get Account Endpoint, Takes an Account Name, Date and Returns Underlying Data for That Date operationId: getAccountForDate parameters: - name: name in: path description: The path and filename of the account to get required: true schema: type: string description: The path and filename of the account to get - name: date in: path description: The date for which data needs to be updated required: true schema: type: string description: The date for which data needs to be updated - name: format in: query description: Optional format for the response, supported formats are JsonStach and AccountModel schema: type: string description: Optional format for the response, supported formats are JsonStach and AccountModel default: JsonStach responses: '200': description: Expected response, returns JSON representation of the account's dates, symbols and other fields. headers: Content-Encoding: description: Standard HTTP header. Header value based on Accept-Encoding Request header. schema: type: string description: Standard HTTP header. Header value based on Accept-Encoding Request header. Content-Type: description: Standard HTTP header. schema: type: string description: Standard HTTP header. Transfer-Encoding: description: Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. schema: type: string description: Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataAndMetaModel' '400': description: Invalid account name or type parameter provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '404': description: The provided account name does not exist at the location provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '406': description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '503': description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. x-microcks-operation: delay: 0 dispatcher: FALLBACK /analytics/accounts/v3/models/{name}/dates/{date}/symbols/{symbol}: get: tags: - Date summary: Factset Get Account Endpoint, Takes an Account Name and Returns Underlying Data operationId: getAccountForDateAndSymbol parameters: - name: name in: path description: The path and filename of the account to get required: true schema: type: string description: The path and filename of the account to get - name: symbol in: path description: The symbol for which data needs to be updated required: true schema: type: string description: The symbol for which data needs to be updated - name: date in: path description: The date for which data needs to be updated required: true schema: type: string description: The date for which data needs to be updated - name: format in: query description: Optional format for the response, supported formats are JsonStach and AccountModel schema: type: string description: Optional format for the response, supported formats are JsonStach and AccountModel default: JsonStach responses: '200': description: Expected response, returns JSON representation of the account's dates, symbols and other fields. headers: Content-Encoding: description: Standard HTTP header. Header value based on Accept-Encoding Request header. schema: type: string description: Standard HTTP header. Header value based on Accept-Encoding Request header. Content-Type: description: Standard HTTP header. schema: type: string description: Standard HTTP header. Transfer-Encoding: description: Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. schema: type: string description: Standard HTTP header. Header value will be set to Chunked if Accept-Encoding header is specified. X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/DataAndMetaModel' '400': description: Invalid account name or type parameter provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '404': description: The provided account name does not exist at the location provided. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string content: application/json: schema: $ref: '#/components/schemas/ClientErrorResponse' '406': description: Unsupported Accept header. Header needs to be set to application/json. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. '503': description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. X-FactSet-Api-Request-Key: description: Key to uniquely identify an Analytics API request. Only available after successful authentication. schema: type: string description: Key to uniquely identify an Analytics API request. Only available after successful authentication. x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/keyFigures/yearToDate/get: get: tags: - Date operationId: get/notation/keyFigures/yearToDate/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (eod) Key Figures for the Time Range Year-to-date (ytd).. description: End-of-day (EOD) key figures for the time range year-to-date (YTD). The time range YTD begins with the last trading day of the previous calendar year for which EOD prices are available and ends with the most recent trading day of the current calendar year for which EOD prices are available.. parameters: - name: identifier in: query schema: type: string pattern: ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresYearToDateGet200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/keyFigures/yearToDate/list: get: tags: - Date operationId: get/notation/keyFigures/yearToDate/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (eod) Key Figures for the Time Range Year-to-date (ytd), for a List of Notations.. description: End-of-day (EOD) key figures for the time range year-to-date (YTD), for a list of notations. The time range YTD begins with the last trading day of the previous calendar year for which EOD prices are available and ends with the most recent tradingday of the current calendar year for which EOD prices are available.. parameters: - name: identifiers in: query schema: description: Set of identifiers to resolve. type: array nullable: false items: type: string minLength: 3 exclusiveMinimum: false maxLength: 50 exclusiveMaximum: false pattern: ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ uniqueItems: true minItems: 1 maxItems: 100 required: true style: form explode: false - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresYearToDateList200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: ClientErrorResponse: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error' example: [] ErrorSource: type: object properties: pointer: type: string example: example_value parameter: type: string example: example_value Error: type: object properties: id: type: string example: abc123 detail: type: string example: example_value source: $ref: '#/components/schemas/ErrorSource' 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 DataAndMetaModel: required: - data type: object properties: data: example: example_value meta: example: example_value responses: GetNotationKeyFiguresYearToDateGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. volatility: nullable: true type: number format: real description: Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - volatility description: EOD key figures. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetNotationKeyFiguresYearToDateList200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: EOD key figures for a list of notations. nullable: false items: type: object nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - volatility - status properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. volatility: nullable: true type: number format: real description: Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. status: nullable: false type: object x-property-sort: - code - identifier - details - encryptedDetails description: Error status for the requested identifier. properties: code: nullable: true type: string description: Code of the error condition. x-enum-description: - No error. - The provided identifier does not refer to a valid notation. - Not entitled to see data for the notation. - Unable to resolve the provided identifier. enum: - none - parameter - entitlement - identifierMapping identifier: nullable: true type: string format: id64 x-positive: true description: Provided identifier. details: nullable: true type: string description: A human-readable, unstructured explanation specific to this occurrence of the problem. encryptedDetails: nullable: true type: string description: Base64-encoded internal details about the error. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta securitySchemes: basicAuth: type: http scheme: basic externalDocs: url: https://developer.factset.com/api-catalog/analytics-datastore-api description: API Documentation