Indices

GET /v1/indices

Overview

Purpose: Get major world market indices performance
Response Format: Array of market indices with performance metrics and returns

Authentication

Optional authentication via x-api-key header token

Request Parameters

Parameter	Type	Required	Description	Example
index	array of strings		Specific indices to include (returns all if omitted)	["snp", "djia", "nasdaq", rut"]
region	string		Filter indices by region	US

Available Region Options

US, NA, SA, EU, AS, AF, ME, OCE, global

Responses:

• 200 OK

  • Content-Type: application/json
  • Schema: Array of MarketIndex objects.
  • Example (200):

    [
      {
        "name": "S&P 500",
        "value": 4300.0,
        "change": "+10.00",
        "percentChange": "+0.23%",
        "fiveDaysReturn": "-19.35%",
        "oneMonthReturn": "-28.48%",
        "threeMonthReturn": "-14.02%",
        "sixMonthReturn": "36.39%",
        "ytdReturn": "+10.00%",
        "yearReturn": "+20.00%",
        "threeYearReturn": "+30.00%",
        "fiveYearReturn": "+40.00%",
        "tenYearReturn": "2,005.31%",
        "maxReturn": "22,857.89%"
      }
    ]
    

• 422 Unprocessable Entity

  {
    "detail": "Invalid request",
    "errors": {
      "index.0": [
        "Input should be 'snp', 'djia', 'nasdaq', 'nyse-composite', 'nyse-amex', 'rut', 'vix', 'tsx-composite', 'ibovespa', 'ipc-mexico', 'ipsa', 'merval', 'ivbx', 'ibrx-50', 'ftse-100', 'dax', 'cac-40', 'euro-stoxx-50', 'euronext-100', 'bel-20', 'moex', 'aex', 'ibex-35', 'ftse-mib', 'smi', 'psi', 'atx', 'omxs30', 'omxc25', 'wig20', 'budapest-se', 'moex-russia', 'rtsi', 'hang-seng', 'sti', 'sensex', 'idx-composite', 'ftse-bursa', 'kospi', 'twse', 'nikkei-225', 'shanghai', 'szse-component', 'set', 'nifty-50', 'nifty-200', 'psei-composite', 'china-a50', 'dj-shanghai', 'india-vix', 'egx-30', 'jse-40', 'ftse-jse', 'afr-40', 'raf-40', 'sa-40', 'alt-15', 'ta-125', 'ta-35', 'tadawul-all-share', 'tamayuz', 'bist-100', 'asx-200', 'all-ordinaries', 'nzx-50', 'usd', 'msci-europe', 'gbp', 'euro', 'yen', 'australian', 'msci-world' or 'cboe-uk-100'"
      ],
      "region": [
        "Input should be 'US', 'NA', 'SA', 'EU', 'AS', 'AF', 'ME', 'OCE' or 'global'"
      ]
    }
  }
  

Schema References

MarketIndex Schema

Field	Type	Description	Required
name	string	Name of the index	✓
value	number	Current value of the index	✓
change	string	Change in the index	✓
percentChange	string	Percentage change	✓
fiveDaysReturn	string	5-day return
oneMonthReturn	string	1-month return
threeMonthReturn	string	3-month return
sixMonthReturn	string	6-month return
ytdReturn	string	Year-to-date return
yearReturn	string	1-year return
threeYearReturn	string	3-year return
fiveYearReturn	string	5-year return
tenYearReturn	string	10-year return
maxReturn	string	Maximum all-time return