API Endpoint

Mortgage Payment

Calculate principal-and-interest mortgage payment from home price, down payment, rate, and term.

Endpoint

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

Also supports GET with query parameters.

Parameters

Parameter	Type	Default	Description
`homePrice`	number	—	Home purchase price
`downPayment`	number	—	Down payment amount
`annualRate`	number	—	Annual interest rate (%)
`years`	number	—	Loan term (years)
`annualTax`	number	0	Annual property tax ($)

Request Examples

POST (JSON body)

curl -X POST https://likeoptions.com/api/v1/calculate/mortgage \
  -H "Content-Type: application/json" \
  -d '{"homePrice": 100000, "downPayment": 50000, "annualRate": 6}'

GET (query parameters)

curl "https://likeoptions.com/api/v1/calculate/mortgage?homePrice=100000&downPayment=50000&annualRate=6"

Response

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

When to Use

Estimate monthly mortgage payment
Budget housing costs
Compare loan offers

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 →