Mortgage CalculatorMortgage Calculator API

OnlineCredit Usage:1 per callRefreshed 1 month ago
avg: 977ms|p50: 913ms|p75: 1020ms|p90: 1149ms|p99: 1407ms

Mortgage Calculator is a simple tool for calculating mortgage payments. It returns the monthly payment, total interest, and more.

The Mortgage Calculator API provides reliable and fast access to mortgage calculator data through a simple REST interface. Built for developers who need consistent, high-quality results with minimal setup time.

To use Mortgage Calculator, you need an API key. You can get one by creating a free account and visiting your dashboard.

POST Endpoint

URL
https://api.apiverve.com/v1/mortgagecalculator

Code Examples

Here are examples of how to call the Mortgage Calculator API in different programming languages:

cURL Request
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
}'
JavaScript (Fetch API)
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);
Python (Requests)
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)
Node.js (Native HTTPS)
const https = require('https');
const url = require('url');

const options = {
  method: 'POST',
  headers: {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
  }
};

const postData = JSON.stringify({
  "amount": 570000,
  "rate": 6.8,
  "years": 30
});

const req = https.request('https://api.apiverve.com/v1/mortgagecalculator', options, (res) => {
  let data = '';
  res.on('data', (chunk) => data += chunk);
  res.on('end', () => console.log(JSON.parse(data)));
});

req.write(postData);
req.end();
PHP (cURL)
<?php

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://api.apiverve.com/v1/mortgagecalculator');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'X-API-Key: your_api_key_here',
    'Content-Type: application/json'
]);

curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode({
    'amount': 570000,
    'rate': 6.8,
    'years': 30
}));

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
print_r($data);

?>
Go (net/http)
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))
}
Ruby (Net::HTTP)
require 'net/http'
require 'json'

uri = URI('https://api.apiverve.com/v1/mortgagecalculator')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

payload = {
  "amount": 570000,
  "rate": 6.8,
  "years": 30
}

request = Net::HTTP::Post.new(uri)
request['X-API-Key'] = 'your_api_key_here'
request['Content-Type'] = 'application/json'

request.body = payload.to_json

response = http.request(request)
puts JSON.pretty_generate(JSON.parse(response.body))
C# (HttpClient)
using System;
using System.Net.Http;
using System.Text;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("X-API-Key", "your_api_key_here");

        var jsonContent = @"{
        ""amount"": 570000,
        ""rate"": 6.8,
        ""years"": 30
}";
        var content = new StringContent(jsonContent, Encoding.UTF8, "application/json");

        var response = await client.PostAsync("https://api.apiverve.com/v1/mortgagecalculator", content);
        response.EnsureSuccessStatusCode();

        var responseBody = await response.Content.ReadAsStringAsync();
        Console.WriteLine(responseBody);
    }
}

Authentication

The Mortgage Calculator API requires authentication via API key. Include your API key in the request header:

Required Header
X-API-Key: your_api_key_here

Learn more about authentication →

Interactive 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

ParameterTypeRequiredDescriptionDefaultExample
amountnumberrequired
The loan amount
Range: min: 0
-200000
ratenumberrequired
The interest rate (percentage)
Range: 0 - 100
-4.5
yearsintegerrequired
The loan term in years
Range: 1 - 50
-30
downpaymentnumberoptional
The down payment amount
Range: min: 0
-15000
annual_propertytaxnumberoptional
The annual property tax amount
Range: min: 0
-2000
annual_homeinsurancenumberoptional
The annual home insurance amount
Range: min: 0
-1200
annual_hoanumberoptional
The annual HOA amount
Range: min: 0
-500

Response

The Mortgage Calculator API returns responses in JSON, XML, YAML, and CSV formats:

Example Responses

JSON Response
200 OK
{
  "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
      }
    ]
  }
}
XML Response
200 OK
<?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>
YAML Response
200 OK
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
CSV Response
200 OK
keyvalue
amount570000
downpayment0
rate6.8
years30
total_interest_paid767750.49
total_loan_payment1337750.49
interestRatio57.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:

FieldTypeDescriptionExample
statusstringIndicates whether the request was successful ("ok") or failed ("error")ok
errorstring | nullContains error message if status is "error", otherwise nullnull
dataobject | nullContains 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:

Response fields marked with Premium are available exclusively on paid plans.View pricing
FieldTypeSample ValueDescription
amountnumber570000Loan amount in dollars
downpaymentnumber0Down payment amount provided
ratenumber6.8Interest rate percentage used for calculation
yearsnumber30Loan term in years
total_interest_paidPremiumnumber767750.49Total interest paid over entire loan term
total_loan_paymentPremiumnumber1337750.49Total amount paid (principal + interest)
interestRatioPremiumnumber57.39Percentage of payment that is interest
monthly_paymentobject{...}-
â”” totalnumber3715.97Total monthly payment including all fees
â”” mortgagenumber3715.97Monthly mortgage payment (principal + interest)
â”” property_taxnumber0Monthly property tax portion of payment
â”” hoanumber0Monthly HOA fee portion of payment
â”” home_insurancenumber0Monthly home insurance portion of payment
annual_paymentobject{...}-
â”” totalnumber44591.68Total annual payment including all fees
â”” mortgagenumber44591.68Annual mortgage payment (principal + interest)
â”” property_taxnumber0Annual property tax portion of payment
â”” hoanumber0Annual HOA fee portion of payment
â”” home_insurancenumber0Annual home insurance portion of payment
formattedobject{...}-

