/v1/search/address

Geocodes address within country and returns content for the parcel
at that location.

  • Usually returns one parcel property.
  • If the address resolves but no parcel exists there (for example, a new
    subdivision), returns one aoi property covering a box of about 30 m
    around the geocoded point instead.
  • Returns 404 if the address cannot be found, and 400
    MULTIPLE_PARCELS_FOUND if it matches more than one parcel.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

RequestMeta is information about how the request is processed including
limits, cursors and filters.

address
object
required
resources
array of objects
required

Resources determine which types of coverage are returned. Each
resource names a namespace (raster or ai) and a type; see
the ResourceType schema for supported types.

resources*
string

First day from which to retrieve the surveys (inclusive). Must be of the form "YYYY-MM-DD" or a relative date "xxY", "xxM", "xxD" where 5M represents since 5 months ago.

string

Last day from which to retrieve the surveys (inclusive). Must be of the form "YYYY-MM-DD" or a relative date "xxY", "xxM", "xxD" where 5M represents until 5 months ago.

string
enum
Defaults to partial
  • partial allows returning metadata for imagery that partially intersects the requested area (or fully contains it).
  • full will only return resources fully containing the requested area.
Allowed:
integer
1 to 300
Defaults to 20

Maximum number of resources per page.

string

Opaque paging token. To get the next page, copy cursor from the
previous response and repeat the same request with it. When a
response has no cursor, there are no more pages.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json