Data & Analytics

Sweep one input and report the winner per value

Sweeps one input field (credit_score, down_payment_percent, or rate_shift_bps) across a from/to/step range (max 25 steps) and reports the winning lender / APR / monthly payment at each value, plus the flip points where the winning lender changes. This route is the single source of truth; the MCP simulate_decision tool calls it.

Authentication required: Pass your API key in the X-API-Key header.

post/v1/simulate-decision

Request

Base URL: https://api.rateapi.dev
URL: https://api.rateapi.dev/v1/simulate-decision
Auth: API key in header X-API-Key

Request body

Example request

{
  "scenario": {
    "product_type": "mortgage",
    "state": "CA",
    "intent": "purchase",
    "amount": 400000,
    "term_months": 360,
    "credit_score": 720,
    "down_payment_percent": 20
  }
}

Response

Sweep grid with the winning lender per value plus flip points.

product_typestring

Loan or deposit product this applies to.

statestring

Two-letter US state code.

sweep_fieldstring

The input that was swept.

Changes

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