/address/reverse
PLEASE NOTE: this is legacy documentation, for a product which is no longer actively supported. See our current documentation for details of our actively-supported cloud API.
This endpoint takes a digital geocode and performs a proximity match to one or more addresses.
Resource URL
https://api.loqate.com/address/reverse
Resource Information
| Preferred method | POST, GET |
| Response formats | JSON, XML, HTML |
| Requires authentication? | Yes, valid API key |
| Chargeable? | Yes |
Request Parameters
lqtkey Required |
A valid API key with sufficient credit available to process the requested transactions. Example: BFtd2UpC8Gl1jU1pPnDZIVpoz2XnBMyWEfVcAfoI |
country Required |
A recognizable country name or ISO code. Example: "USA", "DE" or "New Zealand" |
latitude Required |
Latitude co-ordinate expressed in digital format. Example: 37.560210 |
longitude Required |
Longitude co-ordinate expressed in digital format. Example: -122.285640 |
options[] Optional |
Some server options are supported with this endpoint. Find a full list of available options parameters here. |
Response Parameters
Status |
The result of your call. “OK” indicates success, any other status indicates an error. Example: "Status":"OK" |
output[] |
The array containing full candidate address records that have been selected as a proximity match to the entered co-ordinates and country. By default, the response object will return no more than 10 records. Sample JSON output[] is enclosed below. |
Example Request
POST /address/reverse HTTP/1.1
Host: api.loqate.com
Content-Type: application/json
Cache-Control: no-cache
{
"lqtkey":"BFtd2UpC8Gl1jU1pPnDZIVpoz2XnBMyWEfVcAfoI",
"country":"USA",
"latitude":"40.038690",
"longitude":"-82.896560",
}
Example Response
200 OK
Content-Type: application/json; charset=utf8
Date: Mon, 20 Feb 2017 16:29:44 GMT
Server: Apache
X-Powered-By: PHP/5.4.16
Content-Length: 1984
Connection: keep-alive
{
"Status":"OK",
"output":[
{
"Address":"572 Thistle Ave, Gahanna Oh 43230",
"Address1":"572 Thistle Ave",
"Address2":"Gahanna OH 43230",
"AdministrativeArea":"OH",
"CountryName":"United States",
"DeliveryAddress":"572 Thistle Ave",
"DeliveryAddress1":"572 Thistle Ave",
"GeoDistance":"0.000000",
"ISO3166-2":"US",
"ISO3166-3":"USA",
"ISO3166-N":"840",
"Latitude":"40.038690",
"Locality":"Gahanna",
"Longitude":"-82.896560",
"PostalCode":"43230",
"PostalCodePrimary":"43230",
"Premise":"572",
"PremiseNumber":"572",
"PremiseNumberRangeField":"572",
"SubAdministrativeArea":"Franklin",
"Thoroughfare":"Thistle Ave"
},
...
{
"Address":"595 Thistle Ave, Gahanna Oh 43230",
"Address1":"595 Thistle Ave",
"Address2":"Gahanna OH 43230",
"AdministrativeArea":"OH",
"CountryName":"United States",
"DeliveryAddress":"595 Thistle Ave",
"DeliveryAddress1":"595 Thistle Ave",
"GeoDistance":"63.058765",
"ISO3166-2":"US",
"ISO3166-3":"USA",
"ISO3166-N":"840",
"Latitude":"40.039230",
"Locality":"Gahanna",
"Longitude":"-82.897440",
"PostalCode":"43230",
"PostalCodePrimary":"43230",
"Premise":"595",
"PremiseNumber":"595",
"PremiseNumberRangeField":"595",
"SubAdministrativeArea":"Franklin",
"Thoroughfare":"Thistle Ave"
}
]
}