Indexes

List various, always up-to-date indexes like consumer price index for many countries.

Endpoints

The API is available as GET endpoint.

GET/v1/indexes/{index}

curl -X GET https://api.apistax.io/v1/indexes/at-cpi-2015?frequency=monthly \
    -H 'Authorization: Bearer API_KEY_HERE'

Response

The API returns a application/json response. It contains general data like the ID and the selected frequency of the index. Additionally, the official name and the data origin of the index is returned. The values are sorted in ascending order by date (year, month).

{
  "id": "at-cpi-2015",
  "name": "Verbraucherpreisindex 2015",
  "source": "Bundesanstalt Statistik Österreich",
  "frequency": "YEARLY",
  "values": [
    {
      "year": 2016,
      "value": 100.9
    },
    {
      "year": 2017,
      "value": 103
    },
    {
      "year": 2018,
      "value": 105.1
    },
    {
      "year": 2019,
      "value": 106.7
    },
    {
      "year": 2020,
      "value": 108.2
    },
    {
      "year": 2021,
      "value": 111.2
    }
  ]
}

Parameters

index: String

The identification of the index. See "Identifier" column in the "Available indexes" tables.

frequency: String = yearly

The frequency in which the index is published. Possible values are monthly and yearly.

Available indexes

Consumer price indexes (CPI)

Harmonised Index of Consumer Prices (HICP)

The European Central Bank created the Harmonised Index of Consumer Prices to measure consumer price inflation in the euro area. Harmonised means that all participating countries follow the same methodology so that the data can be compared between countries.

If not declared otherwise, the HICP indexes source from the European Union.

Possible errors

It should be noted that there are a number of common error messages, which can be found in the "Possible errors" section of the general documentation.