API Endpoint

Financial Health Score

Calculate overall financial health score based on emergency fund, debt, savings, and allocation.

Endpoint

POST https://likeoptions.com/api/v1/calculate/financialhealth

Also supports GET with query parameters.

Parameters

Parameter	Type	Default	Description
`emergencyFundMonths`	number	—	Months of emergency fund
`monthlyDebtPayments`	number	—	Total monthly debt payments ($)
`monthlyIncome`	number	—	Monthly gross income ($)
`monthlySavings`	number	—	Monthly savings rate ($)
`assetAllocationScore`	number	—	Asset allocation score (0-100)

Request Examples

POST (JSON body)

curl -X POST https://likeoptions.com/api/v1/calculate/financialhealth \
  -H "Content-Type: application/json" \
  -d '{"emergencyFundMonths": 100000, "monthlyDebtPayments": 50000, "monthlyIncome": 6}'

GET (query parameters)

curl "https://likeoptions.com/api/v1/calculate/financialhealth?emergencyFundMonths=100000&monthlyDebtPayments=50000&monthlyIncome=6"

Response

{
  "kind": "financialhealth",
  "result": {
    "primary": 1234.56,
    "secondary": [
      { "label": "Example metric", "value": 100, "format": "money" },
      { "label": "Example percent", "value": 5.5, "format": "percent" }
    ]
  }
}

When to Use

Assess overall financial health
Track improvement over time
Identify weak areas

Error Handling

400 Bad Request — Invalid input parameters or missing required fields
404 Not Found — Unknown calculator kind
429 Too Many Requests — Rate limit exceeded (120 req/hour per IP)
413 Payload Too Large — Request body exceeds 16 KB

Related Endpoints

View request examples in JavaScript, Python, cURL, and more →