geocoded_location

A Geocode or Reverse Geocode request returns one geocoded_location object for each forward or reverse geocode query.

Name Type Description
custom custom User-supplied custom fields that were sent in the request.
errors error_response[] If geocoding failed, this is a list of errors encountered while processing this address. Is not present if geocoding succeeded.
id id ID of the geocoded address. This is set only if an ID was included in the request.
suggestions geocoded_location_suggestion[] The location suggestions for the address, as a list of map coordinates and corresponding addresses. Is not present if geocoding failed.

geocoded_location_suggestion

Name Type Description
country string The two-letter country code; for example, US.
formatted_address string The formatted address of the geocode. Does not include the country; for example, 4436 Delaware St, Denver, Colorado, 80216.
intersection latlon The map coordinates of the location where the address intersects with the street. Omitted if unknown.
location latlon The map coordinates of the geocoded location.
post_code string The post code or zip code; for example, 80216. Omitted if unknown.
regions string[] The regions, ordered with the most specific region first; for example, ["Denver", "Colorado"]. Always has the same number of elements for a given country.
street_name string The name of the street; for example, Delaware St. Omitted if unknown.
street_number string The street number; for example, 4436. Omitted if unknown.
subregions string[] The subregions (for example, the suburb), ordered with the most specific subregion first. Always has the same number of elements for a given country. [] is displayed if there is no subregion.

Example

Example geocoded_location object:

{
  "suggestions": [
    {
      "location": "33.584362,-117.730968",
      "intersection": "33.584409,-117.730949",
      "formatted_address": "20 Enterprise, Aliso Viejo, California, 92656",
      "street_number": "20",
      "street_name": "Enterprise",
      "subregions": [],
      "regions": [
        "Aliso Viejo",
        "Orange",
        "California"
      ],
      "post_code": "92656",
      "country": "US"
    }
  ],
  "id": "address0"
},

See Also