Skip to main content
GET
Search Addresses

Authorizations

X-API-Key
string
header
required

Query Parameters

q
string
required

The text to search for in the address fields. A query of 3 or 4 digits searches by ZIP code prefix. A query of 1 or 2 digits returns 404.

Response

A list of addresses that match the search text, ordered by relevance and in USPS notation.

Paginated response for addresses.

items
AddressesRead · object[]
required

The list of items returned in the response following given criteria.

size
integer
required

The number of items returned in the response.

next_cursor
string | null
required

The cursor for retrieving the next page of results.

total_count
TotalCount · object | null

Top-level count object, not an integer: {"value": 970, "relation": "eq"}. "eq" means an exact count up to 10,000. "gte" means at least 10,000 matches, with value set to 10,000. Counted only when requested on the first page without a cursor. null when not requested, on later pages, or when the count query times out.

Example: