Mortgage Calculator API
Overview
To use Mortgage Calculator, you need an API key. You can get one by creating a free account and visiting your dashboard.
POST Endpoint
https://api.apiverve.com/v1/mortgagecalculatorExample
How to call the Mortgage Calculator API in different programming languages.
curl -X POST \
"https://api.apiverve.com/v1/mortgagecalculator" \
-H "X-API-Key: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"amount": 570000,
"rate": 6.8,
"years": 30
}'const response = await fetch('https://api.apiverve.com/v1/mortgagecalculator', {
method: 'POST',
headers: {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
},
body: JSON.stringify({
"amount": 570000,
"rate": 6.8,
"years": 30
})
});
const data = await response.json();
console.log(data);import requests
headers = {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
payload = {
"amount": 570000,
"rate": 6.8,
"years": 30
}
response = requests.post('https://api.apiverve.com/v1/mortgagecalculator', headers=headers, json=payload)
data = response.json()
print(data)package main
import (
"fmt"
"io"
"net/http"
"bytes"
"encoding/json"
)
func main() {
payload := map[string]interface{}{
"amount": "570000",
"rate": "6.8",
"years": "30"
}
jsonPayload, _ := json.Marshal(payload)
req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/mortgagecalculator", bytes.NewBuffer(jsonPayload))
req.Header.Set("X-API-Key", "your_api_key_here")
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}{
"status": "ok",
"error": null,
"data": {
"amount": 570000,
"downpayment": 0,
"rate": 6.8,
"years": 30,
"total_interest_paid": 767750.49,
"total_loan_payment": 1337750.49,
"interestRatio": 57.39,
"monthly_payment": {
"total": 3715.97,
"mortgage": 3715.97,
"property_tax": 0,
"hoa": 0,
"home_insurance": 0
},
"annual_payment": {
"total": 44591.68,
"mortgage": 44591.68,
"property_tax": 0,
"hoa": 0,
"home_insurance": 0
},
"formatted": {
"amount": "$570,000",
"monthlyPayment": "$3,715.97",
"totalInterestPaid": "$767,750.49",
"totalLoanPayment": "$1,337,750.49"
},
"amortization_schedule": [
{
"month": 1,
"interest_payment": 3230,
"principal_payment": 485.97,
"remaining_balance": 569514.03
},
{
"month": 2,
"interest_payment": 3227.25,
"principal_payment": 488.73,
"remaining_balance": 569025.3
},
{
"month": 3,
"interest_payment": 3224.48,
"principal_payment": 491.5,
"remaining_balance": 568533.8
}
]
}
}Authentication
The Mortgage Calculator API requires authentication via API key. Include your API key in the request header:
X-API-Key: your_api_key_hereInteractive API Playground
Test the Mortgage Calculator API directly in your browser with live requests and responses.
Parameters
The following parameters are available for the Mortgage Calculator API:
Calculate Mortgage
| Parameter | Type | Required | Description | Default | Example |
|---|---|---|---|---|---|
amount | number | required | The loan amount Range: min: 0 | - | |
rate | number | required | The interest rate (percentage) Range: 0 - 100 | - | |
years | integer | required | The loan term in years Range: 1 - 50 | - | |
downpayment | number | optional | The down payment amount Range: min: 0 | - | |
annual_propertytax | number | optional | The annual property tax amount Range: min: 0 | - | |
annual_homeinsurance | number | optional | The annual home insurance amount Range: min: 0 | - | |
annual_hoa | number | optional | The annual HOA amount Range: min: 0 | - |
Response
The Mortgage Calculator API returns responses in JSON, XML, YAML, and CSV formats. The JSON response is shown in the Example section above; alternative formats below.
Other Response Formats
<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>ok</status>
<error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
<data>
<amount>570000</amount>
<downpayment>0</downpayment>
<rate>6.8</rate>
<years>30</years>
<total_interest_paid>767750.49</total_interest_paid>
<total_loan_payment>1337750.49</total_loan_payment>
<interestRatio>57.39</interestRatio>
<monthly_payment>
<total>3715.97</total>
<mortgage>3715.97</mortgage>
<property_tax>0</property_tax>
<hoa>0</hoa>
<home_insurance>0</home_insurance>
</monthly_payment>
<annual_payment>
<total>44591.68</total>
<mortgage>44591.68</mortgage>
<property_tax>0</property_tax>
<hoa>0</hoa>
<home_insurance>0</home_insurance>
</annual_payment>
<formatted>
<amount>$570,000</amount>
<monthlyPayment>$3,715.97</monthlyPayment>
<totalInterestPaid>$767,750.49</totalInterestPaid>
<totalLoanPayment>$1,337,750.49</totalLoanPayment>
</formatted>
<amortization_schedule>
<item>
<month>1</month>
<interest_payment>3230</interest_payment>
<principal_payment>485.97</principal_payment>
<remaining_balance>569514.03</remaining_balance>
</item>
<item>
<month>2</month>
<interest_payment>3227.25</interest_payment>
<principal_payment>488.73</principal_payment>
<remaining_balance>569025.3</remaining_balance>
</item>
<item>
<month>3</month>
<interest_payment>3224.48</interest_payment>
<principal_payment>491.5</principal_payment>
<remaining_balance>568533.8</remaining_balance>
</item>
</amortization_schedule>
</data>
</response>
status: ok
error: null
data:
amount: 570000
downpayment: 0
rate: 6.8
years: 30
total_interest_paid: 767750.49
total_loan_payment: 1337750.49
interestRatio: 57.39
monthly_payment:
total: 3715.97
mortgage: 3715.97
property_tax: 0
hoa: 0
home_insurance: 0
annual_payment:
total: 44591.68
mortgage: 44591.68
property_tax: 0
hoa: 0
home_insurance: 0
formatted:
amount: $570,000
monthlyPayment: $3,715.97
totalInterestPaid: $767,750.49
totalLoanPayment: $1,337,750.49
amortization_schedule:
- month: 1
interest_payment: 3230
principal_payment: 485.97
remaining_balance: 569514.03
- month: 2
interest_payment: 3227.25
principal_payment: 488.73
remaining_balance: 569025.3
- month: 3
interest_payment: 3224.48
principal_payment: 491.5
remaining_balance: 568533.8
| key | value |
|---|---|
| amount | 570000 |
| downpayment | 0 |
| rate | 6.8 |
| years | 30 |
| total_interest_paid | 767750.49 |
| total_loan_payment | 1337750.49 |
| interestRatio | 57.39 |
| monthly_payment | {total:3715.97,mortgage:3715.97,property_tax:0,hoa:0,home_insurance:0} |
| annual_payment | {total:44591.68,mortgage:44591.68,property_tax:0,hoa:0,home_insurance:0} |
| formatted | {amount:$570,000,monthlyPayment:$3,715.97,totalInterestPaid:$767,750.49,totalLoanPayment:$1,337,750.49} |
| amortization_schedule | [{month:1,interest_payment:3230,principal_payment:485.97,remaining_balance:569514.03},{month:2,interest_payment:3227.25,principal_payment:488.73,remaining_balance:569025.3},{month:3,interest_payment:3224.48,principal_payment:491.5,remaining_balance:568533.8}] |
Response Structure
All API responses follow a consistent structure with the following fields:
| Field | Type | Description | Example |
|---|---|---|---|
status | string | Indicates whether the request was successful ("ok") or failed ("error") | ok |
error | string | null | Contains error message if status is "error", otherwise null | null |
data | object | null | Contains the API response data if successful, otherwise null | {...} |
Learn more about response formats →
Response Data Fields
When the request is successful, the data object contains the following fields:
| Field | Type | Sample Value | Description |
|---|---|---|---|
amount | number | Loan amount in dollars | |
downpayment | number | Down payment amount provided | |
rate | number | Interest rate percentage used for calculation | |
years | number | Loan term in years | |
total_interest_paidPremium | number | Total interest paid over entire loan term | |
total_loan_paymentPremium | number | Total amount paid (principal + interest) | |
interestRatioPremium | number | Percentage of payment that is interest | |
monthly_payment | object | - | |
â”” total | number | Total monthly payment including all fees | |
â”” mortgage | number | Monthly mortgage payment (principal + interest) | |
â”” property_tax | number | Monthly property tax portion of payment | |
â”” hoa | number | Monthly HOA fee portion of payment | |
â”” home_insurance | number | Monthly home insurance portion of payment | |
annual_payment | object | - | |
â”” total | number | Total annual payment including all fees | |
â”” mortgage | number | Annual mortgage payment (principal + interest) | |
â”” property_tax | number | Annual property tax portion of payment | |
â”” hoa | number | Annual HOA fee portion of payment | |
â”” home_insurance | number | Annual home insurance portion of payment | |
formatted | object | - |
Headers
Only X-API-Key is required. Optional headers include Accept for response format negotiation (JSON, XML, or YAML), User-Agent, and X-Request-ID for request tracing. See all request headers →
GraphQL AccessALPHA
Access Mortgage Calculator through GraphQL to combine it with other API calls in a single request. Query only the mortgage calculator data you need with precise field selection, and orchestrate complex data fetching workflows.
Credit Cost: Each API called in your GraphQL query consumes its standard credit cost.
POST https://api.apiverve.com/v1/graphqlquery {
mortgagecalculator(
input: {
amount: 570000
rate: 6.8
years: 30
}
) {
amount
downpayment
rate
years
total_interest_paid
total_loan_payment
interestRatio
monthly_payment {
total
mortgage
property_tax
hoa
home_insurance
}
annual_payment {
total
mortgage
property_tax
hoa
home_insurance
}
formatted {
amount
monthlyPayment
totalInterestPaid
totalLoanPayment
}
amortization_schedule
}
}Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.
CORS Support
The Mortgage Calculator API accepts cross-origin requests from any origin, so it can be called directly from browser-based applications without a proxy. See CORS support →
Rate Limiting
Mortgage Calculator requests are throttled per minute on the Free plan and unthrottled on paid plans. Exceeding the limit returns 429 Too Many Requests; rate-limit usage is reported in the X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset response headers. See per-plan limits and best practices →
Error Codes
The Mortgage Calculator API uses standard HTTP status codes — 200 on success, 400 for invalid parameters, 401 for missing or invalid keys, 403 for insufficient credits, 429 for rate-limit exhaustion, and 500/503 for server-side issues. Each error response includes an X-Request-ID header you can quote when contacting support. See full error handling guide →
SDKs for Mortgage Calculator
Official Mortgage Calculator packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →
No-Code Integrations
Mortgage Calculator works with Zapier, Make, Pipedream, n8n, and Power Automate using the same API key. See setup guides →
Frequently Asked Questions
How do I get an API key for Mortgage Calculator?
How many credits does Mortgage Calculator cost?
Each successful Mortgage Calculator API call consumes credits based on plan tier. Check the pricing section above for the exact credit cost. Failed requests and errors don't consume credits, so you only pay for successful mortgage calculator lookups.
Can I use Mortgage Calculator in production?
The free plan is for testing and development only. For production use of Mortgage Calculator, upgrade to a paid plan (Starter, Pro, or Mega) which includes commercial use rights, no attribution requirements, and guaranteed uptime SLAs. All paid plans are production-ready.
Can I use Mortgage Calculator from a browser?
What happens if I exceed my Mortgage Calculator credit limit?
When you reach your monthly credit limit, Mortgage Calculator API requests will return an error until you upgrade your plan or wait for the next billing cycle. You'll receive notifications at 80% and 95% usage to give you time to upgrade if needed.








