Sandbox API

Introduction

With v4 of the Estated Property API comes Sandbox API, a free endpoint to test your code against. Gain confidence in your code by using Estated's Sandbox API.

With Estated's Sandbox API, you have access to a subset of properties to write integration tests against without being billed for each API call. Our team has curated a list of 120 properties, some intentionally providing error responses, so you can run your test suite and confirm what you built works.

Endpoint and API Keys

Note: The property API key will not work with the Sandbox API. A separate sandbox API key is generated for you when you first sign up.

The endpoint for the Sandbox API is:

Using your Sandbox API key and the sandbox endpoint URL, all that is left is to form a valid request by using the request format that suits your application and you are ready to write some tests.

An example sandbox call using the combined address request type looks like this:

https://sandbox.estated.com/v4/property?token=YOUR_TOKEN_HERE&combined_address=1867+Gatewood+Dr,+Montgomery,+AL+36106

Error Responses

For the structure of an error response, please refer to the Error Response section.

The table below lists all properties that when queried will return an error response.

Warning Responses

For the structure of a warning response, please refer to the Warning Response section.

The table below lists all properties that when queried will return a warning response.

Success Responses

Here is the list of address which will return property data.

Note: Addresses are case insensitive, however, no corrections or abbreviations are performed.

Note: APNs are format and case insensitive.