Welcome to the documentation. We have created a simple, easy to use API and have done our best to document each feature here.
Values returned will match the data type as specified for each field in the schema (integer, string, decimal, etc). The possible values for each datatype is shown below.
Absence describes when it is known that a feature does not exist, Unknown describes when the data could not be found. For example, if a property does not have a garage, the garage_size field will return "0". If we don't have data on whether it has a garage or not, the return value will be NULL.
|Data type||Absence||Unknown (data unavailable)||Value|
|Datetime||Empty string||NULL||YYYY-MM-DD HH:MM:SS|
Errors happen either because of a problem occurred with the key or the request. The level at which the result provides an error differs based on where the error occurs within the request.
|No key provided||No key was provided in the
|Invalid Key||Key supplied in the
|Key disabled||Key supplied in the
|Trial limit reached||Key supplied in the
|Unpaid account||The account which owns the key has an unpaid balance.|
|Missing search parameters||There was not enough search parameters supplied to complete the request.|
|No results||We were unable to find results for the request.|
|Failed||General failure, usually specific to an internal problem with the api (rare occurrence).|
Properties can be requested by a variety of methods. Choose the method below based on what works best for your application.
Conforming address type:
Fully qualified type:
Elements in string, separated by commas. Optional elements in brackets:
- (unit number + unit type) + street number + street name + street suffix
- state + zipcode
Responses include a result with a status, and an error message if applicable. The second parameter of the response will be the property object if the result status is successful, or a null value otherwise.
Error response: (View error codes)
The property object
A successful call will include a property object.
The address_match field indicates how closely the result matches the parameters of the requested property. There are three possible result codes:
exact - The result is an exact match for the request.
close - An exact match wasn’t possible, but a result that closely matches the address was found.
guess - Multiple results were possible from the request parameters, a result was returned out of the possible properties based on a best guess algorithm.
Note: If we did not find any results for the requested address, that will be returned in the
result portion of the response, with a 404 error code.