GET
/
addresses
/
search
Search Addresses
curl --request GET \
  --url https://api.shovels.ai/v2/addresses/search \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "street_no": "1232",
      "street": "MARKET ST",
      "city": "SAN FRANCISCO",
      "county": "SAN FRANCISCO",
      "zip_code": "94103",
      "zip_code_ext": "1234",
      "state": "CA",
      "jurisdiction": "SAN FRANCISCO",
      "lat": 37.7749,
      "long": -122.41,
      "geo_id": "1",
      "name": "123 Market St, San Francisco, CA"
    },
    {
      "street_no": "1233",
      "street": "MARKET ST",
      "city": "SAN FRANCISCO",
      "county": "SAN FRANCISCO",
      "zip_code": "94103",
      "zip_code_ext": "1234",
      "state": "CA",
      "jurisdiction": "SAN FRANCISCO",
      "lat": 37.7749,
      "long": -122.41,
      "geo_id": "2",
      "name": "1233 Market St, San Francisco, CA"
    },
    {
      "street_no": "1234",
      "street": "MARKET ST",
      "city": "SAN FRANCISCO",
      "county": "SAN FRANCISCO",
      "zip_code": "94103",
      "zip_code_ext": "1234",
      "state": "CA",
      "jurisdiction": "SAN FRANCISCO",
      "lat": 37.7749,
      "long": -122.41,
      "geo_id": "3",
      "name": "1234 Market St, San Francisco, CA"
    }
  ],
  "page": 1,
  "size": 3
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
q
string
required

The text to search for in the address fields.

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.

​
page
integer
required

The page number of the response.

​
size
integer
required

The number of items returned in the response.

​
next_page
integer | null
required

The next page number of the response.