openapi: 3.0.3 info: title: Factset Analytics Datastore About Status 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: Status paths: /status: post: operationId: getChatStatus summary: Factset Retrieve the status of a chat response process. description: 'Returns the status of a chat response for a given chat conversation ID (recevied from the `/create` endpoint). Poll the `/status` endpoint with your conversation ID to confirm when your data is ready. Answers may take minutes to generate, depending on the complexity of the query. ' tags: - Status requestBody: description: ID representing the chat process for your query required: true content: application/json: schema: $ref: '#/components/schemas/ChatPollingRequest' examples: Example request: $ref: '#/components/examples/ChatPollingRequestExample' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/StatusPollResponse' examples: Example question: $ref: '#/components/examples/StatusPollResponseCreatedExample' headers: Location: description: Relative URL to the query response. schema: type: string enum: - /result Api-Supported-Versions: description: Comma-separated list of supported major versions. schema: type: string example: '0' Api-Version: description: Full semantic version of the API. schema: type: string example: 0.1.0 RateLimit-Limit: description: Request limit per second. schema: type: integer example: 10 RateLimit-Remaining: description: Number of available requests. schema: type: integer example: 9 RateLimit-Reset: description: Time remaining (in seconds) until request limit is reset. schema: type: integer example: 1 X-RateLimit-Limit-minute: description: Request limit per minute. schema: type: integer example: 300 X-RateLimit-Remaining-minute: description: Number of available requests in the current minute. schema: type: integer example: 290 X-DataDirect-Request-Key: description: FactSet request ID. schema: type: string example: 65C6BC290A11FB4F '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/StatusPollResponse' examples: Example question: $ref: '#/components/examples/StatusPollResponseAcceptedExample' headers: Location: description: Relative URL to check the status of the request. schema: type: string enum: - /status Api-Supported-Versions: description: Comma-separated list of supported major versions. schema: type: string example: '0' Api-Version: description: Full semantic version of the API. schema: type: string example: 0.1.0 RateLimit-Limit: description: Request limit per second. schema: type: integer example: 10 RateLimit-Remaining: description: Number of available requests. schema: type: integer example: 9 RateLimit-Reset: description: Time remaining (in seconds) until request limit is reset. schema: type: integer example: 1 X-RateLimit-Limit-minute: description: Request limit per minute. schema: type: integer example: 300 X-RateLimit-Remaining-minute: description: Number of available requests in the current minute. schema: type: integer example: 290 X-DataDirect-Request-Key: description: FactSet request ID. schema: type: string example: 65C6BC290A11FB4F '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Unauthorized - You are not properly authenticated for use of this API. Please make sure you are logged in to the developer portal or using a valid API key (managed [here](https://developer.factset.com/manage-api-keys)) for access. If you believe you are seeing this message in error, please reach out to your FactSet Support Team representative. content: text/plain: schema: $ref: '#/components/schemas/401UnauthorizedError' examples: Example error: $ref: '#/components/examples/401UnauthorizedErrorExample' '403': description: Forbidden - You do not have the entitlements enabled for this service. Please reach out to your FactSet Support Team representative to receive the proper entitlements. content: text/plain: schema: $ref: '#/components/schemas/403ForbiddenError' examples: Example error: $ref: '#/components/examples/403ForbiddenErrorExample' '429': description: Too Many Requests - The /status endpoint is currently rate-limited to 10 requests per second for an individual organization. If you are receiving an unexpected amount of these errors, please contact the API team at [genai.offplatform@factset.com](genai.offplatform@factset.com). content: application/json: schema: $ref: '#/components/schemas/RateLimitExceededError' examples: Example error: $ref: '#/components/examples/RateLimitExceededErrorExample' headers: RateLimit-Limit: description: Request limit per second. schema: type: integer example: 10 RateLimit-Remaining: description: Number of available requests. schema: type: integer example: 9 RateLimit-Reset: description: Time remaining (in seconds) until request limit is reset. schema: type: integer example: 1 Retry-After: description: How long (in seconds) to wait before attempting to send a new request. schema: type: integer example: 1 X-RateLimit-Limit-minute: description: Request limit per minute. schema: type: integer example: 300 X-RateLimit-Remaining-minute: description: Number of available requests in the current minute. schema: type: integer example: 290 X-DataDirect-Request-Key: description: FactSet request ID. schema: type: string example: 65C6BC290A11FB4F '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error' /analytics/engines/afi/v3/optimizations/{id}/status: get: tags: - Status summary: Factset Get Afi Optimization Status by Id description: "This is the endpoint to check on the progress of a previously requested optimization.\r\nIf the optimization has finished computing, the body of the response will contain result in JSON.\r\nOtherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage." operationId: getOptimizationStatusById parameters: - name: id in: path description: from url, provided from the location header in the Create and Run AFI optimization endpoint required: true schema: type: string description: from url, provided from the location header in the Create and Run AFI optimization endpoint responses: '201': description: Expected response once optimization is completed, returns 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 content: application/json: schema: $ref: '#/components/schemas/ObjectRoot' '202': description: Expected response returned if the optimization is not yet completed, should contain X-FactSet-Api-PickUp-Progress header. headers: X-FactSet-Api-PickUp-Progress: description: FactSet's progress header. schema: type: string description: FactSet's progress header. Cache-Control: description: Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. schema: type: integer description: Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. 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 identifier 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: Optimization result was already returned, provided id was not a requested optimization, or the optimization was cancelled 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-are-multiple-success-responses-different: true x-success-response-types: - status-code: '201' response-type: ObjectRoot - status-code: '202' response-type: null x-microcks-operation: delay: 0 dispatcher: FALLBACK /v1/batch-status: get: summary: Factset Returns the Status for a Batch Request description: "Return the status for the underlying batch request that is specified by the id.\n\n The Formula API supports Long Running asynchronous requests up to **20 minutes** via the `batch` parameter in the `/time-series` endpoint and up to **10 minutes** in the `/cross-sectional` endpoint.\n\n *This feature is available to Individual Users subscribed to the Performance Package and Performance Package Plus Performance Tiers and all Production Users. If you are unsure which Performance\nTier you are subscribed to or you would like to gain access to the batch capabilities, please contact your FactSet Account Team or \"Report Issue\" above and our support teams can assist.*\n" tags: - Status operationId: getBatchStatus parameters: - $ref: '#/components/parameters/batchId' responses: '201': description: Batch Request has been completed and the response has been created. headers: Location: description: Path to Batch Request result. schema: type: string example: batch/v1/result?id=2df43e85-ea0f-45c6-bf4a-2baf4d1eaa3c content: application/json: schema: $ref: '#/components/schemas/BatchStatusResponse' examples: Batch Status Done: $ref: '#/components/examples/BatchStatusDoneResponse' '202': description: Batch Request has not finished and the result has NOT been created. content: application/json: schema: $ref: '#/components/schemas/BatchStatusResponse' examples: Batch Status Queued: $ref: '#/components/examples/BatchStatusQueuedResponse' Batch Status Executing: $ref: '#/components/examples/BatchStatusExecutingResponse' Batch Status Failed - Timeout: $ref: '#/components/examples/BatchStatusFailedResponseTimeout' Batch Status Failed - Memory Limit: $ref: '#/components/examples/BatchStatusFailedResponseMemoryLimit' Batch Status Failed - Other: $ref: '#/components/examples/BatchStatusFailedResponseOther' '404': description: Not Found headers: api-version: $ref: '#/components/headers/api-version' api-supported-versions: $ref: '#/components/headers/api-supported-versions' api-deprecated-versions: $ref: '#/components/headers/api-deprecated-versions' chain-id: $ref: '#/components/headers/chain-id' content: application/json: schema: $ref: '#/components/schemas/error_detail' example: id: 5EFCCA8940CAEB6E code: batchRequestNotFound title: The Batch Request was not found. It has probably expired. timeStamp: '2019-11-01 11:09:41.918' deprecated: false x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: Factset Returns the Status for a Batch Request description: "Return the status for the underlying batch request that is specified by the id.\n\n The Formula API supports Long Running asynchronous requests up to **20 minutes** via the `batch` parameter in the `/time-series` endpoint and up to **10 minutes** in the `/cross-sectional` endpoint.\n\n *This feature is available to Individual Users subscribed to the Performance Package and Performance Package Plus Performance Tiers and all Production Users. If you are unsure which Performance\nTier you are subscribed to or you would like to gain access to the batch capabilities, please contact your FactSet Account Team or \"Report Issue\" above and our support teams can assist.*\n" tags: - Status operationId: getBatchStatusWithPost responses: '201': description: Batch Request has been completed and the response has been created. headers: Location: description: Path to Batch Request result. schema: type: string example: batch/v1/result?id=2df43e85-ea0f-45c6-bf4a-2baf4d1eaa3c content: application/json: schema: $ref: '#/components/schemas/BatchStatusResponse' examples: Batch Status Done: $ref: '#/components/examples/BatchStatusDoneResponse' '202': description: Batch Request has not finished and the result has NOT been created. content: application/json: schema: $ref: '#/components/schemas/BatchStatusResponse' examples: Batch Status Queued: $ref: '#/components/examples/BatchStatusQueuedResponse' Batch Status Executing: $ref: '#/components/examples/BatchStatusExecutingResponse' Batch Status Failed - Timeout: $ref: '#/components/examples/BatchStatusFailedResponseTimeout' Batch Status Failed - Memory Limit: $ref: '#/components/examples/BatchStatusFailedResponseMemoryLimit' Batch Status Failed - Other: $ref: '#/components/examples/BatchStatusFailedResponseOther' '404': description: Not Found headers: api-version: $ref: '#/components/headers/api-version' api-supported-versions: $ref: '#/components/headers/api-supported-versions' api-deprecated-versions: $ref: '#/components/headers/api-deprecated-versions' chain-id: $ref: '#/components/headers/chain-id' content: application/json: schema: $ref: '#/components/schemas/error_detail' example: id: 5EFCCA8940CAEB6E code: batchRequestNotFound title: The Batch Request was not found. It has probably expired. timeStamp: '2019-11-01 11:09:41.918' deprecated: false requestBody: $ref: '#/components/requestBodies/batch-status-postBody' x-microcks-operation: delay: 0 dispatcher: FALLBACK /factset-funds/v1/status: get: tags: - Status summary: Factset Get Fund's Current Status and Database Availability operationId: getStatuses description: 'Get the funds active status, share class status, and database availability. Most common use is for coverage checks and id resolution checks. ' parameters: - $ref: '#/components/parameters/ids' responses: '200': description: The Statuses response object. content: application/json: schema: $ref: '#/components/schemas/statusesResponse' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - Status summary: Factset Get Fund's Current Status and Database Availability for Large List of Ids. description: 'Get the funds active status, share class status, and database availability. Most common use is for coverage checks and id resolution checks. ' operationId: getStatusesForList requestBody: required: true description: The Statuses request body, allowing the user to specify a list of ids. content: application/json: schema: $ref: '#/components/schemas/statusesRequest' responses: '200': description: The Statuses response object. content: application/json: schema: $ref: '#/components/schemas/statusesResponse' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '403': $ref: '#/components/responses/403' '415': $ref: '#/components/responses/415' '500': $ref: '#/components/responses/500' x-microcks-operation: delay: 0 dispatcher: FALLBACK /factset-global-prices/v1/batch-status: get: tags: - Status summary: Factset Returns the Status for a Batch Request description: Return the status for the underlying batch request that is specified by the id. operationId: getBatchStatus parameters: - $ref: '#/components/parameters/batchId' responses: '201': description: The batch Request has been completed and the response has been created. headers: Location: description: Path to Batch Request result. schema: type: string example: batch-result?id=2df43e85-ea0f-45c6-bf4a-2baf4d1eaa3c content: application/json: schema: $ref: '#/components/schemas/BatchStatusResponse' examples: Batch Status Done: $ref: '#/components/examples/BatchStatusDoneResponse_2' '202': description: The batch Request has not finished and the result has NOT been created. content: application/json: schema: $ref: '#/components/schemas/BatchStatusResponse' examples: Batch Status Queued: $ref: '#/components/examples/BatchStatusQueuedResponse_2' Batch Status Executing: $ref: '#/components/examples/BatchStatusExecutingResponse_2' Batch Status Failed: $ref: '#/components/examples/BatchStatusFailedResponse' '404': $ref: '#/components/responses/batch404' deprecated: false x-microcks-operation: delay: 0 dispatcher: FALLBACK /analytics/engines/npo/v3/optimizations/{id}/status: get: tags: - Status summary: Factset Get Npo Optimization Status by Id description: "This is the endpoint to check on the progress of a previously requested optimization.\r\nIf the optimization has finished computing, the body of the response will contain result in JSON.\r\nOtherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage." operationId: getOptimizationStatusById parameters: - name: id in: path description: from url, provided from the location header in the Create and Run NPO optimization endpoint required: true schema: type: string description: from url, provided from the location header in the Create and Run NPO optimization endpoint responses: '201': description: Expected response once optimization is completed, returns 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 content: application/json: schema: $ref: '#/components/schemas/ObjectRoot_2' '202': description: Expected response returned if the optimization is not yet completed, should contain X-FactSet-Api-PickUp-Progress header. headers: X-FactSet-Api-PickUp-Progress: description: FactSet's progress header. schema: type: string description: FactSet's progress header. Cache-Control: description: Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. schema: type: integer description: Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. 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 identifier 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_2' '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: Optimization result was already returned, provided id was not a requested optimization, or the optimization was cancelled 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_2' '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/engines/pa/v3/calculations/{id}/status: get: tags: - Status summary: Factset Get Pa Calculation Status by Id description: "This is the endpoint to check on the progress of a previously requested calculation.\r\nIf the calculation has finished computing, the location header will point to the result url.\r\nOtherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage." operationId: getCalculationStatusById parameters: - name: id in: path description: from url, provided from the location header in the Create and Run PA calculation endpoint required: true schema: type: string description: from url, provided from the location header in the Create and Run PA calculation endpoint responses: '200': description: Expected response once calculation is completed. 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/CalculationStatusRoot' '202': description: Expected response returned if the calculation is not yet completed, should contain X-FactSet-Api-PickUp-Progress header. headers: X-FactSet-Api-PickUp-Progress: description: FactSet's progress header. schema: type: string description: FactSet's progress header. Cache-Control: description: Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. schema: type: integer description: Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. 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/CalculationStatusRoot' '400': description: Invalid identifier 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_3' '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: Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled 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_3' '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/engines/fpo/v3/optimizations/{id}/status: get: tags: - Status summary: Factset Get Fpo Optimization Status by Id description: "This is the endpoint to check on the progress of a previously requested optimization.\r\nIf the optimization has finished computing, the body of the response will contain result in JSON.\r\nOtherwise, the optimization is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage." operationId: getOptimizationStatusById parameters: - name: id in: path description: from url, provided from the location header in the Create and Run FPO optimization endpoint required: true schema: type: string description: from url, provided from the location header in the Create and Run FPO optimization endpoint responses: '201': description: Expected response once optimization is completed, returns 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 content: application/json: schema: $ref: '#/components/schemas/ObjectRoot_3' '202': description: Expected response returned if the optimization is not yet completed, should contain X-FactSet-Api-PickUp-Progress header. headers: X-FactSet-Api-PickUp-Progress: description: FactSet's progress header. schema: type: string description: FactSet's progress header. Cache-Control: description: Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. schema: type: integer description: Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. 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 identifier 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_4' '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: Optimization result was already returned, provided id was not a requested optimization, or the optimization was cancelled 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_4' '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 /runs/{id}/status: parameters: - schema: type: string example: '1013456' name: id in: path required: true description: run id get: summary: Factset Check the Status for a Particular Run Id tags: - Status responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/idStatus' examples: ADF (With Overrides): value: data: status: queued prbStatus: pending statusDescription: string inputs: jobName: my_adf_job jobType: ADF overrides: dates: start: '2023-12-25' end: '2023-12-27' frequency: daily calendar: sevenDay runAsSerialNumber: '894550' id: '34578' PA (With Overrides): value: data: status: executing prbStatus: running statusDescription: string inputs: jobName: my_pa_job jobType: PA overrides: tasks: - task_1 - task_2 runAsSerialNumber: '894550' id: '123456' PD (With Overrides): value: data: status: executing prbStatus: running statusDescription: string inputs: jobName: my_pd_job jobType: PD overrides: runAsSerialNumber: '894550' id: '78904' PI: value: data: status: queued prbStatus: pending statusDescription: string inputs: jobName: my_pi_job jobType: PI id: '78904' PUB (With Overrides): value: data: status: queued prbStatus: pending statusDescription: string inputs: jobName: my_pub_job jobType: PUB overrides: runAsOfDate: '2023-02-05' id: '3456789' Vault (No Overrides): value: data: inputs: jobName: my_vault_job jobType: vault status: created prbStatus: success statusDescription: job has completed with success id: '123456' Vault (With Overrides): value: data: inputs: jobName: my_vault_job jobType: vault overrides: combinations: - accounts: - CLIENT:/FPS/VAULTED_RETURNS/7DAYS_VLT.ACCT - CLIENT:/FPS/VAULTED_RETURNS/1MONTH.ACCT dates: - '2022-12-24' - '2022-12-23' runAsSerialNumber: '894550' status: created prbStatus: success statusDescription: job has completed with success id: '123456' headers: X-DataDirect-Request-Key: $ref: '#/components/headers/X-DataDirect-Request-Key' X-FactSet-Api-Request-Key: $ref: '#/components/headers/X-FactSet-Api-Request-Key' X-FactSet-Api-RateLimit-Limit: $ref: '#/components/headers/X-FactSet-Api-RateLimit-Limit' X-FactSet-Api-RateLimit-Remaining: $ref: '#/components/headers/X-FactSet-Api-RateLimit-Remaining' X-FactSet-Api-RateLimit-Reset: $ref: '#/components/headers/X-FactSet-Api-RateLimit-Reset' '401': description: Missing or invalid authentication. headers: X-DataDirect-Request-Key: $ref: '#/components/headers/X-DataDirect-Request-Key' X-FactSet-Api-Request-Key: $ref: '#/components/headers/X-FactSet-Api-Request-Key' '403': description: User is forbidden with current credentials headers: X-DataDirect-Request-Key: $ref: '#/components/headers/X-DataDirect-Request-Key' X-FactSet-Api-Request-Key: $ref: '#/components/headers/X-FactSet-Api-Request-Key' X-FactSet-Api-RateLimit-Limit: $ref: '#/components/headers/X-FactSet-Api-RateLimit-Limit' X-FactSet-Api-RateLimit-Remaining: $ref: '#/components/headers/X-FactSet-Api-RateLimit-Remaining' X-FactSet-Api-RateLimit-Reset: $ref: '#/components/headers/X-FactSet-Api-RateLimit-Reset' '429': description: Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. headers: X-DataDirect-Request-Key: $ref: '#/components/headers/X-DataDirect-Request-Key' X-FactSet-Api-Request-Key: $ref: '#/components/headers/X-FactSet-Api-Request-Key' Retry-After: description: Time to wait in seconds before making a new request as the rate limit has reached. schema: type: string '500': description: Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. headers: X-DataDirect-Request-Key: $ref: '#/components/headers/X-DataDirect-Request-Key' X-FactSet-Api-Request-Key: $ref: '#/components/headers/X-FactSet-Api-Request-Key' '503': description: Request timed out. Retry the request in sometime. headers: X-DataDirect-Request-Key: $ref: '#/components/headers/X-DataDirect-Request-Key' X-FactSet-Api-Request-Key: $ref: '#/components/headers/X-FactSet-Api-Request-Key' operationId: checkRunStatus parameters: [] description: Use this endpoint to check the status of a run using the id from the POST /runs endpoint x-microcks-operation: delay: 0 dispatcher: FALLBACK /batch/v1/status: get: tags: - Status summary: Factset Returns the Status for a Batch Request description: Return the status for the underlying batch request that is specified by the id. operationId: getBatchStatus parameters: - $ref: '#/components/parameters/batchId' responses: '201': description: Batch Request has been completed and the response has been created. headers: Location: description: Path to Batch Request result. schema: type: string example: batch/v1/result?id=2df43e85-ea0f-45c6-bf4a-2baf4d1eaa3c content: application/json: schema: $ref: '#/components/schemas/BatchStatusResponse' examples: Batch Status Done: $ref: '#/components/examples/BatchStatusDoneResponse' '202': description: Batch Request has not finished and the result has NOT been created. content: application/json: schema: $ref: '#/components/schemas/BatchStatusResponse' examples: Batch Status Queued: $ref: '#/components/examples/BatchStatusQueuedResponse' Batch Status Executing: $ref: '#/components/examples/BatchStatusExecutingResponse' Batch Status Failed: $ref: '#/components/examples/BatchStatusFailedResponse_2' '404': $ref: '#/components/responses/404' deprecated: false x-microcks-operation: delay: 0 dispatcher: FALLBACK post: tags: - Status summary: Factset Returns the Status for a Batch Request description: 'Return the status for the underlying batch request that is specified by the id. ' operationId: getBatchStatusWithPost requestBody: description: Batch Status Request Post Body content: application/json: schema: $ref: '#/components/schemas/BatchStatusRequest' examples: Batch Status Request: $ref: '#/components/examples/BatchStatusRequest' required: true responses: '201': description: Batch Request has been completed and the response has been created. headers: Location: description: Path to Batch Request result. schema: type: string example: batch/v1/result?id=2df43e85-ea0f-45c6-bf4a-2baf4d1eaa3c content: application/json: schema: $ref: '#/components/schemas/BatchStatusResponse' examples: Batch Status Done: $ref: '#/components/examples/BatchStatusDoneResponse' '202': description: Batch Request has not finished and the result has NOT been created. content: application/json: schema: $ref: '#/components/schemas/BatchStatusResponse' examples: Batch Status Queued: $ref: '#/components/examples/BatchStatusQueuedResponse' Batch Status Executing: $ref: '#/components/examples/BatchStatusExecutingResponse' Batch Status Failed: $ref: '#/components/examples/BatchStatusFailedResponse_2' '404': $ref: '#/components/responses/404' deprecated: false x-microcks-operation: delay: 0 dispatcher: FALLBACK /analytics/engines/pub/v3/calculations/{id}/status: get: tags: - Status summary: Factset Get Pub Calculation Status by Id description: "This is the endpoint to check on the progress of a previously requested calculation.\r\nIf the calculation has finished computing, the result field in the response body will point to the result url.\r\nOtherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage." operationId: getCalculationStatusById parameters: - name: id in: path description: from url, provided from the location header in the Create and Run Pub calculation endpoint required: true schema: type: string description: from url, provided from the location header in the Create and Run Pub calculation endpoint responses: '200': description: Expected response once calculation is completed. 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/CalculationStatusRoot_2' '202': description: Expected response returned if the calculation is not yet completed. headers: X-FactSet-Api-PickUp-Progress: description: FactSet's progress header. schema: type: string description: FactSet's progress header. Cache-Control: description: Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. schema: type: integer description: Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. 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/CalculationStatusRoot_2' '400': description: Invalid identifier 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_5' '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: Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled 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_5' '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 /calculations/{id}/status: get: tags: - Status summary: Factset Get Quant Engine Calculation Status by Id description: "This is the endpoint to check on the progress of a previously requested calculation.\r\nIf the calculation has finished computing, the location header will point to the result url.\r\nOtherwise, the calculation is still running and the X-FactSet-Api-PickUp-Progress header will contain a progress percentage." operationId: getCalculationStatusById parameters: - name: id in: path description: from url, provided from the location header in the Create and Run Quant Engine calculation endpoint required: true schema: type: string description: from url, provided from the location header in the Create and Run Quant Engine calculation endpoint responses: '200': description: Expected response once calculation is completed. 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/CalculationStatusRoot' '202': description: Expected response returned if the calculation is not yet completed, should contain X-FactSet-Api-PickUp-Progress header. headers: X-FactSet-Api-PickUp-Progress: description: FactSet's progress header. schema: type: string description: FactSet's progress header. Cache-Control: description: Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. schema: type: integer description: Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. 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/CalculationStatusRoot' '400': description: Invalid identifier 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_6' '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: Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled 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_6' '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/status/get: get: tags: - Status operationId: get/notation/status/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: true x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false description: Intraday trading status of a notation.
The endpoint is subscribable to provide push updates. See attribute `_subscriptionMinimalInterval` for valid update rates. summary: Factset Intraday Trading Status of a Notation. parameters: - name: identifier in: query schema: type: string pattern: ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: quality in: query schema: type: string description: Quality of the trading status. The trading status and related data for a notation cannot be retrieved in end-of-day quality (EOD). default: DLY x-enum-description: - 'Real-time: trading status with minimal technical processing delays.' - 'Delayed: trading status with an exchange-imposed delay of usually 15 to 30 minutes.' - 'Best: choose the trading status quality with the least delay, as entitled for the client.' enum: - RLT - DLY - BST required: false - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. - description: Minimum number of milliseconds at which updates are sent. name: _subscriptionMinimumInterval in: query schema: type: number format: int32 default: 5000 x-enum-description: - 1 second - 5 seconds - 10 seconds - 30 seconds - 60 seconds - 300 seconds enum: - 1000 - 5000 - 10000 - 30000 - 60000 - 300000 responses: '200': $ref: '#/components/responses/GetNotationStatusGet200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /analytics/engines/spar/v3/calculations/{id}/status: get: tags: - Status summary: Factset Get Spar Calculation Status by Id description: "This is the endpoint to check on the progress of a previously requested calculation.\r\nIf the calculation has finished computing, the location header will point to the result url." operationId: getCalculationStatusById parameters: - name: id in: path description: from url, provided from the location header in the Create and Run SPAR calculation endpoint required: true schema: type: string description: from url, provided from the location header in the Create and Run SPAR calculation endpoint responses: '200': description: Expected response once calculation is completed. 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/CalculationStatusRoot' '202': description: Expected response returned if the calculation is not yet completed. headers: X-FactSet-Api-PickUp-Progress: description: FactSet's progress header. schema: type: string description: FactSet's progress header. Cache-Control: description: Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. schema: type: integer description: Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. 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/CalculationStatusRoot' '400': description: Invalid identifier 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_7' '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: Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled 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_7' '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 /streetaccount/historical/check-status: get: tags: - Status summary: Factset Returns the Status and Percentage of Completion for the Requested Jobid description: Need to plug-in the jobID from /request-files into /check-status endpoint parameters: - name: jobID in: query description: jobID returned by the request-files endpoint to know the status and percentDone required: true schema: type: string - name: _paginationLimit in: query description: Specifies the maximum number of results to return per result required: false schema: type: integer - name: _paginationOffset in: query description: Specifies the starting point for pagination. This parameter is used to identify the beginning of next set of results required: false schema: type: integer responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/checkstatusResponse' examples: default200ResponseExample: $ref: '#/components/examples/200CheckStatusExample' '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/StreetAccountStatus' examples: default400ResponseExample: $ref: '#/components/examples/StreetAccountExample' '401': description: Bad request content: application/json: schema: $ref: '#/components/schemas/StreetAccountStatus' examples: default400ResponseExample: $ref: '#/components/examples/StreetAccount401Example' '403': description: Bad request content: application/json: schema: $ref: '#/components/schemas/StreetAccountStatus' examples: default400ResponseExample: $ref: '#/components/examples/StreetAccount403Example' '500': description: Bad request content: application/json: schema: $ref: '#/components/schemas/StreetAccountStatus' examples: default400ResponseExample: $ref: '#/components/examples/StreetAccount500Example' x-microcks-operation: delay: 0 dispatcher: FALLBACK /level1/files/status: get: tags: - Status summary: Factset Returns the Status of the Id operationId: getLevel1FileStatus description: Need to plug-in the id get from /create endpoint into /status endpoint parameters: - $ref: '#/components/parameters/requestIdStatus' responses: '201': description: ' The Request has been created and the response has been created. ' content: application/json: schema: $ref: '#/components/schemas/completedResponse' examples: default200ResponseExample: $ref: '#/components/examples/sampleCompletedResponse' headers: Location: description: Relative location to pick up results. schema: type: string example: get?id=2df43e85-ea0f-45c6-bf4a-2baf4d1eaa3c '202': description: 'The Request has not finished and the result has NOT been created. ' content: application/json: schema: $ref: '#/components/schemas/submittedResponse' examples: QueuedExample: $ref: '#/components/examples/sampleFilesResponseQueued' ExecutingExample: $ref: '#/components/examples/sampleFilesResponseExecuting' FailedExample: $ref: '#/components/examples/sampleFilesResponseFailed' CancelledExample: $ref: '#/components/examples/sampleFilesResponseCancelled' headers: Location: description: Relative location to poll for status. schema: type: string '401': description: Unauthenticated USERNAME-SERIAL. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For more help, select the Report Issue in the top right corner of this Developer Portal specification card and choose Connectivity 401 or 403 Responses. content: application/json: schema: $ref: '#/components/schemas/status_2' examples: default400ResponseExample: $ref: '#/components/examples/401Example' '403': description: The USERNAME-SERIAL attempted to request the endpoint is not authorized to access. The request was a legal request, but the server is refusing to respond. Please reach out to FactSet Account Team for assistance with authorization. content: application/json: schema: $ref: '#/components/schemas/status_2' examples: default400ResponseExample: $ref: '#/components/examples/403Example' '404': description: id not found content: application/json: schema: $ref: '#/components/schemas/status_2' examples: default400ResponseExample: $ref: '#/components/examples/404Example' '500': description: Internal Error content: application/json: schema: $ref: '#/components/schemas/status_2' examples: default400ResponseExample: $ref: '#/components/examples/500Example' x-microcks-operation: delay: 0 dispatcher: FALLBACK /level1/files/minute-bars/status: get: tags: - Status summary: Factset Returns the Status of the Id operationId: getMinutebarsFileStatus description: Need to plug-in the id get from /create endpoint into /status endpoint parameters: - $ref: '#/components/parameters/requestIdStatus' responses: '201': description: ' The Request has been created and the response has been created. ' content: application/json: schema: $ref: '#/components/schemas/completedResponse' examples: default200ResponseExample: $ref: '#/components/examples/sampleCompletedResponse' headers: Location: description: Relative location to pick up results. schema: type: string example: get?id=2df43e85-ea0f-45c6-bf4a-2baf4d1eaa3c '202': description: 'The Request has not finished and the result has NOT been created. ' content: application/json: schema: $ref: '#/components/schemas/submittedResponse' examples: QueuedExample: $ref: '#/components/examples/sampleFilesResponseQueued' ExecutingExample: $ref: '#/components/examples/sampleFilesResponseExecuting' FailedExample: $ref: '#/components/examples/sampleFilesResponseFailed' CancelledExample: $ref: '#/components/examples/sampleFilesResponseCancelled' headers: Location: description: Relative location to poll for status. schema: type: string '401': description: Unauthenticated USERNAME-SERIAL. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For more help, select the Report Issue in the top right corner of this Developer Portal specification card and choose Connectivity 401 or 403 Responses. content: application/json: schema: $ref: '#/components/schemas/status_2' examples: default400ResponseExample: $ref: '#/components/examples/401Example' '403': description: The USERNAME-SERIAL attempted to request the endpoint is not authorized to access. The request was a legal request, but the server is refusing to respond. Please reach out to FactSet Account Team for assistance with authorization. content: application/json: schema: $ref: '#/components/schemas/status_2' examples: default400ResponseExample: $ref: '#/components/examples/403Example' '404': description: id not found content: application/json: schema: $ref: '#/components/schemas/status_2' examples: default400ResponseExample: $ref: '#/components/examples/404Example' '500': description: Internal Error content: application/json: schema: $ref: '#/components/schemas/status_2' examples: default400ResponseExample: $ref: '#/components/examples/500Example' x-microcks-operation: delay: 0 dispatcher: FALLBACK /level2/files/status: get: tags: - Status summary: Factset Returns the Status of the Id operationId: getLevel2FileStatus description: Need to plug-in the id get from /create endpoint into /status endpoint parameters: - $ref: '#/components/parameters/requestIdStatus' responses: '201': description: 'The Request has been created and the response has been created. ' content: application/json: schema: $ref: '#/components/schemas/completedResponse' examples: default200ResponseExample: $ref: '#/components/examples/sampleCompletedResponse' headers: Location: description: Relative location to pick up results schema: type: string example: get?id=2df43e85-ea0f-45c6-bf4a-2baf4d1eaa3c '202': description: 'The Request has not finished and the result has NOT been created. ' content: application/json: schema: $ref: '#/components/schemas/submittedResponse' examples: QueuedExample: $ref: '#/components/examples/sampleFilesResponseQueued' ExecutingExample: $ref: '#/components/examples/sampleFilesResponseExecuting' FailedExample: $ref: '#/components/examples/sampleFilesResponseFailed' CancelledExample: $ref: '#/components/examples/sampleFilesResponseCancelled' headers: Location: description: Relative location to poll for status. schema: type: string '401': description: Unauthenticated USERNAME-SERIAL. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For more help, select the Report Issue in the top right corner of this Developer Portal specification card and choose Connectivity 401 or 403 Responses. content: application/json: schema: $ref: '#/components/schemas/status_2' examples: default400ResponseExample: $ref: '#/components/examples/401Example' '403': description: The USERNAME-SERIAL attempted to request the endpoint is not authorized to access. The request was a legal request, but the server is refusing to respond. Please reach out to FactSet Account Team for assistance with authorization. content: application/json: schema: $ref: '#/components/schemas/status_2' examples: default400ResponseExample: $ref: '#/components/examples/403Example' '404': description: id not found content: application/json: schema: $ref: '#/components/schemas/status_2' examples: default400ResponseExample: $ref: '#/components/examples/404Example' '500': description: Internal Error content: application/json: schema: $ref: '#/components/schemas/status_2' examples: default400ResponseExample: $ref: '#/components/examples/500Example' x-microcks-operation: delay: 0 dispatcher: FALLBACK /v2/job/{id}/status: get: description: Polls the job with a given screen ID and returns job status operationId: PollCalculate parameters: - $ref: '#/components/parameters/ScreenCalcID' responses: '201': $ref: '#/components/responses/CalculateSuccessResponse' '202': $ref: '#/components/responses/CalculateInProgressResponse' '401': $ref: '#/components/responses/Error401Response' '404': $ref: '#/components/responses/Error404Response' '410': $ref: '#/components/responses/Error410Response' '500': $ref: '#/components/responses/Generic500ErrorResponse' tags: - Status x-microcks-operation: delay: 0 dispatcher: FALLBACK /analytics/engines/vault/v3/calculations/{id}/status: get: tags: - Status summary: Factset Get Vault Calculation Status by Id description: "This is the endpoint to check on the progress of a previously requested calculation.\r\nIf the calculation has finished computing, the location header will point to the result url." operationId: getCalculationStatusById parameters: - name: id in: path description: from url, provided from the location header in the Create and Run Vault calculation endpoint required: true schema: type: string description: from url, provided from the location header in the Create and Run Vault calculation endpoint responses: '200': description: Expected response once calculation is completed. 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/CalculationStatusRoot' '202': description: Expected response returned if the calculation is not yet completed. headers: X-FactSet-Api-PickUp-Progress: description: FactSet's progress header. schema: type: string description: FactSet's progress header. Cache-Control: description: Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. schema: type: integer description: Standard HTTP header. Header will specify max-age in seconds. Polling can be adjusted based on the max-age value. 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/CalculationStatusRoot' '400': description: Invalid identifier 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_8' '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: Calculation was already returned, provided id was not a requested calculation, or the calculation was cancelled 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_8' '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 components: parameters: ScreenCalcID: description: Unique identifier for a screen calculation job in: path name: id required: true schema: type: string ids: name: ids in: query schema: type: array items: type: string minItems: 1 maxItems: 1000 required: true explode: false description: 'The requested fund identifier. FactSet Identifiers, tickers, CUSIP, SEDOL, and ISIN are accepted inputs.

