Factset · Schema

return

FinancialFinancial DataInvestment AnalyticsMarket DataPortfolio AnalyticsResearch

Properties

Name Type Description
fsymId string Factset Regional Security Identifier. Six alpha-numeric characters, excluding vowels, with an -R suffix (XXXXXX-R). Identifies the security's best regional security data series per currency. For equit
date string End date of the return. Date in YYYY-MM-DD format. Depending on Frequency and Calendar settings, this could represent the entire return period requested.
adjDate string Date of last split for which return has been adjusted.
currency string Currency ISO code. For more details, visit [Online Assistant Page #1470](https://oa.apps.factset.com/pages/1470).
totalReturn number The simple or compound return for the requested `frequency` and/or `rolling_period`. Depending on the input parameters the return will adjust accordingly. If you simply use `frequency` and no `rolling
requestId string Identifier that was used for the request.
View JSON Schema on GitHub

JSON Schema

factset-prices-return-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "return",
  "type": "object",
  "properties": {
    "fsymId": {
      "type": "string",
      "description": "Factset Regional Security Identifier. Six alpha-numeric characters, excluding vowels, with an -R suffix (XXXXXX-R). Identifies the security's best regional security data series per currency. For equities, all primary listings per region and currency are allocated a regional-level permanent identifier. The regional-level permanent identifier will be available once a SEDOL representing the region/currency has been allocated and the identifiers are on FactSet."
    },
    "date": {
      "type": "string",
      "description": "End date of the return. Date in YYYY-MM-DD format. Depending on Frequency and Calendar settings, this could represent the entire return period requested."
    },
    "adjDate": {
      "type": "string",
      "description": "Date of last split for which return has been adjusted."
    },
    "currency": {
      "type": "string",
      "description": "Currency ISO code. For more details, visit [Online Assistant Page #1470](https://oa.apps.factset.com/pages/1470)."
    },
    "totalReturn": {
      "type": "number",
      "description": "The simple or compound return for the requested `frequency` and/or `rolling_period`. Depending on the input parameters the return will adjust accordingly. If you simply use `frequency` and no `rolling_period`, the return value will represent the frequency period. If you use `rolling_period`, the values will be returned in actual period ends (e.g. actual month, actual week, daily, etc.). General Return Calculation Details found on [Online Assistant Page #8748](https://oa.apps.factset.com/pages/8748)"
    },
    "requestId": {
      "type": "string",
      "description": "Identifier that was used for the request."
    }
  }
}