Property Data API Overview

Request

Properties can be requested by a variety of methods. Choose the method below based on what works best for your application. All request types are HTTP GET requests.

Conforming address type:

https://api.estated.com/property/v3?token={ YOUR_API_TOKEN_HERE }&address=151+Battle+Green+Dr&city=Rochester&state=NY&zipcode=14624

Required fields:

  • address
  • city
  • state

Optional fields:

  • zipcode
  • format=xml

Fully qualified type:

https://api.estated.com/property/v3?token={ YOUR_API_TOKEN_HERE }&unit_number=101&street_number=1651&street_name=North+Dayton&street_suffix=Street&city=Chicago&state=IL&zipcode=60614

Required fields:

  • street_number
  • street_name
  • street_suffix
  • city
  • state

Optional fields:

  • unit_number
  • street_direction
  • zipcode
  • format=xml

Conjoined address type:

https://api.estated.com/property/v3?token={ YOUR_API_TOKEN_HERE }&conjoined_address=151+Battle+Green+Dr,Rochester,NY+14624

Elements in string, separated by commas. Optional elements in brackets:

  • (unit number +) street number + street name + street suffix
  • city
  • state + zipcode
  • (format=xml)

FIPS code + APN:

https://api.estated.com/property/v3?token={ YOUR_API_TOKEN_HERE }&fips=06037&apn=4328031029

Required fields:

  • fips (5-digit county fips code)
  • apn

Optional fields:

  • format=xml

UPI:

https://api.estated.com/property/v3?token={ YOUR_API_TOKEN_HERE }&upi=US-06037-N-4328031029-R-N

Required fields:

  • upi

Optional fields:

  • format=xml

Response

By default, all responses are returned as JSON unless the optional parameter format=xml is provided in the request. Responses include a status with a string value to indicate success or error. In the case of a successful response, a properties array with a list of all properties is included with the response body. Otherwise a human readable error message will be provided.

Successful response:

{
    "success": true,
    "codes": {},
    "properties": [{ ... }]
}

Error response: (View error codes)

{
    "success": false,
    "codes": {
        "RE01": "Missing token"
    }
}

Property object

A full property object has the following characteristics:

"properties": [{
    "metadata": { ... },
    "addresses": [{ ... }],
    "parcel": { ... },
    "land_use": { ... },
    "structures": { ... },
    "structure_totals": { ... },
    "owners": { ... },
    "assessments": { ... },
    "sales": { ... },
    "mortgages": { ... },
    "legal": { ... },
    "valuation": { ... },
    "status": { ... },
    "postal": { ... },
    "geographies": { ... }
}]

Click here for the property object schema


Return values

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
Integer 0 NULL Natural number
Decimal 0 NULL Decimal number
String Empty string NULL String
Boolean false NULL true/false
Date NULL NULL YYYY-MM-DD
Datetime NULL NULL YYYY-MM-DD HH:MM:SS
JSON string [{"field":""}] [{"field":NULL}] [{"field":"value"}]

Error Codes

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. Error codes will be provided in an error response.

Error Code Description
RE01: Missing token No key was provided in the token parameter of the request.
RE02: Invalid token Key supplied in the token parameter of the request is not a valid key.
RE03: Deactivated token Key supplied in the token parameter of the request has been deactivated.
RE04: Missing search parameters There was not enough search parameters supplied to complete the request.
GE01: No calls remaining. Key supplied in the token parameter of the request has reached its call limit.
AE01: Could not parse address. The supplied address is not in a valid format.
PE01: No results found. We were unable to find results for the request.

Information Codes

Information codes appear with successful responses when additional information may need to be communicated. For example, if the entered request parameters were processed and adjusted to find a match, instead of an exact match, we want to communicate that to you.

Information Code Description
AC01: Address corrected. The address parameters provided contained errors and was adjusted accordingly.