Headers

Required and optional headers for Mortgage Calculator API requests:

Header NameRequiredExample ValueDescription
X-API-Keyrequiredyour_api_key_hereYour APIVerve API key. Found in your dashboard under API Keys.
Acceptoptionalapplication/jsonSpecify response format: application/json (default), application/xml, or application/yaml
User-AgentoptionalMyApp/1.0Identifies your application for analytics and debugging purposes
X-Request-IDoptionalreq_123456789Custom request identifier for tracking and debugging requests
Cache-Controloptionalno-cacheControl caching behavior for the request and response

Learn more about 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.

Test Mortgage Calculator in the GraphQL Explorer to confirm availability and experiment with queries.

Credit Cost: Each API called in your GraphQL query consumes its standard credit cost.

GraphQL Endpoint
POST https://api.apiverve.com/v1/graphql
GraphQL Query Example
query {
  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 supports Cross-Origin Resource Sharing (CORS) with wildcard configuration, allowing you to call Mortgage Calculator directly from browser-based applications without proxy servers.

CORS HeaderValueDescription
Access-Control-Allow-Origin*Accepts requests from any origin
Access-Control-Allow-Methods*Accepts any HTTP method
Access-Control-Allow-Headers*Accepts any request headers

Browser Usage: You can call Mortgage Calculator directly from JavaScript running in the browser without encountering CORS errors. No proxy server or additional configuration needed.

Learn more about CORS support →

Rate Limiting

Mortgage Calculator API requests are subject to rate limiting based on your subscription plan. These limits ensure fair usage and maintain service quality for all Mortgage Calculator users.

PlanRate LimitDescription
Free5 requests/minHard rate limit enforced - exceeding will return 429 errors
StarterNo LimitProduction ready - standard traffic priority
ProNo LimitProduction ready - preferred traffic priority
MegaNo LimitProduction ready - highest traffic priority

Learn more about rate limiting →

Rate Limit Headers

When rate limits apply, each Mortgage Calculator response includes headers to help you track your usage:

HeaderDescription
X-RateLimit-LimitMaximum number of requests allowed per time window
X-RateLimit-RemainingNumber of requests remaining in the current window
X-RateLimit-ResetUnix timestamp when the rate limit window resets

Handling Rate Limits

Free Plan: When you exceed your rate limit, Mortgage Calculator returns a 429 Too Many Requests status code. Your application should implement appropriate backoff logic to handle this gracefully.

Paid Plans: No rate limiting or throttling applied. All paid plans (Starter, Pro, Mega) are production-ready.

Best Practices for Mortgage Calculator:

  • Monitor the rate limit headers to track your Mortgage Calculator usage (Free plan only)
  • Cache mortgage calculator responses where appropriate to reduce API calls
  • Upgrade to Pro or Mega for guaranteed no-throttle Mortgage Calculator performance

Note: Mortgage Calculator rate limits are separate from credit consumption. You may have credits remaining but still hit rate limits when using Mortgage Calculator on Free tier.

Error Codes

The Mortgage Calculator API uses standard HTTP status codes to indicate success or failure:

CodeMessageDescriptionSolution
200OKRequest successful, data returnedNo action needed - request was successful
400Bad RequestInvalid request parameters or malformed requestCheck required parameters and ensure values match expected formats
401UnauthorizedMissing or invalid API keyInclude x-api-key header with valid API key from dashboard
403ForbiddenAPI key lacks permission or insufficient creditsCheck credit balance in dashboard or upgrade plan
429Too Many RequestsRate limit exceeded (Free: 5 req/min)Implement request throttling or upgrade to paid plan
500Internal Server ErrorServer error occurredRetry request after a few seconds, contact support if persists
503Service UnavailableAPI temporarily unavailableWait and retry, check status page for maintenance updates

Learn more about error handling →

Need help? Contact support with your X-Request-ID for assistance.

Integrate Mortgage Calculator with SDKs

Get started quickly with official Mortgage Calculator SDKs for your preferred language. Each library handles authentication, request formatting, and error handling automatically.

Available for Node.js, Python, C#/.NET, and Android/Java. All SDKs are open source and regularly updated.

Integrate Mortgage Calculator with No-Code API Tools

Connect the Mortgage Calculator API to your favorite automation platform without writing code. Build workflows that leverage mortgage calculator data across thousands of apps.

All platforms use your same API key to access Mortgage Calculator. Visit our integrations hub for step-by-step setup guides.

Frequently Asked Questions

How do I get an API key for Mortgage Calculator?
Sign up for a free account at dashboard.apiverve.com. Your API key will be automatically generated and available in your dashboard. The same key works for Mortgage Calculator and all other APIVerve APIs. The free plan includes 1,000 credits plus a 500 credit bonus.
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?
Yes! The Mortgage Calculator API supports CORS with wildcard configuration, so you can call it directly from browser-based JavaScript without needing a proxy server. See the CORS section above for details.
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.

What's Next?

Continue your journey with these recommended resources

Was this page helpful?