***ids limit** = 1000 per request*

*

Make note, GET Method URL request lines are also limited to a total length of 8192 bytes (8KB). In cases where the service allows for thousands of ids, which may lead to exceeding this request line limit of 8KB, its advised for any requests with large request lines to be requested through the respective "POST" method.

* ' examples: oneId: summary: One Market Identifier value: - MABAX-US multipleIds: summary: Multiple Market Identifiers value: - MABAX-US - FCNTX-US requestIdStatus: name: id in: query description: id returned by files create endpoint to poll and collect status of the query required: true schema: type: string batchId: name: id in: query description: Batch Request identifier. schema: type: string format: uuid required: true allowEmptyValue: false examples: sampleFilesResponseExecuting: summary: Status Executing value: data: id: 27b4923f-86dd-4b8b-89ac-dfc3a26fa786 status: executing error: null 401Example: summary: sample error response value: errors: - code: Not Authenticated title: USERNAME-SERIAL does not have permission id: 7af3d86ca5954503b9244f2620fcf5eb sampleFilesResponseFailed: summary: Status Failed value: data: id: 27b4923f-86dd-4b8b-89ac-dfc3a26fa786 status: failed error: id: 2df43e85-ea0f-45c6-bf4a-2baf4d1eaa3c code: Geeneric Error title: 'Not a valid request ' sampleFilesResponseCancelled: summary: Status Cancelled value: data: id: 27b4923f-86dd-4b8b-89ac-dfc3a26fa786 status: cancelled error: id: 2df43e85-ea0f-45c6-bf4a-2baf4d1eaa3c code: Error title: Request taking long time unsupportedMediaType: summary: Unsupported Media Type description: This bad request occurs when the media type passed in the request is not supported. Currently the APIs only support 'application/json'. value: status: Unsupported Media Type timestamp: '2019-11-05 09:42:27.237' path: /factset-funds/v1/{endpoint} message: text/html media type is not supported. Supported media types are application/json subErrors: null BatchStatusFailedResponse: description: Batch Status Failed Response value: data: id: 2df43e85-ea0f-45c6-bf4a-2baf4d1eaa3c status: failed startTime: '2021-06-29T18:34:52.168Z' endTime: '2021-06-29T18:34:55.402Z' error: id: 2df43e85-ea0f-45c6-bf4a-2baf4d1eaa3c code: GenericError title: the date parameter must be in YYYY-MM-DD format badRequestReadTimeout: summary: Bad Request - Read Timeout description: This error may be returned if it takes more than 29 seconds to hear back from the data fetch service. value: status: Bad Request timestamp: '2019-11-04 16:18:38.949' path: /factset-funds/v1/{endpoint} message: The request took too long. Try again with a smaller request. subErrors: null StreetAccount403Example: summary: Sample error Response value: id: 0ad3e09c-d8a2-4223-a1a3-0244d1247351 error_message: USERNAME-SERIAL does not have permission BatchStatusExecutingResponse: description: Batch Status Executing Response value: data: id: 2df43e85-ea0f-45c6-bf4a-2baf4d1eaa3c status: EXECUTING startTime: '2021-06-29T18:34:52.168Z' endTime: null error: null notWritable: summary: Internal Server Error - Not Writable description: This error may be returned when the server encounters an error writing the JSON response. value: status: Internal Server Error timestamp: '2019-11-05 09:48:29.18' path: /factset-funds/v1/{endpoint} message: Error writing JSON output subErrors: null 403Example: summary: sample error response value: errors: - code: Forbidden title: USERNAME-SERIAL does not have permission id: 7af3d86ca5954503b9244f2620fcf5eb StreetAccountExample: summary: Sample error Response value: id: 0ad3e09c-d8a2-4223-a1a3-0244d1247351 error_message: parameterError:Missing required parameter jobID 200CheckStatusExample: summary: Sample Response value: data: - product: SA jobID: 9ffa3ffb-0ed3-40a0-a98f-8ed7da0a8ad5 status: completed percentDone: 100 startDate: '2021-11-21T00:00:00Z' endDate: '2021-11-28T00:00:00Z' part: 1 meta: pagination: total: 105 isEstimatedTotal: false limit: 200 offset: 105 partial: isPartial: false generalException: summary: Internal Server Error - General Exception description: This is the most general error that can be returned to by the service. Please `Report Issue` to FactSet. value: status: Internal Server Error timestamp: '2019-11-01 10:36:01.944' path: /factset-funds/v1/{endpoint} message: Unexpected error subErrors: null StreetAccount500Example: summary: Sample error Response value: id: 0ad3e09c-d8a2-4223-a1a3-0244d1247351 error_message: An unexpected error happened sampleCompletedResponse: summary: Status Done value: data: id: 27b4923f-86dd-4b8b-89ac-dfc3a26fa786 status: created error: null badRequestFutureDate: summary: Bad Request - Future Date description: This error message occurs when a future date is requested in the startDate and endDate parameters. Please revise your request to include dates as of today's current date or any prior historical date. value: status: Bad Request timestamp: '2020-06-12 15:52:48.091' path: /factset-funds/v1/{endpoint} message: The use of future dates is not applicable in this endpoint. Please revise your request to include dates up to today's current date. subErrors: null forbidden: summary: Forbidden description: The USERNAME-SERIAL attempted to request the endpoint is not authorized to access. The request was a legal request, but the server is refusing to respond. Please reach out to FactSet Account Team for assistance with authorization. value: status: Forbidden timestamp: '2020-06-12 16:08:51.731' path: /factset-funds/v1/{endpoint} message: USERNAME-SERIAL does not have permission to use /factset-funds /v1/{endpoint} subErrors: null badRequestMalformedJSON: summary: Bad Request - Malformed JSON Request description: This error may be returned when the request body is specified as JSON, but is not in proper JSON format. value: status: Bad Request timestamp: '2019-11-05 09:48:29.18' path: /factset-funds/v1/{endpoint} message: Malformed JSON Request subErrors: null batchNotFound: summary: Not Found description: The requested item was not found. value: errors: - id: adb01824-252f-4420-b0c6 code: Not Found links: about: /factset-global-prices/v1 title: The Batch Request was not found. It has probably expired. BatchStatusQueuedResponse: description: Batch Status Queued Response value: data: id: 2df43e85-ea0f-45c6-bf4a-2baf4d1eaa3c status: QUEUED startTime: '2021-06-29T18:34:52.168Z' endTime: null error: null 500Example: summary: sample error response value: errors: - code: Internal server error title: An unexpected error happened id: 7af3d86ca5954503b9244f2620fcf5eb BatchStatusQueuedResponse_2: description: Batch Status Queued Response value: data: id: 2df43e85-ea0f-45c6-bf4a-2baf4d1eaa3c status: queued startTime: '2021-06-29T18:34:52.168Z' endTime: null error: null badRequestInvalidParameters: summary: Bad Request - Invalid Parameters description: This error message occurs when a request parameter is used in which is not recognized by the service. Please revise your request to include only the parameters listed in the specification. Typical causes are spelling mistakes and use of improper casing. value: status: Bad Request timestamp: '2020-06-12 15:58:54.068' path: /factset-funds/v1/{endpoint} message: 'Invalid Parameter (s): fakeParameterName1 fakeParameterName2. Please modify your request to use parameters outlined in the specification for this endpoint.' subErrors: null BatchStatusFailedResponseOther: description: Batch Status Failed Response - Other. The example response shows the result of checking the status of a batch request that failed unexpectedly. If you encounter this error, please contact FactSet support. value: data: id: 43839790-a64e-452a-b8f0-fc26117bd9f4 status: FAILED startTime: '2023-09-20T13:37:13.653411' endTime: '2023-09-20T13:38:25.841134' error: Something went wrong. Contact FactSet for support. badRequestDateFormat: summary: Bad Request - Date Format description: This bad request occurs when a request doesn't use the YYYY-MM-DD in the date parameters. To resolve, convert your date to YYYY-MM-DD. value: status: Bad Request timestamp: '2019-10-31 16:08:07.945' path: /factset-funds/v1/{endpoint} message: 'The date parameter ''startDate'' must be in the following date format: YYYY-MM-DD' subErrors: null BatchStatusRequest: description: Batch Status Request value: id: 2df43e85-ea0f-45c6-bf4a-2baf4d1eaa3c notFound: summary: Not Found description: The requested item was not found. value: status: Not Found timestamp: '2020-06-12T16:08:51.731Z' path: /batch/v1/status message: The Batch Request was not found. It has probably expired. subErrors: null StatusPollResponseAcceptedExample: value: data: conversationId: 9c1031c2-5463-47ae-81b3-126a68f0c2a6 status: executing 403ForbiddenErrorExample: value: 'Client does not have the required CACCESS: {00QAI}, Request key: 65CA96B3129489A6' BatchStatusFailedResponseMemoryLimit: description: Batch Status Failed Response - MemoryLimit. The example response shows the result of checking the status of a batch request that exceeded the memory limit. value: data: id: 0a0452e2-3937-441d-b376-f2733a938587 status: FAILED startTime: '2023-09-15T00:07:46.501947' endTime: '2023-09-15T00:08:53.936218' error: The request size is too large. Try again with a smaller request. BatchStatusFailedResponse_2: description: Batch Status Failed Response value: data: id: 2df43e85-ea0f-45c6-bf4a-2baf4d1eaa3c status: FAILED startTime: '2021-06-29T18:34:52.168Z' endTime: '2021-06-29T18:34:55.402Z' error: Invalid format for startDate 401UnauthorizedErrorExample: value: Authentication Failed ChatPollingRequestExample: value: data: conversationId: 9c1031c2-5463-47ae-81b3-126a68f0c2a6 BatchStatusDoneResponse: description: Batch Status Done Response value: data: id: 2df43e85-ea0f-45c6-bf4a-2baf4d1eaa3c status: DONE startTime: '2021-06-29T18:34:52.168Z' endTime: '2021-06-29T18:34:55.402Z' error: null StreetAccount401Example: summary: Sample error Response value: id: 0ad3e09c-d8a2-4223-a1a3-0244d1247351 error_message: USERNAME-SERIAL does not have permission 404Example: summary: sample error response value: errors: - code: Not Found title: id not found id: 7af3d86ca5954503b9244f2620fcf5eb sampleFilesResponseQueued: summary: Status Queued value: data: id: 27b4923f-86dd-4b8b-89ac-dfc3a26fa786 status: queued error: null BatchStatusFailedResponseTimeout: description: Batch Status Failed Response - Timeout. The example response shows the result of checking the status of a batch request that took longer than 20 minutes to calculate and timed out. value: data: id: 2df43e85-ea0f-45c6-bf4a-2baf4d1eaa3c status: FAILED startTime: '2021-06-29T18:34:52.168Z' endTime: '2021-06-29T18:44:55.402Z' error: timeout StatusPollResponseCreatedExample: value: data: conversationId: 9c1031c2-5463-47ae-81b3-126a68f0c2a6 status: created RateLimitExceededErrorExample: value: message: API rate limit exceeded unauthenticated: summary: User Authentication Failed description: This occurs when a user is not properly authenticated or recognized by the service. Please double check the USERNAME-SERIAL and API-Key used to request and ensure you are within the IP range specified for the Key. Report Issue under 401 error for help with troubleshooting. value: status: User Authentication Failed timestamp: '2019-10-31 16:08:07.945' path: /factset-funds/v1/{endpoint} message: User Authentication Failed. subErrors: null BatchStatusDoneResponse_2: description: Batch Status Done Response value: data: id: 2df43e85-ea0f-45c6-bf4a-2baf4d1eaa3c status: created startTime: '2021-06-29T18:34:52.168Z' endTime: '2021-06-29T18:34:55.402Z' error: null BatchStatusExecutingResponse_2: description: Batch Status Executing Response value: data: id: 2df43e85-ea0f-45c6-bf4a-2baf4d1eaa3c status: executing startTime: '2021-06-29T18:34:52.168Z' endTime: null error: null badRequestRequiredParameter: summary: Bad Request - Required Parameter Missing description: This error message occurs when the request does not include the required parameters. Required parameters are indicated with a red asterisks symbol in the specification file. value: status: Bad Request timestamp: '2020-06-12 15:48:42.016' path: /factset-funds/v1/{endpoint} message: The parameter 'ids' is required and may not be empty. subErrors: null schemas: ids: type: array items: type: string minItems: 1 maxItems: 1000 description: 'The requested Fund Identifier. FactSet Identifiers, tickers, CUSIP and SEDOL are accepted input.

***ids limit** = 1000 per request*

*

Make note, GET Method URL request lines are also limited to a total length of 8192 bytes (8KB). In cases where the service allows for thousands of ids, which may lead to exceeding this request line limit of 8KB, its advised for any requests with large request lines to be requested through the respective "POST" method.

* ' example: - MABAX - FCNTX status_2: type: object description: specifies the error message fields in the response properties: errors: type: array description: An array containing errors items: $ref: '#/components/schemas/errorExample' example: [] ResourceStatusResponse: description: ResourceStatusResponse contains information regarding the status of a calculation job properties: data: properties: error: $ref: '#/components/schemas/ErrorObject_3' id: description: ID of the submitted calculation job type: string status: description: Current status of the calculation job type: string type: object example: example_value type: object BatchStatus: title: Batch Status type: object properties: id: type: string format: uuid description: the id of batch request. example: abc123 startTime: type: string nullable: true format: date-time description: Time when the batch request is started. This is in Eastern Time Zone. The date-time format is expressed as [YYYY-MM-DD]T[HH:MM:SSS], following ISO 8601. example: '2026-01-15T10:30:00Z' endTime: type: string nullable: true format: date-time description: Time when the batch request is ended. This is in Eastern Time Zone. The date-time format is expressed as [YYYY-MM-DD]T[HH:MM:SSS], following ISO 8601. example: '2026-01-15T10:30:00Z' status: type: string enum: - QUEUED - EXECUTING - DONE - FAILED example: QUEUED error: type: string nullable: true example: The parameter 'formulas' is required and may not be empty. description: Error message. errorExample: type: object description: Specifies the fields in the error message properties: code: description: It specifies the unique code type: string example: example_value title: description: ' Specifies the error message' type: string example: Example Title id: description: Specifies the id type: string example: abc123 isPartialOne: title: IsPartialItems description: If the value is true, it indicates additional results are available. False represents that this is the last set of results for this request. type: object properties: isPartial: type: boolean example: true CalculationStatus_2: type: object properties: calculationid: type: string example: '500123' status: enum: - Queued - Executing - Completed - Cancelled type: string example: Queued units: type: object additionalProperties: $ref: '#/components/schemas/CalculationUnitStatus_2' description: Number of calculation units in batch. example: example_value ErrorArray: description: An array of errors properties: errors: items: $ref: '#/components/schemas/ErrorObject_3' type: array description: Array of Error Objects example: [] type: object StatusOne: type: object description: request-files properties: id: description: a unique identification for the query requested type: string example: abc123 status: description: The status of the query type: string enum: - queued - executing - created - failed - cancelled example: queued error: $ref: '#/components/schemas/ErrorObject_2' ClientErrorResponse_8: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error_9' nullable: true example: [] ClientErrorResponse_7: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error_8' nullable: true example: [] ErrorObject_3: properties: code: $ref: '#/components/schemas/ErrorCode' id: description: A unique ID for the occurrence of the error. It is advised to log this code and include it if you contact FactSet support desk. type: string example: abc123 source: $ref: '#/components/schemas/ErrorObjectSource' title: description: a description of the error type: string example: Example Title type: object description: Associated Error Objects checkstatusResponse: type: object properties: data: type: array items: $ref: '#/components/schemas/checkstatus' example: [] meta: $ref: '#/components/schemas/metaOne' BatchStatusRequest: title: Batch Status Request type: object required: - id properties: id: type: string format: uuid example: 2df43e85-ea0f-45c6-bf4a-2baf4d1eaa3c description: Batch Request identifier. checkFiles: type: object description: check-files properties: id: description: a unique identification for the query requested type: string example: abc123 status: description: The status of the query type: string enum: - queued - executing - created - failed - cancelled example: queued error: $ref: '#/components/schemas/ErrorObject_2' calendar: default: fiveDay description: Used for ADF jobs only enum: - fiveDay - sevenDay example: fiveDay title: calendar type: string ObjectRoot_3: type: object properties: data: type: object example: example_value Error_2: type: object properties: id: type: string example: abc123 detail: type: string example: example_value source: $ref: '#/components/schemas/ErrorSource' CalculationStatusMeta: type: object properties: units: type: object additionalProperties: $ref: '#/components/schemas/CalculationUnitStatusMeta' description: Meta of calculation units in batch. nullable: true example: example_value statusesResponse: type: object title: Statuses Response properties: data: description: Array of Statuses Objects type: array items: $ref: '#/components/schemas/statuses' example: [] 401UnauthorizedError: description: Error response for a user without authentication to use the API. type: string 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 ClientErrorResponse: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error_2' example: [] ClientErrorResponse_4: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error_5' example: [] BatchDataRequest: title: Batch Data Request type: object required: - data properties: data: type: object properties: id: type: string format: uuid example: 2df43e85-ea0f-45c6-bf4a-2baf4d1eaa3c description: Batch Request identifier. example: example_value error_detail: title: Error Object description: '`Error Object` is the response returned for an unsuccessful request. ' type: object properties: id: description: Unique identifier for the request. Also known as the chain id. type: string example: 5EFCCA8940CAEA6B nullable: true code: description: Textual error code type: string example: notAuthenticated nullable: true title: description: A short, human-readable summary of the problem type: string example: There were either no, invalid, or expired credentials present in the request. nullable: true timestamp: description: timestamp in YYYY-MM-DD HH:MM:SS.SSS type: string format: date-time example: '2020-08-01 11:09:41.918' nullable: true ClientErrorResponse_3: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error_4' nullable: true example: [] BatchStatusResponse: title: Batch Status Response type: object properties: data: $ref: '#/components/schemas/BatchStatus' statusDescription: description: Further details on the job's status example: job has completed with success title: statusDescription type: string maxLength: 500 ErrorCode: description: Factset API specific error codes enum: - notAuthenticated - notAuthorized - notFound - endpointNotFound - parameterError - genericServerError - resourceGone - quantityLimitsExceeded - universal_screening_parameterError - universal_screening_parameterWarning type: string frequency: default: daily description: Used for ADF job types only. Will determine the frequency between the start and end dates. enum: - daily - monthly - weekly type: string Error_7: type: object properties: id: type: string nullable: true example: abc123 code: type: string nullable: true example: example_value title: type: string nullable: true example: Example Title detail: type: string nullable: true example: example_value source: $ref: '#/components/schemas/ErrorSource_3' StreetAccountStatus: title: Response Status of SA type: object properties: id: type: string example: abc123 error_message: description: Textual error message type: string example: example_value Error_8: type: object properties: id: type: string nullable: true example: abc123 code: type: string nullable: true example: example_value title: type: string nullable: true example: Example Title detail: type: string nullable: true example: example_value source: $ref: '#/components/schemas/ErrorSource_4' ErrorSource_5: type: object properties: pointer: type: string nullable: true example: example_value parameter: type: string nullable: true example: example_value submittedResponse: type: object title: Status Response description: Returns Status of the id. properties: data: $ref: '#/components/schemas/StatusOne' CalculationUnitStatusMeta: type: object properties: info: type: string description: The Info URL of the calculation. nullable: true example: example_value completedResponse: type: object title: status description: Returns status. properties: data: $ref: '#/components/schemas/checkFiles' statusesRequest: title: Statuses Request Body description: Classifications Request Body type: object properties: ids: $ref: '#/components/schemas/ids' required: - ids ChatPollingRequest: description: Request body containing the chat conversation ID type: object properties: data: type: object properties: conversationId: type: string format: uuid ClientErrorResponse_2: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error_3' example: [] jobOverridesCombinationsRoot: description: Used for Vault job type only. This creates a matrix of given accounts and dates. When the job is run, it will only run for the accounts and dates within this object. (Settings will only be used temporarily and no changes will be made to the default PRB job.) properties: accounts: description: An array of accounts items: type: string type: array example: [] dates: description: An array of dates items: format: date type: string type: array example: [] type: object CalculationStatus: type: object properties: calculationid: type: string description: Calculation's identifier nullable: true example: '500123' status: enum: - Queued - Executing - Completed - Cancelled type: string description: Calculation's status example: Queued units: type: object additionalProperties: $ref: '#/components/schemas/CalculationUnitStatus' description: Number of calculation units in batch. nullable: true example: example_value Error_3: type: object properties: id: type: string example: abc123 detail: type: string example: example_value source: $ref: '#/components/schemas/ErrorSource' ErrorSource_3: type: object properties: pointer: type: string nullable: true example: example_value parameter: type: string nullable: true example: example_value checkstatus: type: object properties: product: description: Defines the name of the product type: string example: example_value jobID: description: Unique id to get the xml files for the requested date type: string example: '500123' status: description: Returns any of the 2 results Submitted ->Running->Completed and Failed type: string example: example_value percentDone: description: Returns how much percentage of task is completed for the requested jobID type: integer example: 10 startDate: description: The date from which the data is required in YYYY-MM-DDTHH:MM:SSZ format type: string format: date example: '2026-01-15' endDate: description: The date until which the data is fetched in YYYY-MM-DDTHH:MM:SSZ format type: string format: date example: '2026-01-15' part: description: Returns the part number of the jobID type: integer example: 10 statuses: title: Statuses Object type: object properties: fsymId: description: FactSet Security Identifier. Six alpha-numeric characters, excluding vowels, with a -S suffix (XXXXXX-S), resolved from the requestId of the Fund requested. type: string example: FNK7XP-S x-fds-fql-formula: FSYM_SECURITY_PERM_ID('SECURITY') nullable: true activeFlag: description: Binary flag to indicate whether the fund is currently active, where 1 is active and 0 is inactive. type: integer example: 1 x-fds-fql-formula: FFD_ACTIVE nullable: true shrClassActiveFlag: description: Returns a binary indicator of whether the specified share class is currently active, where 1 is active and 0 is inactive. type: integer example: 1 x-fds-fql-formula: FFD_SHR_CLS_ACTIVE nullable: true isonFFD: description: Returns a binary indicator of whether the specified fund is available in the FactSet Funds Database (FFD). type: integer example: 1 x-fds-fql-formula: ISON_FFD nullable: true requestId: description: The requested Id sent as input. type: string example: MABAX Error: description: Wrapper containing metadata and appropriate errors as thrown by the API type: object properties: errors: type: array items: $ref: '#/components/schemas/ErrorObject' ObjectRoot_2: required: - data type: object properties: data: type: object example: example_value batchErrorResponse: type: object nullable: true title: Error Response description: Error Default Response properties: errors: type: array nullable: true description: An array containing errors items: $ref: '#/components/schemas/batchErrorObject' example: [] status: description: The status of the job as per FactSets API standards enum: - cancelled - created - executing - failed - queued example: queued title: status type: string ErrorSource_2: type: object properties: pointer: type: string nullable: true example: example_value parameter: type: string nullable: true example: example_value ErrorObjectSource: properties: parameter: type: string example: example_value description: For errors and warnings found in screens, contains the paramID the error/warning belongs to type: object ErrorSource: type: object properties: pointer: type: string example: example_value parameter: type: string example: example_value StatusPollResponse: description: Response from `/status` containing the chat ID and status of chat processing type: object properties: data: type: object properties: conversationId: type: string format: uuid status: type: string enum: - executing - created ErrorSource_4: type: object properties: pointer: type: string nullable: true example: example_value parameter: type: string nullable: true example: example_value CalculationStatusRoot: required: - data type: object properties: data: $ref: '#/components/schemas/CalculationStatus' meta: $ref: '#/components/schemas/CalculationStatusMeta' startJob: description: Details required to start a job example: jobName: my_pa_job overrides: runAsSerialNumber: '123456' tasks: - my_task_1 jobType: PA properties: jobName: description: The name of the PRB job type: string example: example_value overrides: $ref: '#/components/schemas/jobOverrides' jobType: $ref: '#/components/schemas/jobTypes' required: - jobName - jobType title: startJob type: object Error_9: type: object properties: id: type: string nullable: true example: abc123 code: type: string nullable: true example: example_value title: type: string nullable: true example: Example Title detail: type: string nullable: true example: example_value source: $ref: '#/components/schemas/ErrorSource_5' batchErrorObject: type: object nullable: true properties: id: description: A UUID for this particular occurrence of the problem. type: string nullable: true example: adb01824-252f-4420-b0c6-35a1e3507ef5 code: description: status type: string nullable: true example: GenericError links: description: The Endpoint path {package}/version/{endpoint} type: object properties: about: description: details. type: string example: /factset-global-prices/v1/{endpoint} example: example_value title: description: The plain text error message type: string nullable: true example: Validation Error CalculationUnitStatus_2: type: object properties: status: enum: - Queued - Executing - Success - Failed - Cancelled type: string description: The status of calculation unit. example: Queued errors: type: array items: $ref: '#/components/schemas/Error_6' description: The error in a calculation unit. example: [] result: type: string description: The result URL of the calculation. example: example_value progress: type: string description: The progress of the calculation unit. example: example_value ErrorObject: description: Represents a single error, with error name and identifiers type: object properties: id: type: string title: type: string code: type: string Error_6: type: object properties: id: type: string example: abc123 detail: type: string example: example_value source: $ref: '#/components/schemas/ErrorSource' idStatus: description: Details about the instance of the job run specified via id wrapped in a data object properties: data: description: Details about the instance of the job run specified via id properties: id: description: The run ID type: string inputs: $ref: '#/components/schemas/startJob' prbStatus: $ref: '#/components/schemas/prbStatus' status: $ref: '#/components/schemas/status' statusDescription: $ref: '#/components/schemas/statusDescription' type: object example: example_value type: object ClientErrorResponse_6: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error_7' nullable: true example: [] Error_4: type: object properties: id: type: string nullable: true example: abc123 code: type: string nullable: true example: example_value title: type: string nullable: true example: Example Title detail: type: string nullable: true example: example_value source: $ref: '#/components/schemas/ErrorSource_2' prbStatus: description: The status of the job as per the application enum: - failed - pending - running - soft - stopped - success - warning example: running title: prbStatus type: string paginationOne: title: PaginationItems description: List of pagination objects type: object properties: total: description: Total number of files the API returns for a particular query type: integer example: 10 isEstimatedTotal: description: Boolean value that represents whether the total count of files returned is exact or an estimate. This is defaulted to False as the API should always return the exact count type: boolean example: true limit: description: Number of results returned per page type: integer example: 10 offset: description: The flag indicating the position in the results array if additional results are available beyond the default value or the value in paginationLimit parameter (if used). This value is passed in the _paginationOffset parameter to retreieve subsequent results type: integer example: 10 RateLimitExceededError: description: Error response when rate limit has been exceeded. type: object properties: message: type: string enum: - API rate limit exceeded CalculationStatusRoot_2: type: object properties: data: $ref: '#/components/schemas/CalculationStatus_2' errorResponse: type: object title: Error Response properties: status: description: status type: string example: Bad Request timestamp: description: timestamp in YYYY-MM-DD HH:MM:SS.SSS type: string example: '2019-11-01 11:09:41.918' format: date-time path: description: The Endpoint path {package}/version/{endpoint} type: string example: /factset-funds/v1/superRegion message: description: The plain text error message type: string example: Validation Error subErrors: description: subErrors related to the error message. Null if not applicable. type: object properties: object: description: the operation ID type: string field: description: Parameter Field Name type: string message: description: Error message type: string rejectedValue: description: Rejected Values in an Array type: array items: type: string example: example_value Error_5: type: object properties: id: type: string example: abc123 detail: type: string example: example_value source: $ref: '#/components/schemas/ErrorSource' ErrorObject_2: type: object nullable: true description: error properties: id: description: A UUID for this particular occurrence of the problem. type: string example: adb01824-252f-4420-b0c6-35a1e3507ef5 code: description: status type: string example: GenericError title: description: The plain text error message type: string example: Validation Error ObjectRoot: required: - data type: object properties: data: type: object example: example_value meta: type: object example: example_value ClientErrorResponse_5: type: object properties: errors: type: array items: $ref: '#/components/schemas/Error_6' example: [] errorResponse_2: type: object title: Error Response properties: status: description: status type: string example: Bad Request timestamp: description: timestamp in YYYY-MM-DD HH:MM:SS.SSS type: string example: '2019-11-01 11:09:41.918' format: date-time path: description: The Endpoint path {package}/version/{endpoint} type: string example: /factset-prices/v1/prices message: description: The plain text error message type: string example: Validation Error subErrors: description: subErrors related to the error message. Null if not applicable. type: object properties: object: description: the operation ID type: string field: description: Parameter Field Name type: string message: description: Error message type: string rejectedValue: description: Rejected Values in an Array type: array items: type: string example: example_value jobOverrides: description: If this object is provided, the settings given here will override the default settings of the job for the job run (settings will only be used temporarily and no changes will be made to the default PRB job). Only certain objects can be used for certain job types. properties: calendar: $ref: '#/components/schemas/calendar' combinations: description: An array of date account combinations items: $ref: '#/components/schemas/jobOverridesCombinationsRoot' type: array example: [] dates: description: Used only for jobs where type is ADF. If using dates override, please provide both start date and end date. properties: end: description: The end date in format YYYY-MM-DD format: date type: string start: description: The start date in format YYYY-MM-DD format: date type: string type: object example: example_value frequency: $ref: '#/components/schemas/frequency' runAsOfDate: description: PUB format: date type: string example: '2026-01-15' runAsSerialNumber: description: The FactSet serial number which has the credentials wanted to run the job type: string example: example_value tasks: description: Used only for jobs where type is PA items: type: string type: array example: [] type: object 403ForbiddenError: description: Error response for a user without entitlements to the API. type: string metaOne: title: Meta description: Array of metadata objects type: object properties: pagination: $ref: '#/components/schemas/paginationOne' partial: $ref: '#/components/schemas/isPartialOne' jobTypes: description: PA - Portfolio Analysis, PUB - Publisher, ADF - Analytics DataFeed, PI - Portfolio Insight, PD - Portfolio Dashboard, Portfolio Vault - vault enum: - ADF - PA - PD - PI - PUB - vault example: vault title: jobTypes type: string CalculationUnitStatus: type: object properties: status: enum: - Queued - Executing - Success - Failed - Cancelled type: string description: The status of calculation unit. example: Queued errors: type: array items: $ref: '#/components/schemas/Error_4' description: The error in a calculation unit. nullable: true example: [] result: type: string description: The result URL of the calculation. nullable: true example: example_value progress: type: string description: The progress of the calculation unit. nullable: true example: example_value points: type: integer description: The points for the calculation unit. format: int32 nullable: true example: 10 warnings: type: array items: type: string description: The warnings in a calculation unit. nullable: true example: [] responses: batch404: description: Resource not found. content: application/json: schema: $ref: '#/components/schemas/batchErrorResponse' examples: Batch Request Not Found: $ref: '#/components/examples/batchNotFound' '404': description: Resource not found. content: application/json: schema: $ref: '#/components/schemas/errorResponse_2' examples: Batch Request Not Found: $ref: '#/components/examples/notFound' Error401Response: content: application/json: schema: $ref: '#/components/schemas/ErrorArray' description: Invalid or missing authentication. '500': description: Internal Server Error. content: application/json: schema: $ref: '#/components/schemas/errorResponse' examples: Internal Server Error - Not Writable: $ref: '#/components/examples/notWritable' Internal Server Error - General Exception: $ref: '#/components/examples/generalException' Error404Response: content: application/json: schema: $ref: '#/components/schemas/ErrorArray' description: Job ID not found. '415': description: Unsupported Media Type. This error may be returned when the caller sends a resource in a format that is not accepted by the server. This can be fixed by ensuring that Content-Type header is set to the correct value. In this instance, "application/json" would be the appropriate value. content: application/json: schema: $ref: '#/components/schemas/errorResponse' examples: Bad Request - Date Format: $ref: '#/components/examples/unsupportedMediaType' '403': description: The USERNAME-SERIAL attempted to request the endpoint is not authorized to access. The request was a legal request, but the server is refusing to respond. Please reach out to FactSet Account Team for assistance with authorization. content: application/json: schema: $ref: '#/components/schemas/errorResponse' examples: Bad Request - Date Format: $ref: '#/components/examples/forbidden' GetNotationStatusGet200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. suspended: nullable: true type: boolean description: Indicates whether the notation is currently suspended from trading. The notation is tradable if it is not suspended and the market is open, see attribute `market.isOpen`. tradingStatus: nullable: true type: string description: Market-specific code of the trading status and/or the suspension of the notation. priceDelay: nullable: true type: number format: int32 description: Exchange-imposed delay in seconds for delayed-quality tick data. tickSize: nullable: true type: number format: real description: The minimum price movement of the notation. Prices can only be integral multiples of this minimum value. See endpoint `/notation/get` for the value unit of the `tickSize` for this notation. lotSize: nullable: true type: number format: real description: The minimum tradable volume of the notation. The number of units traded can only be integral multiples of this minimum value. tradeImbalance: nullable: true x-pushable: true type: number format: real description: Trade imbalance after the previous closed auction. A positive value indicates that more buy orders have been placed for the security; a negative value indicates more sell orders. market: nullable: false type: object x-property-sort: - id - isOpen - phase description: Market of the notation. properties: id: nullable: true type: number format: id32 x-positive: true description: 'Identifier of the market. See endpoint `/basic/market/list` for possible values. ' isOpen: nullable: true type: boolean description: Indicates whether the market of the notation is currently open, that is, the current time is between the open and adjusted close of the notation's market, see endpoint `/prices/tradingSchedule/event/list` for the trading schedule of the notation's market. The adjusted close is later than the official closing time specified by the market and includes the time after closing when trades might still be reported. Breaks such as a lunch break are not considered. phase: nullable: true type: string description: Market-specific code of the current market phase. regional: nullable: false type: object x-property-sort: - us description: Region-specific trading indicators. properties: us: nullable: false type: object x-property-sort: - caveatEmptor - proprietaryQuoteEligible description: Trading indicators specific to the United States. properties: caveatEmptor: nullable: true x-pushable: true type: boolean description: Indicates whether a Caveat Emptor (Buyer Beware) warning has been applied to the security. proprietaryQuoteEligible: nullable: true x-pushable: true type: boolean description: Security is eligible for proprietary quoting under SEC Rule 15c-211. description: '' nullable: false x-property-sort: - idNotation - sourceIdentifier - suspended - tradingStatus - priceDelay - tickSize - lotSize - tradeImbalance - market - regional meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta '400': description: Bad Request. This can occur for several reasons. Please review the "message" for more details. content: application/json: schema: $ref: '#/components/schemas/errorResponse' examples: Bad Request - Date Format: $ref: '#/components/examples/badRequestDateFormat' Bad Request - Missing Required Parameter: $ref: '#/components/examples/badRequestRequiredParameter' Bad Request - Future Date: $ref: '#/components/examples/badRequestFutureDate' Bad Request - Invalid Parameter: $ref: '#/components/examples/badRequestInvalidParameters' Bad Request - Malformed JSON: $ref: '#/components/examples/badRequestMalformedJSON' Bad Request - Read Timeout: $ref: '#/components/examples/badRequestReadTimeout' '401': description: Unauthenticated USERNAME-SERIAL. Ensure you are logged in and have successfully generated an API KEY for the IP range you are connecting from. For more help, select the **Report Issue** in the top right corner of this Developer Portal specification card and choose Connectivity 401 or 403 Responses. content: application/json: schema: $ref: '#/components/schemas/errorResponse' examples: Bad Request - Date Format: $ref: '#/components/examples/unauthenticated' CalculateInProgressResponse: content: application/json: schema: $ref: '#/components/schemas/ResourceStatusResponse' description: Calculation job still in progress headers: Location: description: Relative location to poll for status schema: type: string X-FactSet-Api-PickUp-Progress: description: Screen progress schema: type: string CalculateSuccessResponse: content: application/json: schema: $ref: '#/components/schemas/ResourceStatusResponse' description: Job completed headers: Location: description: Relative location to pick up screen results, calculate route only schema: type: string X-FactSet-Api-PickUp-Progress: description: Screen progress schema: type: string Error410Response: content: application/json: schema: $ref: '#/components/schemas/ErrorArray' description: The results have been fetched for this ID. Generic500ErrorResponse: description: Internal Server Error headers: Request-Key: description: Provide this key when reporting this issue schema: type: string headers: chain-id: description: Unique identifier for the request. Also known as the chain id. schema: type: string example: 5EFCCA8940CAEA6B X-FactSet-Api-RateLimit-Limit: description: Number of allowed requests for the time window. schema: type: string X-FactSet-Api-RateLimit-Reset: description: Number of seconds remaining till rate limit resets. schema: type: string X-FactSet-Api-RateLimit-Remaining: description: Number of requests left for the time window. schema: type: string X-DataDirect-Request-Key: description: FactSet's request key header. schema: type: string description: FactSet's request key header. api-deprecated-versions: description: the comma-separated list of deprecated major versions. schema: type: string example: 1,2 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. api-version: description: the full semantic version of the API. schema: type: string example: 1.0.0 api-supported-versions: description: the comma-separated list of supported major versions. schema: type: string example: '1' requestBodies: batch-status-postBody: required: true content: application/json: schema: $ref: '#/components/schemas/BatchDataRequest' examples: BatchStatusRequest: summary: Batch Status Request value: data: id: 2df43e85-ea0f-45c6-bf4a-2baf4d1eaa3c securitySchemes: basicAuth: type: http scheme: basic externalDocs: url: https://developer.factset.com/api-catalog/analytics-datastore-api description: API Documentation