Mortgage Rate API
Overview
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/mortgagerateExample
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)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))
}{
"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"
}
}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. 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>
<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
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 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 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 Rate 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 Rate 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 Rate
Official Mortgage Rate packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →
No-Code Integrations
Mortgage Rate 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 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.








