ATTOM API: Immediate access to the property data you need

Steps for Getting Started

1. Create your free trial account on the Attom Developer Platform to get an API key to use when calling the API.

2. Explore the details of our APIs to get a better idea of the data available in each and the calls you would use to collect the data.

3. Use our interactive docs to make sample API calls and use our guides to get started with Curl or Postman.

4. Speed up your development with our content templates to plug into your application. View them here.

Guides

Getting Started with cURL - This guide covers the basics like displaying properties within a particular city, looking at a property’s valuation and displaying recent sale prices within a given neighborhood.

Postman Guide - Postman is a Web REST client that allows you to enter and monitor HTTP requests and responses. It is available in the Chrome Web Store and is a great way to get familiar with our APIs and the data returned by different calls.

Postman Examples- Once you have setup your Postman environment, you can import pre-built collections for the Property and Area APIs.

• Property API Examples
• Area API Examples

Need some inspiration? Our Chief Solutions Architect built a demo app using the APIs. Are you building something cool? We’d love to hear about it!

Building a full application means getting to know the various resources and packages in the API. The following are the most important concepts that we go into more detail about below in the documentation.

1. URL Structure
2. Headers
3. Resources & Packages
4. Default Behavior
5. Search & Sorting
   1. Some example requests

   Security

   All requests to all endpoints require you to specify your unique API key. The API Key is assigned to you by Attom and is used to identify and authorize each request. Your API key should be kept private, and should never be displayed publicly.

   Response Codes

   All successful responses are returned in JSON or XML, depending on the response format you request. Only queries that respond with a 200 response code (successfully completed), are counted towards monthly allowances and overages. Beyond standard HTTP codes you will find custom status codes in the “Status” element of the response body.

   
   
   Status Code

   Description

   200 OK

   Standard HTTP successful response

   400 Bad Request

   Standard HTTP invalid request response

   401 Unauthorized

   Standard HTTP unauthorized access response

   500 Internal Server Error
    

   There was an unexpected error on our server. If you see this please contact datacustomercare@attomdata.com

Property API

Overview

The Property API provides access to a comprehensive portfolio of property-centric data

Data Sources

The comprehensive portfolio of property data provided in the Property API is sourced from ATTOM Cloud. Please refer to our Data Guide for more information:

• Hazard
• Transportation Noise
• Neighborhood
• School District Profile
• School Profile
• Property
• Addresses
• Building Permits
• Current Owner
• Property Characteristics
• Property Tax
• Transaction
• Deed and Mortgage
• Home Sales Trend
• Preforeclosures
• Valuation
• Assessed Values
• AVM
• Home Equity

Interactive Docs

API Structure

Production Endpoint

The main endpoint for the property search engine API is:

https://api.gateway.attomdata.com/propertyapi/v1.0.0/Resource/Package?{parameters}

Example

https://api.gateway.attomdata.com/propertyapi/v1.0.0/property/detail?id=1234

Headers

There are two required headers:

1. Accept - set to either
   1. application/json
   2. application/xml
2. APIKey - include the API Key assigned to you.

Resources & Packages

Our data is organized into a set of resources. While all resources ultimately relate to a property (or piece of real estate) they contain different topics. We have also created “Packages” that summarize specific fields for ease of use. The packages available depend on the type of data (resource) being searched. You’ll find the available Resources and Packages below.

Resources

PROPERTY

Use the /property resource to get detailed property characteristics for a property or list of properties.

SALES TREND

Use the /salestrend resource to get two years of average or median sale price and sale counts within a zip code for monthly, quarterly, and yearly intervals.

SCHOOL

Use the /school resource to get schools within attendance zones around a property, private and public schools within a radius and school details. Note that some schools are not associated with a school district because of a variety of rules in different state. View the list here.

ASSESSMENT

Use the /assessment resource to get assessments, assessed values and taxes on a property or list of properties.

AVM

Use the /attomavm resource to display the “automated valuation model” (AVM) calculation of a property or list of properties.

SALE

Use the /sale resource to return information pertaining to the most recent sale of a property or list of properties.

SALES HISTORY

Use the /saleshistory resource to get information about the sales history of a property. Recorded sales history data can be found based on a property’s ID or address.

Note: This is accessible for a single property per request.

ALL EVENTS

Use the /allevents resource to get information about all events that have occurred on a specific property. This includes assessments, AVM and sales transactions. Note: This is accessible for a single property per request.

Packages

The table below shows what packages are available for each resource with a brief descriptions.

Default Behavior

There is some default behavior to be aware of:

Search Filters

In addition to Resources and Packages, there are also a number of other filters that may be added to a request to help narrow down results. The filters and some examples of how they might be used are outlined below.

If you are looking to add multiple filters to your query, you can add pipe delineation ("|") to your API call. For example, if you wanted to search for single family resident and apartment property types, you could add "&propertytype=sfr|apartment" to your query to return results for both types.

Search Filter Examples

Show me all of the properties that have an assessed total value within this range that are within this ZIP Code.

https://api.gateway.attomdata.com/propertyapi/v1.0.0/assessment/detail?postalcode=11215&minAssdTtlValue=1000000&maxAssdTtlValue=2500000

Show me all of the properties that have sold during a specified time frame within this neighborhood.

https://api.gateway.attomdata.com/propertyapi/v1.0.0/sale/snapshot?startSaleSearchDate=2015/05/01&endSaleSearchDate=2015/08/31&geoIdV4=6828b00047035292dd47fe020e636bb3

Show me all the properties that fall within a radius of this point.

https://api.gateway.attomdata.com/propertyapi/v1.0.0/property/snapshot?latitude=30.2500&longitude=-97.7500&radius=2

Order By (Sorting Results)

Sort Examples

Show me all of the properties that have sold within the radius of a specific point and are sorted in descending order by their sale amount.

https://api.gateway.attomdata.com/propertyapi/v1.0.0/sale/snapshot?latitude=30.2500&longitude=-97.7500&radius=2&orderBy=saleAmt+desc

Show me all of the single family residences within this zip code ordered by their number of bedrooms in descending order.

https://api.gateway.attomdata.com/propertyapi/v1.0.0/property/detail?postalcode=78704&propertytype=sfr&orderBy=beds+desc

Show me all the assessments made on properties within the radius of a specific point ordered by their distance from the point.

https://api.gateway.attomdata.com/propertyapi/v1.0.0/assessment/snapshot?latitude=39.731234&longitude=-75.581182&radius=1&orderby=distance+ASC

Pagination

Standard Response Information

A standard response from the property API will include the following structure to help you handle different response codes, page sizes, and number of records. This can be found at the top of the response:

{

"status": {

"version": "1.0.0",

"code": 0,

"msg": "SuccessWithResult",

"total": 1,

"page": 1,

"pagesize": 10

},

Status Codes

The following table highlights the expected status codes from the system. Beyond standard HTTP codes you will find custom status codes in the “Status” element of the response body.

https://api.gateway.attomdata.com/propertyapi/v1.0.0/sale/detail?address1=586+FRANKLIN+AVE&address2=brooklyn+NY+11238

Data Dictionary

This data dictionary represents all of the fields currently available in the Property Search Engine API. Different resource and package combinations off access to specific fields within this dictionary and not all fields are available in each package.