Skip to main content
GET
Address Lookup

Authorizations

Authorization
string
header
required

Send your API key in the Authorization header. Preferred: the raw key (Authorization: YOUR_API_KEY). Also accepted: Bearer YOUR_API_KEY (Bearer scheme is case-insensitive), for HTTP clients that add the prefix automatically.

Query Parameters

state
string
required

The state (e.g. “CA”) where the property is located.

address
string
required

The street address line 1 only (e.g. “123 Main Street”). Do not include city, state, or ZIP in this field.

unitNumberStripped
string

The unit number of the property (optional). Do not include the type of unit. (e.g. “APT 2B” would just be “2B”)

county
string

The county where the property is located. Required when city parameter is provided.

city
string

The city where the property is located. If specified, county parameter is required.

includeExplicitNulls
boolean
default:false

Set true to include missing public nested property fields as explicit nulls. Requires an account enabled for the nested v3 response shape and a v3 data read; otherwise returns 400. Without this flag, fields with unknown values may be omitted. Also returns 400 when the match comes from the v2 coverage fallback.

Response

Property found successfully

property
object

The property features found.