Please note that we don’t support API connections using HTTP - all calls should use HTTPS.
Resource Information
- Preferred method: POST, GET
- Response formats: JSON, XML, HTML
- Requires authentication? Yes, valid API key
- Chargeable? Yes
Request Parameters
| Name | Description |
|---|---|
| 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
| Name | Description |
|---|---|
| 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. |

