Skip to main content
POST

Authorizations

Authorization
string
header
required

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

Body

application/json
cash
number

Cash & Savings

Required range: 0 <= x <= 999999999999
investments
number

Investments & Retirement

Required range: 0 <= x <= 999999999999
realEstate
number

Real Estate

Required range: 0 <= x <= 999999999999
vehicles
number

Vehicles

Required range: 0 <= x <= 999999999999
otherAssets
number

Other Assets

Required range: 0 <= x <= 999999999999
mortgage
number

Mortgage

Required range: 0 <= x <= 999999999999
autoLoans
number

Car Loans

Required range: 0 <= x <= 999999999999
studentLoans
number

Student Loans

Required range: 0 <= x <= 999999999999
creditCards
number

Credit Card Debt

Required range: 0 <= x <= 999999999999
otherDebts
number

Other Debts

Required range: 0 <= x <= 999999999999
currency
enum<string>

Currency

Available options:
USD,
EUR,
GBP,
JPY,
INR,
CAD,
AUD,
CHF,
CNY,
BRL,
MXN,
SGD,
ZAR,
NONE

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

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

credits_remaining
integer | null
required

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

request_id
string

Correlation id, also sent as x-request-id.