Sign in

v1

latestOpenAPI 3.0.02026-07-1419035.1 KB
Geocoding

Structured Geocode

get/search/{versionNumber}/structuredGeocode.{ext}

Path parameters

versionNumber2 required

Service version number. The current value is 2.

ext'json' | 'jsonp' | 'js' | 'xml' required

Expected response format.

Query parameters

countryCodestring required

2 or 3 letter country code (e.g.: FR, ES).

limitinteger

Maximum number of search results that will be returned.

ofsinteger

Starting offset of the returned results within the full result set.

streetNumberstring

The street number for the structured address.

streetNamestring

The street name for the structured address.

crossStreetstring

The cross street name for the structured address.

municipalitystring

The municipality (city/town) for the structured address.

municipalitySubdivisionstring

The municipality subdivision (sub/super city) for the structured address.

countryTertiarySubdivisionstring

The named area for the structured address.

countrySecondarySubdivisionstring

The county for the structured address.

countrySubdivisionstring

The state or province for the structured address.

postalCodestring

The zip code or postal code for the structured address.

languagestring

Language in which search results should be returned. Should be one of <a href="/search-api/search-api-documentation/supported-languages">supported IETF language tags</a>, case insensitive.

extendedPostalCodesForstring

Indexes for which extended postal codes should be included in the results. Available indexes are:

  • <b>Addr</b> = Address ranges
  • <b>Geo</b> = Geographies
  • <b>PAD</b> = Point Addresses
  • <b>POI</b> = Points of Interest
  • <b>Str</b> = Streets
  • <b>XStr</b> = Cross Streets (intersections)

Response

OK: the search successfully returned zero or more results.