SHshovels
Addresses

Search Addresses

Changed on

Searches addresses by their text fields (street number, street, city, state, and ZIP code) using prefix, full-text, and fuzzy matching.

get/addresses/search

Request

  • Base URL
    https://api.shovels.ai/v2
  • Auth
    API key in header X-API-Key

Query parameters

qstring 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.

sizeinteger required

The number of items returned in the response.

next_cursorstring nullable required

The cursor for retrieving the next page of results.

Changes

  • 685b8866c451Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status