Paycheck health score (0-100) API

Score how well a take-home paycheck is allocated on a transparent 0-100 rubric with documented weights (savings rate 40% targeting >=20%, essentials within 50% 35%, discretionary within 30% 25%), returning a letter grade and per-factor breakdown. Answers 'how healthy is my paycheck allocation', 'grade my budget split', 'is my savings rate good enough'.

Price$0.01per request

MethodPOST

Route/v1/calc/budget-paycheck-health-score

StatusLive

MIME typeapplication/json

Rate limit120/minute

CacheNo cache

budgetpaycheckscorehealthsavings-raterubriccalculatormoney

API URLhttps://x402.hexl.dev/v1/calc/budget-paycheck-health-score

Integration docs

Example request

{
  "takeHome": 5000,
  "essentials": 2200,
  "savings": 1000
}

Example response

{
  "score": 95,
  "grade": "A",
  "savingsRate": 0.2,
  "essentialRate": 0.44,
  "discretionaryRate": 0.36,
  "weights": {
    "savings": 0.4,
    "essentials": 0.35,
    "discretionary": 0.25
  },
  "breakdown": [
    {
      "factor": "savings rate (target >=20%)",
      "value": 1,
      "weight": 0.4,
      "contribution": 40
    },
    {
      "factor": "essentials within 50%",
      "value": 1,
      "weight": 0.35,
      "contribution": 35
    },
    {
      "factor": "discretionary within 30%",
      "value": 0.8,
      "weight": 0.25,
      "contribution": 20
    }
  ]
}

Input schema

{
  "type": "object",
  "required": [
    "takeHome",
    "essentials",
    "savings"
  ],
  "properties": {
    "takeHome": {
      "type": "number",
      "description": "Take-home pay in dollars",
      "examples": [
        5000
      ]
    },
    "essentials": {
      "type": "number",
      "description": "Essential spend in dollars",
      "examples": [
        2200
      ]
    },
    "savings": {
      "type": "number",
      "description": "Savings/debt paydown in dollars",
      "examples": [
        1000
      ]
    },
    "discretionary": {
      "type": "number",
      "description": "Discretionary spend in dollars (default = remainder)"
    }
  }
}

Output schema

{
  "type": "object",
  "additionalProperties": true
}