Get addresses with geographic coordinates
Learn more about the API operation for reverse geocoding.
The Reverse Geocode API returns multiple addresses for the specified coordinates. Optionally, specify the maximum number of results and the radius for address searches. The API takes coordinates as input and returns results up to the defined maximum within the specified radius. Note that it only returns the standard address lines, and not other details such as AVC, VerificationStatus and so on.
Get addresses from a single set of coordinates
Use this operation to process one record at a time.Request
GET api/{tenantId}/entities/reverseGeo?Latitude=42.402274&Longitude=-88.183042&Country=USA&maxResults=3
Parameter name | Required | Description |
---|---|---|
tenantId | Yes | The tenant ID for which you want to process the data. |
Latitude | Yes | The WGS 84 latitude, in decimal degrees format. |
Longitude | Yes | The WGS 84 longitude, in decimal degrees format. |
Country | Yes | The country name or code, which can be either the preferred ISO 3166 2-character or 3-character country code. Note: If this value is empty, the defaultCountry specified in the tenant physical configuration is considered. |
MaxResults | No | The maximum number of addresses you want to view as a result. This defaults to 1. |
RadiusFilter | No | The radius within which you want addresses returned for the specified coordinates. This defaults to 300 meters. |
Response
[
{
"PremiseNumber": "71",
"Address": "71 Nippersink Rd<BR>Fox Lake Il 60020",
"CountryName": "United States",
"DeliveryAddress": "71 Nippersink Rd",
"PostalCode": "60020",
"Latitude": "42.401970",
"ISO3166-2": "US",
"Premise": "71",
"ISO3166-3": "USA",
"DeliveryAddress1": "71 Nippersink Rd",
"GeoDistance": "35.373028",
"PostalCodePrimary": "60020",
"AdministrativeArea": "Il",
"ISO3166-N": "840",
"Thoroughfare": "Nippersink Rd",
"Locality": "Fox Lake",
"Address2": "Fox Lake Il 60020",
"Address1": "71 Nippersink Rd",
"Longitude": "-88.182740",
"SubAdministrativeArea": "Lake"
},
{
"PremiseNumber": "17",
"Address": "17 Riverview Ave<BR>Fox Lake Il 60020",
"CountryName": "United States",
"DeliveryAddress": "17 Riverview Ave",
"PostalCode": "60020",
"Latitude": "42.401960",
"ISO3166-2": "US",
"Premise": "17",
"ISO3166-3": "USA",
"DeliveryAddress1": "17 Riverview Ave",
"GeoDistance": "41.435311",
"PostalCodePrimary": "60020",
"AdministrativeArea": "Il",
"ISO3166-N": "840",
"Thoroughfare": "Riverview Ave",
"Locality": "Fox Lake",
"Address2": "Fox Lake Il 60020",
"Address1": "17 Riverview Ave",
"Longitude": "-88.182330",
"SubAdministrativeArea": "Lake"
},
{
"PremiseNumber": "19",
"Address": "19 Riverview Ave<BR>Fox Lake Il 60020",
"CountryName": "United States",
"DeliveryAddress": "19 Riverview Ave",
"PostalCode": "60020",
"Latitude": "42.401960",
"ISO3166-2": "US",
"Premise": "19",
"ISO3166-3": "USA",
"DeliveryAddress1": "19 Riverview Ave",
"GeoDistance": "50.933938",
"PostalCodePrimary": "60020",
"AdministrativeArea": "Il",
"ISO3166-N": "840",
"Thoroughfare": "Riverview Ave",
"Locality": "Fox Lake",
"Address2": "Fox Lake Il 60020",
"Address1": "19 Riverview Ave",
"Longitude": "-88.182150",
"SubAdministrativeArea": "Lake"
}
]
For more information, see GET Reverse Geocodes API in the Developer Portal.
Get addresses from a batch of coordinates
Use this operation to process a batch of records.
Request
POST api/{tenantId}/entities/reverseGeo?maxResults=2&radiusFilter=200
Parameter Name | Required | Description |
---|---|---|
tenantID | Yes | The tenant ID for which you want to process the data. |
maxResults | No | The maximum number of addresses you want to view as a result. This defaults to 1. |
radiusFilter | No | The radius within which you want addresses returned for the specified coordinates. This defaults to 300 meters. |
Attribute name | Required | Description |
---|---|---|
Latitude | Yes | The WGS 84 latitude, in decimal degrees format. |
Longitude | Yes | The WGS 84 longitude, in decimal degrees format. |
Country | Yes | The country name or code, which can be either the preferred ISO 3166 2-character or 3-character country code. Note: If this value is empty, the defaultCountry specified in the tenant physical configuration is considered |
[
{
"Country": "United States",
"Latitude": "34.047670",
"Longitude": "-84.269083"
},
{
"Country": "United States",
"Latitude": "42.401850",
"Longitude": "-88.183370"
}
]
Response
[
{
"results": [
{
"ResultClassification": "RES_REJECTED",
"PremiseNumber": "1285",
"Address": "1285 Seale Dr<BR>Alpharetta Ga 30022",
"CountryName": "United States",
"DeliveryAddress": "1285 Seale Dr",
"LocalityStatus": "fsUnrecognized",
"PostalCode": "30022",
"Latitude": "34.047690",
"ISO3166-2": "US",
"Premise": "1285",
"ISO3166-3": "USA",
"DeliveryAddress1": "1285 Seale Dr",
"ReverseGeoDistance": "9.746637",
"ReverseGeoStatus": "RadiusMatch",
"PostalCodePrimary": "30022",
"AdministrativeArea": "Ga",
"ISO3166-N": "840",
"Thoroughfare": "Seale Dr",
"Locality": "Alpharetta",
"Address2": "Alpharetta Ga 30022",
"Address1": "1285 Seale Dr",
"Longitude": "-84.269000",
"PremiseNumberStatus": "fsUnrecognized",
"SubAdministrativeArea": "Fulton",
"AdministrativeAreaStatus": "fsUnrecognized",
"ThoroughfareStatus": "fsUnrecognized"
},
{
"ResultClassification": "RES_REJECTED",
"PremiseNumber": "1275",
"Address": "1275 Seale Dr<BR>Alpharetta Ga 30022",
"CountryName": "United States",
"DeliveryAddress": "1275 Seale Dr",
"LocalityStatus": "fsUnrecognized",
"PostalCode": "30022",
"Latitude": "34.047490",
"ISO3166-2": "US",
"Premise": "1275",
"ISO3166-3": "USA",
"DeliveryAddress1": "1275 Seale Dr",
"ReverseGeoDistance": "25.112383",
"ReverseGeoStatus": "RadiusMatch",
"PostalCodePrimary": "30022",
"AdministrativeArea": "Ga",
"ISO3166-N": "840",
"Thoroughfare": "Seale Dr",
"Locality": "Alpharetta",
"Address2": "Alpharetta Ga 30022",
"Address1": "1275 Seale Dr",
"Longitude": "-84.268740",
"PremiseNumberStatus": "fsUnrecognized",
"SubAdministrativeArea": "Fulton",
"AdministrativeAreaStatus": "fsUnrecognized",
"ThoroughfareStatus": "fsUnrecognized"
}
],
"status": "OK"
},
{
"results": [
{
"ResultClassification": "RES_REJECTED",
"PremiseNumber": "69",
"Address": "69 Nippersink Rd<BR>Fox Lake Il 60020",
"CountryName": "United States",
"DeliveryAddress": "69 Nippersink Rd",
"LocalityStatus": "fsUnrecognized",
"PostalCode": "60020",
"Latitude": "42.402030",
"ISO3166-2": "US",
"Premise": "69",
"ISO3166-3": "USA",
"DeliveryAddress1": "69 Nippersink Rd",
"ReverseGeoDistance": "30.331850",
"ReverseGeoStatus": "RadiusMatch",
"PostalCodePrimary": "60020",
"AdministrativeArea": "Il",
"ISO3166-N": "840",
"Thoroughfare": "Nippersink Rd",
"Locality": "Fox Lake",
"Address2": "Fox Lake Il 60020",
"Address1": "69 Nippersink Rd",
"Longitude": "-88.183900",
"PremiseNumberStatus": "fsUnrecognized",
"SubAdministrativeArea": "Lake",
"AdministrativeAreaStatus": "fsUnrecognized",
"ThoroughfareStatus": "fsUnrecognized"
},
{
"ResultClassification": "RES_REJECTED",
"PremiseNumber": "45",
"Address": "45 Nippersink Rd<BR>Fox Lake Il 60020",
"CountryName": "United States",
"DeliveryAddress": "45 Nippersink Rd",
"LocalityStatus": "fsUnrecognized",
"PostalCode": "60020",
"Latitude": "42.401620",
"ISO3166-2": "US",
"Premise": "45",
"ISO3166-3": "USA",
"DeliveryAddress1": "45 Nippersink Rd",
"ReverseGeoDistance": "50.056497",
"ReverseGeoStatus": "RadiusMatch",
"PostalCodePrimary": "60020",
"AdministrativeArea": "Il",
"ISO3166-N": "840",
"Thoroughfare": "Nippersink Rd",
"Locality": "Fox Lake",
"Address2": "Fox Lake Il 60020",
"Address1": "45 Nippersink Rd",
"Longitude": "-88.183570",
"PremiseNumberStatus": "fsUnrecognized",
"SubAdministrativeArea": "Lake",
"AdministrativeAreaStatus": "fsUnrecognized",
"ThoroughfareStatus": "fsUnrecognized"
}
],
"status": "OK"
}
]
For more information, see POST Reverse Geocodes API in the Developer Portal.