Factset · Schema

indexSnapshot

FinancialFinancial DataInvestment AnalyticsMarket DataPortfolio AnalyticsResearch

Properties

Name	Type	Description
fsymId	string	Requested Identifier. Must be a valid Benchmark Identifier recognized by FactSet.
date	string	The respective date for values as of the date requested in YYYY-MM-DD format.
name	string	Proper Name of Index.
constituentNumber	integer	The total number of constituents as of the date requested.
currency	string	Currency Code used in adjustments. If no Currency was requested, the service will default to the local Calendar.
marketValue	number	Index Level Market Capitalization as of the date requested expressed in millions.
price	number	Index Level Price
priceReturnPercent1D	number	Index Level Price - 1 Day percent change
priceReturnPercentQTD	number	Index Level Price - Quarter-to-Date percent change
priceReturnPercentYTD	number	Index Level Price - Year-to-Date percent change
totalReturnLevel	number	Index Level Total Return Amount. (Gross or Net depends on requested returnType)
totalReturnPercent1D	number	Index Level Total Return - 1 Day percent change. (Gross or Net depends on requested returnType)
totalReturnPercentQTD	number	Index Level Total Return - Quarter-to-Date percent change. (Gross or Net depends on requested returnType)
totalReturnPercentYTD	number	Index Level Total Return - Year-to-Date percent change. (Gross or Net depends on requested returnType)
returnType	string	The requested Return Type - GROSS or NET
requestId	string	Benchmark Identifier specified in the request

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "indexSnapshot",
  "type": "object",
  "properties": {
    "fsymId": {
      "type": "string",
      "description": "Requested Identifier. Must be a valid Benchmark Identifier recognized by FactSet."
    },
    "date": {
      "type": "string",
      "description": "The respective date for values as of the date requested in YYYY-MM-DD format."
    },
    "name": {
      "type": "string",
      "description": "Proper Name of Index."
    },
    "constituentNumber": {
      "type": "integer",
      "description": "The total number of constituents as of the date requested."
    },
    "currency": {
      "type": "string",
      "description": "Currency Code used in adjustments. If no Currency was requested, the service will default to the local Calendar."
    },
    "marketValue": {
      "type": "number",
      "description": "Index Level Market Capitalization as of the date requested expressed in millions."
    },
    "price": {
      "type": "number",
      "description": "Index Level Price"
    },
    "priceReturnPercent1D": {
      "type": "number",
      "description": "Index Level Price - 1 Day percent change"
    },
    "priceReturnPercentQTD": {
      "type": "number",
      "description": "Index Level Price - Quarter-to-Date percent change"
    },
    "priceReturnPercentYTD": {
      "type": "number",
      "description": "Index Level Price - Year-to-Date percent change"
    },
    "totalReturnLevel": {
      "type": "number",
      "description": "Index Level Total Return Amount. (Gross or Net depends on requested returnType)"
    },
    "totalReturnPercent1D": {
      "type": "number",
      "description": "Index Level Total Return - 1 Day percent change. (Gross or Net depends on requested returnType)"
    },
    "totalReturnPercentQTD": {
      "type": "number",
      "description": "Index Level Total Return - Quarter-to-Date percent change. (Gross or Net depends on requested returnType)"
    },
    "totalReturnPercentYTD": {
      "type": "number",
      "description": "Index Level Total Return - Year-to-Date percent change. (Gross or Net depends on requested returnType)"
    },
    "returnType": {
      "type": "string",
      "description": "The requested Return Type - GROSS or NET"
    },
    "requestId": {
      "type": "string",
      "description": "Benchmark Identifier specified in the request"
    }
  }
}