Skip to main content
POST
Savings Goal Calculator

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
ioMode
enum<string>

Solve For

Available options:
deposit,
time
ioGoalAmount
number

Savings Goal ($)

Required range: x >= 0
ioCurrentSavings
number

Current Savings ($)

Required range: x >= 0
ioTimeValue
number

Time to Goal

Required range: x >= 0
ioTimeUnit
enum<string>

Time Unit

Available options:
years,
months
ioMonthlyDeposit
number

Monthly Deposit ($)

Required range: x >= 0
ioAnnualRate
number

Annual Interest Rate (%)

Required range: x >= 0
ioCompounding
enum<string>

Compounding

Available options:
monthly,
annual

Response

Tool output

tool
string
required
tool_version
string
required

Output-contract version for this tool. Currently "1" for all tools.

outputs
object
required
credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

request_id
string
credits_remaining
integer | null

Credits left in the current monthly allowance, or null when metering is disabled.