Estated v0.2.0 API Reference

Modules

Elixir client for the Estated v4 API.

Errors happen either because a problem occured 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.

A property record.

Address details as provided by the assessor.

Tax assessment information as provided by the assessor.

Sale and mortgage data which constitute a deed record.

Market assessment information as provided by the assessor.

Metadata related to the property.

Current owner details taken from either the assessment.

Parcel details as provided by the assessor.

Information about the building(s) on the parcel.

Area within a building.

Feature in or around a building.

Improvement to a property or building.

Tax record as provided by the assessor.

Valuation details as provided by a proprietary valuation algorithm.

Request a property with address in a single String.t/0.

Request a property with both a FIPS code and APN.

Request a property with an address fully parsed into its elements.

Request a property with a combined street address and a separate city, state, and zip code.

The top-level response from the Estated v4 API.

Metadata related to the request.

Warnings happen because the input address was unable to be reconciled to a single property, either because the address could not be found, or a property could not be matched to a successfully parsed address.

Metadata related to the warning.

Part of a multiple property found warning.