Skip to main content
GET
Search Zipcodes

Authorizations

X-API-Key
string
header
required

Query Parameters

q
string
required

The code to search for in the zipcodes fields.

cursor
string | null

Cursor for pagination

size
integer
default:50
Required range: 1 <= x <= 100

Response

A list of zipcodes that match the search code.

Paginated response for zipcodes.

items
Zipcodes · 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

Total result count (capped at 10,000). Present on first-page responses when include_count=true. null if the count query timed out.