openapi: 3.0.3 info: title: Factset Analytics Datastore About Week 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: Week paths: /notation/keyFigures/week/1/get: get: tags: - Week operationId: get/notation/keyFigures/week/1/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (eod) Key Figures for the Time Range of One Week. description: End-of-day (EOD) key figures for the time range of one week. parameters: - name: identifier in: query schema: type: string pattern: ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresWeek1Get200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /notation/keyFigures/week/1/list: get: tags: - Week operationId: get/notation/keyFigures/week/1/list x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: Factset End-of-day (eod) Key Figures for the Time Range of One Week, for a List of Notations. description: End-of-day (EOD) key figures for the time range of one week, for a list of notations. parameters: - name: identifiers in: query schema: description: Set of identifiers to resolve. type: array nullable: false items: type: string minLength: 3 exclusiveMinimum: false maxLength: 50 exclusiveMaximum: false pattern: ^[B-DF-HJ-NP-TV-Z0-9]{6}-[LR]$|^[A-Z0-9.#&*+]{1,47}-[A-Z0-9]{2,4}$|^[0-9]{3,20}$ uniqueItems: true minItems: 1 maxItems: 100 required: true style: form explode: false - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. responses: '200': $ref: '#/components/responses/GetNotationKeyFiguresWeek1List200Response' x-microcks-operation: delay: 0 dispatcher: FALLBACK /stock/notation/keyFigures/benchmark/week/1/get: get: tags: - Week operationId: get/stock/notation/keyFigures/benchmark/week/1/get x-supportsOffsetBasedPaging: false x-supportsOffsetBasedPagingWithoutTotal: false x-supportsCursorBasedPaging: false x-supportsCursorBasedPagingWithoutTotal: false x-supportsPush: false x-requiresUser: false x-requiresInternalClient: false x-disallowUser: false x-no-merge: false x-maxSortParameterCount: 10 x-supportsPermissionDeniedResponse: false summary: End-of-day (EOD) benchmark key figures of a stock for the time range of one week. description: End-of-day (EOD) benchmark key figures of a stock for the time range of one week. parameters: - name: identifier in: query schema: type: string pattern: ^([B-DF-HJ-NP-TV-Z0-9]{6}-[LR])|([A-Z0-9.]{1,47}-[A-Z0-9]{2,4})|([0-9]{3,20})$ maxLength: 50 exclusiveMaximum: false minLength: 3 exclusiveMinimum: false description: Identifier to resolve. required: true - name: identifierType in: query schema: type: string description: Type of the identifier. x-enum-description: - MDG identifier of a listing. - FactSet market symbol of a listing. - Regional FactSet ticker symbol, identifying the primary listing in the region. - FactSet Permanent Identifier on listing level. - Regional FactSet Permanent Identifier, identifying the primary listing in the region. enum: - idNotation - tickerExchange - tickerRegion - fdsPermanentIdentifierListing - fdsPermanentIdentifierRegional required: true - name: idNotationBenchmark in: query schema: type: array nullable: false items: type: string format: id64 x-positive: true uniqueItems: true minItems: 1 maxItems: 3 description: 'List of identifiers of benchmark notations. See the group description for the list of valid values.' style: form explode: false required: true - name: _attributes in: query schema: type: array items: type: string maxLength: 100 exclusiveMaximum: false uniqueItems: true maxItems: 50 style: form explode: false description: Limit the attributes returned in the response to the specified set. - name: _language in: query schema: type: string format: isoLanguage description: ISO 639-1 code of the language. maxLength: 2 minLength: 2 exclusiveMinimum: false exclusiveMaximum: false responses: '200': $ref: '#/components/responses/GetStockNotationKeyFiguresBenchmarkWeek1Get200Response' components: responses: GetNotationKeyFiguresWeek1List200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: array description: EOD key figures for a list of notations. nullable: false items: type: object nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - averagePrice - tradingVolume - tradingValue - volatility - status properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. averagePrice: nullable: true type: number format: real description: Arithmetic mean of the notation's EOD closing prices for the given time range. tradingVolume: nullable: false type: object x-property-sort: - average - sum description: Average and total trading volume for the given time range. properties: average: nullable: true type: number format: real description: Arithmetic mean of the daily trading volumes. sum: nullable: true type: number format: real description: Sum of the daily trading volumes. tradingValue: nullable: true type: number format: real description: Sum of the cash flow for all transactions of one notation over a certain time range. The cash flow of a transaction is its volume multiplied by its trade price. volatility: nullable: true type: number format: real description: Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. status: nullable: false type: object x-property-sort: - code - identifier - details - encryptedDetails description: Error status for the requested identifier. properties: code: nullable: true type: string description: Code of the error condition. x-enum-description: - No error. - The provided identifier does not refer to a valid notation. - Not entitled to see data for the notation. - Unable to resolve the provided identifier. enum: - none - parameter - entitlement - identifierMapping identifier: nullable: true type: string format: id64 x-positive: true description: Provided identifier. details: nullable: true type: string description: A human-readable, unstructured explanation specific to this occurrence of the problem. encryptedDetails: nullable: true type: string description: Base64-encoded internal details about the error. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta GetStockNotationKeyFiguresBenchmarkWeek1Get200Response: description: Successful Response content: application/json: schema: type: object properties: data: description: List of benchmarks with related key figures for a stock notation. nullable: false type: object x-property-sort: - idNotation - sourceIdentifier - benchmarks 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. benchmarks: nullable: false description: List of benchmarks with related key figures. The order of the benchmark notations in the response is unrelated to their order in the request array. type: array items: type: object nullable: false x-property-sort: - notation - beta - correlation - outperformance - status properties: notation: nullable: false type: object x-property-sort: - id - instrument description: Notation of a benchmark. properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the notation. instrument: nullable: false type: object x-property-sort: - id - name description: Instrument of the benchmark. properties: id: nullable: true type: string format: id64 x-positive: true description: Identifier of the instrument. name: nullable: true type: string format: localizedString description: Name of the instrument. beta: nullable: true type: number format: real description: Beta of the notation. correlation: nullable: true type: number format: real description: Correlation of the notation. outperformance: nullable: true type: number format: relativeValue description: Outperformance of the notation. status: nullable: false type: object x-property-sort: - code - identifier - encryptedDetails description: Error status for the requested identifier. properties: code: nullable: true type: string description: Code of the error condition. x-enum-description: - No error. - The provided identifier does not refer to a valid benchmark notation. enum: - none - parameter identifier: nullable: true type: string format: id64 x-positive: true description: Provided identifier. encryptedDetails: nullable: true type: string description: Base64-encoded internal details about the error. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject_2' x-property-sort: - status GetNotationKeyFiguresWeek1Get200Response: description: Successful Response content: application/json: schema: type: object properties: data: type: object properties: idNotation: nullable: true type: string format: id64 x-positive: true description: MDG identifier of the listing. sourceIdentifier: nullable: true type: string description: Identifier used in the request. referenceDate: nullable: true type: string format: date description: Reference date of the time range. performance: nullable: false type: object x-property-sort: - absolute - relative - referencePrice description: Performance values. properties: absolute: nullable: true type: number format: real description: Absolute difference of a notation's most recent EOD closing price against the EOD closing price on the reference date. relative: nullable: true type: number format: relativeValue description: Difference of a notation's most recent EOD closing price against the EOD closing price on the reference date, relative to the EOD closing price on the reference date. referencePrice: nullable: true type: number format: real description: EOD closing price as of the reference date (see attribute `referenceDate`) used for calculation. high: nullable: false type: object x-property-sort: - price - date description: Maximum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Maximum value. date: nullable: true type: string format: date description: Date of the maximum value. low: nullable: false type: object x-property-sort: - price - date description: Minimum value of the notation's price in the given time range. properties: price: nullable: true type: number format: real description: Minimum value. date: nullable: true type: string format: date description: Date of the minimum value. averagePrice: nullable: true type: number format: real description: Arithmetic mean of the notation's EOD closing prices for the given time range. tradingVolume: nullable: false type: object x-property-sort: - average - sum description: Average and total trading volume for the given time range. properties: average: nullable: true type: number format: real description: Arithmetic mean of the daily trading volumes. sum: nullable: true type: number format: real description: Sum of the daily trading volumes. tradingValue: nullable: true type: number format: real description: Sum of the cash flow for all transactions of one notation over a certain time range. The cash flow of a transaction is its volume multiplied by its trade price. volatility: nullable: true type: number format: real description: Volatility of the daily logarithmic returns, annualized assuming 256 trading days per year. nullable: false x-property-sort: - idNotation - sourceIdentifier - referenceDate - performance - high - low - averagePrice - tradingVolume - tradingValue - volatility description: EOD key figures. meta: type: object description: The meta member contains the meta information of the response. properties: status: $ref: '#/components/schemas/StatusObject' x-property-sort: - status x-property-sort: - data - meta schemas: 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 StatusObject_2: type: object properties: code: type: number format: int32 description: The HTTP status code of the response, mirroring the code from the Status-Line of the HTTP response message (see [RFC2616] section 6.1). description: The status member contains the status code of the response. required: - code securitySchemes: basicAuth: type: http scheme: basic externalDocs: url: https://developer.factset.com/api-catalog/analytics-datastore-api description: API Documentation