Mortgage Rate API
Mortgage Rate is a tool for retrieving current and historical US fixed-rate mortgage rates. It returns weekly average rates for 30-year and 15-year fixed mortgages from the Freddie Mac Primary Mortgage Market Survey.
The Mortgage Rate API provides reliable and fast access to mortgage rate data through a simple REST interface. Built for developers who need consistent, high-quality results with minimal setup time.
To use Mortgage Rate, you need an API key. You can get one by creating a free account and visiting your dashboard.
GET Endpoint
https://api.apiverve.com/v1/mortgagerateCode Examples
Here are examples of how to call the Mortgage Rate API in different programming languages:
curl -X GET \
"https://api.apiverve.com/v1/mortgagerate?type=30year&year=2023&month=6" \
-H "X-API-Key: your_api_key_here"const response = await fetch('https://api.apiverve.com/v1/mortgagerate?type=30year&year=2023&month=6', {
method: 'GET',
headers: {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
});
const data = await response.json();
console.log(data);import requests
headers = {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
response = requests.get('https://api.apiverve.com/v1/mortgagerate?type=30year&year=2023&month=6', headers=headers)
data = response.json()
print(data)const https = require('https');
const url = require('url');
const options = {
method: 'GET',
headers: {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
};
const req = https.request('https://api.apiverve.com/v1/mortgagerate?type=30year&year=2023&month=6', options, (res) => {
let data = '';
res.on('data', (chunk) => data += chunk);
res.on('end', () => console.log(JSON.parse(data)));
});
req.end();<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.apiverve.com/v1/mortgagerate?type=30year&year=2023&month=6');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'X-API-Key: your_api_key_here',
'Content-Type: application/json'
]);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://api.apiverve.com/v1/mortgagerate?type=30year&year=2023&month=6", nil)
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))
}require 'net/http'
require 'json'
uri = URI('https://api.apiverve.com/v1/mortgagerate?type=30year&year=2023&month=6')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['X-API-Key'] = 'your_api_key_here'
request['Content-Type'] = 'application/json'
response = http.request(request)
puts JSON.pretty_generate(JSON.parse(response.body))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 response = await client.GetAsync("https://api.apiverve.com/v1/mortgagerate?type=30year&year=2023&month=6");
response.EnsureSuccessStatusCode();
var responseBody = await response.Content.ReadAsStringAsync();
Console.WriteLine(responseBody);
}
}Authentication
The Mortgage Rate 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 Rate API directly in your browser with live requests and responses.
Parameters
The following parameters are available for the Mortgage Rate API:
Get Mortgage Rate
| Parameter | Type | Required | Description | Default | Example |
|---|---|---|---|---|---|
type | string | required | The mortgage type Supported values: 30year15year | - | |
yearPremium | integer | optional | Year to retrieve rates for (1971-present). Requires month parameter. Range: 1971 - 2030 | - | |
monthPremium | integer | optional | Month to retrieve rates for (1-12). Required when year is specified. Range: 1 - 12 | - |
Response
The Mortgage Rate API returns responses in JSON, XML, YAML, and CSV formats:
Example Responses
{
"status": "ok",
"error": null,
"data": {
"rateType": "30year",
"name": "30-Year Fixed Rate Mortgage",
"term": 30,
"type": "fixed",
"country": "US",
"year": 2023,
"month": 6,
"count": 4,
"rates": [
{
"week": "2023-06-01",
"rate": 6.79
},
{
"week": "2023-06-08",
"rate": 6.71
},
{
"week": "2023-06-15",
"rate": 6.69
},
{
"week": "2023-06-22",
"rate": 6.67
}
],
"change1w": -0.02,
"changeDirection": "down",
"previousRate": 6.69,
"previousDate": "2023-06-15"
}
}<?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>
<rateType>30year</rateType>
<name>30-Year Fixed Rate Mortgage</name>
<term>30</term>
<type>fixed</type>
<country>US</country>
<year>2023</year>
<month>6</month>
<count>4</count>
<rates>
<rate>
<week>2023-06-01</week>
<rate>6.79</rate>
</rate>
<rate>
<week>2023-06-08</week>
<rate>6.71</rate>
</rate>
<rate>
<week>2023-06-15</week>
<rate>6.69</rate>
</rate>
<rate>
<week>2023-06-22</week>
<rate>6.67</rate>
</rate>
</rates>
<change1w>-0.02</change1w>
<changeDirection>down</changeDirection>
<previousRate>6.69</previousRate>
<previousDate>2023-06-15</previousDate>
</data>
</response>
status: ok
error: null
data:
rateType: 30year
name: 30-Year Fixed Rate Mortgage
term: 30
type: fixed
country: US
year: 2023
month: 6
count: 4
rates:
- week: '2023-06-01'
rate: 6.79
- week: '2023-06-08'
rate: 6.71
- week: '2023-06-15'
rate: 6.69
- week: '2023-06-22'
rate: 6.67
change1w: -0.02
changeDirection: down
previousRate: 6.69
previousDate: '2023-06-15'
| key | value |
|---|---|
| rateType | 30year |
| name | 30-Year Fixed Rate Mortgage |
| term | 30 |
| type | fixed |
| country | US |
| year | 2023 |
| month | 6 |
| count | 4 |
| rates | [{week:2023-06-01,rate:6.79},{week:2023-06-08,rate:6.71},{week:2023-06-15,rate:6.69},{week:2023-06-22,rate:6.67}] |
| change1w | -0.02 |
| changeDirection | down |
| previousRate | 6.69 |
| previousDate | 2023-06-15 |
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 |
|---|---|---|---|
rateType | string | Mortgage rate type identifier (30year or 15year) | |
name | string | Human-readable description of mortgage type | |
term | number | Loan term in years (15 or 30) | |
type | string | Rate type classification (fixed or adjustable) | |
country | string | Country code where rates apply (US) | |
year | number | Year of the mortgage rate data | |
month | number | Month of the mortgage rate data (1-12) | |
count | number | Number of weekly rate entries in response | |
| [ ] Array items: | array[4] | Array of weekly mortgage rate data entries | |
â”” week | string | - | |
â”” rate | number | - | |
change1wPremium | number | Rate change from previous week in percentage points | |
changeDirection | string | Direction of weekly change: up, down, or unchanged | |
previousRatePremium | number | Previous week's mortgage interest rate | |
previousDatePremium | string | Previous week's date in YYYY-MM-DD format |
Headers
Required and optional headers for Mortgage Rate API requests:
| Header Name | Required | Example Value | Description |
|---|---|---|---|
X-API-Key | required | your_api_key_here | Your APIVerve API key. Found in your dashboard under API Keys. |
Accept | optional | application/json | Specify response format: application/json (default), application/xml, or application/yaml |
User-Agent | optional | MyApp/1.0 | Identifies your application for analytics and debugging purposes |
X-Request-ID | optional | req_123456789 | Custom request identifier for tracking and debugging requests |
Cache-Control | optional | no-cache | Control caching behavior for the request and response |
GraphQL AccessALPHA
Access Mortgage Rate through GraphQL to combine it with other API calls in a single request. Query only the mortgage rate 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 {
mortgagerate(
input: {
type: "30year"
year: 2023
month: 6
}
) {
rateType
name
term
type
country
year
month
count
rates
change1w
changeDirection
previousRate
previousDate
}
}Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.
CORS Support
The Mortgage Rate API supports Cross-Origin Resource Sharing (CORS) with wildcard configuration, allowing you to call Mortgage Rate directly from browser-based applications without proxy servers.
| CORS Header | Value | Description |
|---|---|---|
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 Rate directly from JavaScript running in the browser without encountering CORS errors. No proxy server or additional configuration needed.
Rate Limiting
Mortgage Rate API requests are subject to rate limiting based on your subscription plan. These limits ensure fair usage and maintain service quality for all Mortgage Rate users.
| Plan | Rate Limit | Description |
|---|---|---|
| Free | 5 requests/min | Hard rate limit enforced - exceeding will return 429 errors |
| Starter | No Limit | Production ready - standard traffic priority |
| Pro | No Limit | Production ready - preferred traffic priority |
| Mega | No Limit | Production ready - highest traffic priority |
Learn more about rate limiting →
Rate Limit Headers
When rate limits apply, each Mortgage Rate response includes headers to help you track your usage:
| Header | Description |
|---|---|
X-RateLimit-Limit | Maximum number of requests allowed per time window |
X-RateLimit-Remaining | Number of requests remaining in the current window |
X-RateLimit-Reset | Unix timestamp when the rate limit window resets |
Handling Rate Limits
Free Plan: When you exceed your rate limit, Mortgage Rate 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 Rate:
- Monitor the rate limit headers to track your Mortgage Rate usage (Free plan only)
- Cache mortgage rate responses where appropriate to reduce API calls
- Upgrade to Pro or Mega for guaranteed no-throttle Mortgage Rate performance
Note: Mortgage Rate rate limits are separate from credit consumption. You may have credits remaining but still hit rate limits when using Mortgage Rate on Free tier.
Error Codes
The Mortgage Rate API uses standard HTTP status codes to indicate success or failure:
| Code | Message | Description | Solution |
|---|---|---|---|
200 | OK | Request successful, data returned | No action needed - request was successful |
400 | Bad Request | Invalid request parameters or malformed request | Check required parameters and ensure values match expected formats |
401 | Unauthorized | Missing or invalid API key | Include x-api-key header with valid API key from dashboard |
403 | Forbidden | API key lacks permission or insufficient credits | Check credit balance in dashboard or upgrade plan |
429 | Too Many Requests | Rate limit exceeded (Free: 5 req/min) | Implement request throttling or upgrade to paid plan |
500 | Internal Server Error | Server error occurred | Retry request after a few seconds, contact support if persists |
503 | Service Unavailable | API temporarily unavailable | Wait 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 Rate with SDKs
Get started quickly with official Mortgage Rate 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 Rate with No-Code API Tools
Connect the Mortgage Rate API to your favorite automation platform without writing code. Build workflows that leverage mortgage rate data across thousands of apps.





All platforms use your same API key to access Mortgage Rate. Visit our integrations hub for step-by-step setup guides.
Frequently Asked Questions
How do I get an API key for Mortgage Rate?
How many credits does Mortgage Rate cost?
Each successful Mortgage Rate 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 rate lookups.
Can I use Mortgage Rate in production?
The free plan is for testing and development only. For production use of Mortgage Rate, 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 Rate from a browser?
What happens if I exceed my Mortgage Rate credit limit?
When you reach your monthly credit limit, Mortgage Rate 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.



