How do I make an API call?

watch_later Updated 5 weeks ago

1
Split Address

What is it? The simplest way to think of it is that the address is split into the standard mailing address parts: street_address, city, state and zip_code.  The zip code parameter is an optional request parameter, it is not a required field for the Split Address request type.

How to set up? You can enter an address by hand, or copy and paste an address from a document or the internet. Try finding a house on Google Maps, and copy the address parts into the corresponding request parameters.

Best time to use it? If your application breaks an address into these specific parts, this call format is optimal as little to no additional string processing is needed.

Example: &street_address=220+South+Rodeo+Drive&city=Beverly+Hills&state=CA&zip_code=90212


2
Combined Address

What is it? The most common API call type you will likely make.  There is only one request parameter, combined_address, and its value is exactly what you expect it to be: the full address, meaning all it's individual pieces (street number, name, any street directionals, unit information, city, state etc.) combined together into one fully-qualified address that uniquely indentifies a property. 

How to set up? Append "&combined_address=" to the api endpoint and add the target address in full as the value with commas separating what would comprise of the street address, city, state and zip code.

Best time to use it? This call type can be integrated into your workflow or application by processing the fields of an address form and building a fully-qualified address from the inputs.

Example: &combined_address=151 Battle Green Dr, Rochester, NY 14624


3
Parsed Address

What is it? The most detailed call type which parses every individual piece of the address.

How to set up? You’ll need to set up a detailed parsed address input form.

Best time to use it? This could be set up as a backup in case the input form you have set up for Split Address calls is not returning an address. This should also be used if you are looking for apartments, condos, or anything with a unit number.

Example: &unit_type=APT&unit_number=3&street_number=1319&street_pre_direction=N&street_name=Campbell&street_suffix=Ave&city=Chicago&state=IL&zip_code=60622


4
FIPS code and APN

What is it? A FIPS (Federal Information Processing Standards) code and an APN (Assessor's Parcel Number) are two pieces of information that unique identify a property.  The FIPS code required here is the 5-digit FIPS code where the first two digits represent the state FIPS code and the following three digits represent the county FIPS code.For example, the FIPS code of 06071 represents the state of California(06) and San Bernadino county(071).

Best time to use it? If your application has both the APN and FIPS code for a property, this is overall the best way to query compared to any of our other request types.  It is the fastest way to request a property as it already uniquely identifies a property. 

Example: &fips=53035&apn=012201-2-015-2007


5
API Response

JSON Formatting API responses are formatted in JSON and sorted by the relevant object. Learn more about JSON here.

Successful API Response A successful API response is one which returns a 200 HTTP status code.  The key here is that in this context, successful solely means that the minimum request parameters were met and the request received was well-formed. It does not mean the request was successful in returning property data.  There are two general categories for successful responses: one which returns property data and a warning response which does not return property data.  The difference between these two categories is that the first is a billable response as property data was returned and the other is not billable as it does not return property data. 

Error Response A failed API response is one that is returned with 4xx-5xx HTTP status codes.  In these responses, the body will contain an error object detailing the issue that occurred.  Depending on your application requirements, additional error handling can be set up for known API error responses.  See the list of error codes to determine what error handling steps makes sense for your use cases.