Skip to main content

Getting Started

Authentication​

Authentication serves as the key to unlocking the potential of the RateSpot API. Most of the API's features and endpoints are secured by an API key, ensuring the security and controlled access to valuable mortgage data.

To access the API and harness its capabilities, you must obtain an API key. This unique key acts as your passport, allowing you to unlock various functionalities and securely retrieve mortgage product information and historical pricing data.

caution

Your API key is confidential and should be kept secure at all times. Do not share your API key with anyone, as it can be used to access your account and data.

Follow the steps below to obtain your API key:

  1. Log in to your RateSpot App account using your registered email and password.

    Log in to RateSpot App

    If you don't have an account yet, you can sign up for a free account to get started.

    Sign up for RateSpot App

  2. Once authenticated, navigate to the Account Settings section.

    Account Settings

  3. Click on the Copy API Key button to copy your API key to your clipboard.

  4. Make sure to keep your API key confidential to maintain the security of your account and data.

With your API key in hand, you're ready to make your first request!

Making Your First Request​

Let's start by making a simple request to retrieve a list of available mortgage products in California. Copy the following URL, paste it into a new browser tab or window, and replace YOUR_API_KEY with your actual API key. Then, press Enter to execute the request.

GET
https://api.ratespot.io/v1/api?apikey=YOUR_API_KEY&state=CA

You should see a response similar to the following:

Example response
{
  "data": [
    {
      "apr": 8.233,
      "credit_score": 650,
      "down_payment": 77151.0,
      "is_jumbo": false,
      "lender_name": "WesLend Financial",
      "load_datetime": "Wed, 18 Oct 2023 03:56:46 GMT",
      "mat_years": "30",
      "mo_payment": 2264.42,
      "mortgage_type": "purchase",
      "nmls": "3304",
      "points": 1.671,
      "purchase_price": 385754.0,
      "rate": 8.0,
      "rate_desc": "30 year fixed",
      "rate_lock_used": "30",
      "upfront_costs": 6711.76,
      "zipcode": 94565
    },
    {
      "apr": 7.748,
      "credit_score": 650,
      "down_payment": 271064.0,
      "is_jumbo": false,
      "lender_name": "District Lending",
      "load_datetime": "Wed, 18 Oct 2023 03:37:48 GMT",
      "mat_years": "20",
      "mo_payment": 3122.0,
      "mortgage_type": "Purchase",
      "nmls": "598623",
      "points": -0.272,
      "purchase_price": 677660.0,
      "rate": 6.875,
      "rate_desc": "PERIOD_FIXED_20YEARS",
      "rate_lock_used": "30",
      "upfront_costs": 6009.0,
      "zipcode": 94605
    }
    // ...
  ],
  "error": null,
  "message": null,
  "results": {
    "current_page": 1,
    "next_page": "https://api.ratespot.io/v1/api?apikey=YOUR_API_KEY&state=CA&interval=4&limit=1000&offset=2",
    "pages": 3,
    "results_per_page": 1000,
    "total": 2384
  }
}

Congratulations! You've just made your first request to the RateSpot API.

What's Next?​

Now that you've learned the basic steps to get started, you're ready to explore the RateSpot API's functionalities. The following sections will provide detailed information on the available endpoints, data retrieval, and more.