Mortgage RateMortgage Rate API

OnlineCredit Usage:1 per callRefreshed 5 days ago
avg: 463ms|p50: 438ms|p75: 480ms|p90: 530ms|p99: 630ms

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

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

Example

How to call the Mortgage Rate API in different programming languages.

cURL Request
curl -X GET \
  "https://api.apiverve.com/v1/mortgagerate?type=30year&year=2023&month=6" \
  -H "X-API-Key: your_api_key_here"
JavaScript (Fetch API)
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);
Python (Requests)
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)
Go (net/http)
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))
}
Example 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"
  }
}

Authentication

The Mortgage Rate 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 Rate API directly in your browser with live requests and responses.

Parameters

The following parameters are available for the Mortgage Rate API:

Some Mortgage Rate parameters marked with Premium are available exclusively on paid plans.View pricing

Get Mortgage Rate

ParameterTypeRequiredDescriptionDefaultExample
typestringrequired
The mortgage type
Supported values: 30year15year
-30year
yearPremiumintegeroptional
Year to retrieve rates for (1971-present). Requires month parameter.
Range: 1971 - 2030
-2023
monthPremiumintegeroptional
Month to retrieve rates for (1-12). Required when year is specified.
Range: 1 - 12
-6

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 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>
    <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>
YAML Response
200 OK
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'
CSV Response
200 OK
keyvalue
rateType30year
name30-Year Fixed Rate Mortgage
term30
typefixed
countryUS
year2023
month6
count4
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
changeDirectiondown
previousRate6.69
previousDate2023-06-15

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
rateTypestring"30year"
Mortgage rate type identifier (30year or 15year)
namestring"30-Year Fixed Rate Mortgage"
Human-readable description of mortgage type
termnumber30
Loan term in years (15 or 30)
typestring"fixed"
Rate type classification (fixed or adjustable)
countrystring"US"
Country code where rates apply (US)
yearnumber2023
Year of the mortgage rate data
monthnumber6
Month of the mortgage rate data (1-12)
countnumber4
Number of weekly rate entries in response
[ ] Array items:array[4]Array of objects
Array of weekly mortgage rate data entries
â”” weekstring"2023-06-01"
-
â”” ratenumber6.79
-
change1wPremiumnumber-0.02
Rate change from previous week in percentage points
changeDirectionstring"down"
Direction of weekly change: up, down, or unchanged
previousRatePremiumnumber6.69
Previous week's mortgage interest rate
previousDatePremiumstring"2023-06-15"
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.

Test Mortgage Rate 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 {
  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?
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 Rate and all other APIVerve APIs. The free plan includes 1,000 credits plus a 500 credit bonus.
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?
Yes! The Mortgage Rate 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 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.

What's Next?

Continue your journey with these recommended resources

Was this page helpful?