Realty Mole Migration Guide

If you are using our legacy Realty Mole API or Rent Estimate API hosted on the RapidAPI portal, we recommend migrating to our new RentCast API endpoints as soon as possible.

These legacy APIs are now deprecated and will no longer receive new features or updates. They are scheduled to be shut down on March 1st, 2025, and will permanently cease to function after this date.

Our new RentCast API provides access to the same endpoints and data sets, and comes with new data points, query parameters and other enhancements. This will be our primary API product going forward, and we will be adding new features to it in future releases.

We anticipate the below migration process to take 1-2 hours for most integrations, and the type of data you can access will not change after completing it.

Step 1: Create a RentCast Account and API Keys

Follow the steps outlined in this guide to create your RentCast account and set up new API keys for your integrations. You can create as many API keys as you like.

📘

You will not be able to re-use existing RapidAPI keys when using the RentCast API. You will need to create a new set of API keys on your API dashboard and update your integrations accordingly.

Step 2: Activate Your New Billing Plan

If you were previously subscribed to the Basic (free) plan for our legacy APIs on the RapidAPI portal, then you can subscribe to the Developer (free) RentCast API plan, which comes with the same 50 free API requests per month you were receiving before.

If you had a paid plan on the RapidAPI portal, first subscribe to the Developer RentCast API plan on your API dashboard, and then contact us via the live chat at the bottom right of this website (or via email at [email protected]), and we will help you migrate your old plan to our new platform.

While we will not be able to provide you with the exact same billing plan you had previously, we will do our best to set up pricing and API request limits that are very close to what you were receiving before.

📘

You can check your current billing plan on the RapidAPI portal for the Realty Mole API right here, and for the Rent Estimate API right here.

Step 3: Update Request URLs

Reference the tables below and update the URLs of your requests to the ones provided by our new API:

Realty Mole API (Old Docs)

Rent Estimate API (Old Docs)

Step 4: Update Authentication Headers

The RentCast API requires a single HTTP authentication header X-Api-Key, where you need to provide the new API key you created in Step 1.

You no longer need to provide the X-RapidAPI-Key and X-RapidAPI-Host headers in your requests.

Step 5: Update Request Handlers

There have been several changes and improvements both to the query parameters supported by our new API endpoints, as well as to the format of their responses.

Below is a list of general and endpoint-specific changes that you may need to implement if you are using those endpoints in your integrations:

General Changes

• The "Duplex-Triplex" propertyType has been renamed to "Multi-Family", both in the corresponding query parameters and in all API responses
• All of our API endpoints now use miles as a unit of distance instead of kilometers, both in the query parameters and in all API responses
• Our API endpoints now return errors in a more standardized object format, as described right here. If you were previously relying on specific strings in error responses, we recommend re-testing that code and making the necessary changes

Property Records (New Docs)

• When providing the radius query parameter, it should be provided in miles instead of kilometers. The maximum radius is now 100 miles
• When providing the propertyType query parameter for 2-4 unit properties, use "Multi-Family" instead of "Duplex-Triplex"
• The taxAssessment response field has been renamed to taxAssessments

Random Property Records (New Docs)

• The taxAssessment response field has been renamed to taxAssessments

Property Record by Id (New Docs)

• The taxAssessment response field has been renamed to taxAssessments

Property Value Estimate (New Docs)

• When providing the radius query parameter, it should be provided in miles instead of kilometers
• When providing the propertyType query parameter for 2-4 unit properties, use "Multi-Family" instead of "Duplex-Triplex"
• The listings response field has been renamed to comparables
• Comparable properties now return the addressLine1 and addressLine2 response fields, which contain their street address information. The legacy address response field is no longer returned
• The zipcode response field for comparable properties has been renamed to zipCode
• The publishedDate response field for comparable properties has been renamed to lastSeenDate

Property Rent Estimate (New Docs)

• When providing the radius query parameter, it should be provided in miles instead of kilometers
• When providing the propertyType query parameter for 2-4 unit properties, use "Multi-Family" instead of "Duplex-Triplex"
• The listings response field has been renamed to comparables
• Comparable properties now return the addressLine1 and addressLine2 response fields, which contain their street address information. The legacy address response field is no longer returned
• The zipcode response field for comparable properties has been renamed to zipCode
• The publishedDate response field for comparable properties has been renamed to lastSeenDate

Sale Listings (New Docs)

• When providing the radius query parameter, it should be provided in miles instead of kilometers. The maximum radius is now 100 miles
• When providing the propertyType query parameter for 2-4 unit properties, use "Multi-Family" instead of "Duplex-Triplex"
• When retrieving single listings using the address query parameter, the response will always be an array instead of an object
• The lastSeen response field has been renamed to lastSeenDate

Sale Listing by Id (New Docs)

• The lastSeen response field has been renamed to lastSeenDate

Rental Listings (New Docs)

• When providing the radius query parameter, it should be provided in miles instead of kilometers. The maximum radius is now 100 miles
• When providing the propertyType query parameter for 2-4 unit properties, use "Multi-Family" instead of "Duplex-Triplex"
• When retrieving single listings using the address query parameter, the response will always be an array instead of an object
• The lastSeen response field has been renamed to lastSeenDate

Rental Listing by Id (New Docs)

• The lastSeen response field has been renamed to lastSeenDate

Market Data (New Docs)

• Instead of providing a zip code as a URL path parameter, you should now provide it in the zipCode query parameter
• This endpoint may now return a successful response with an absent rentalData field instead of returning an error, when only sale market data is available for the specified zip code. Use the dataType query parameter with a value of "Rental" to preserve the old behavior
• This endpoint no longer returns all historical data by default, instead only returning the 12 most recent months. You can use the historyRange query parameter to retrieve historical data older than 12 months
• The totalRentals response field has been renamed to totalListings
• The detailed response field has been renamed to dataByBedrooms

Step 6: Test and Deploy Your Changes

Once you've implemented the changes described above, we recommend thoroughly testing your integrations and resolving any issues before deploying them to production.

Our support team is available 7 days a week to answer your questions and provide help if needed. You can contact us by launching the live chat at the bottom right of this website, or by sending an email to [email protected].

Step 7: Cancel Your RapidAPI Subscription

Once you've fully migrated to our new API, we suggest canceling your legacy RapidAPI subscription to avoid duplicate charges.

You can do that from your RapidAPI dashboard, under Billing > Subscription & Usage.

📘

Note, that we are not able to issue pro-rated refunds for cancelled RapidAPI subscriptions.