Utilities

Convert between real and nominal dollars (COLA helper)

Inflates a present amount to a future nominal value (to_nominal) or deflates a future amount to today's purchasing power (to_real) at a constant annual rate, and returns the year-by-year stream. The rate is an input (no CPI table is embedded). Deterministic.

post/v1/inflation-adjust

Request

  • Base URL: https://api.numeratica.com
  • URL: https://api.numeratica.com/v1/inflation-adjust
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Request body

amountnumber required
annual_ratenumber required

Inflation / COLA rate.

yearsinteger required
direction'to_nominal' | 'to_real' required

Example request

{
  "amount": 100,
  "annual_rate": 0.025,
  "years": 10,
  "direction": "to_nominal"
}

Response

Adjusted amount + schedule

result_idstring
engine_versionstring
disclaimerstring

Example response

{
  "result_id": "infl_1a2b3c4d5e6f7a8b",
  "engine_version": "inflation-adjust-1.0.0",
  "inputs": {
    "amount": 100,
    "annual_rate": 0.025,
    "years": 10,
    "direction": "to_nominal"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.