Please note that we don’t support API connections using HTTP - all calls should use HTTPS.
Resource Information
- Preferred method: POST
- 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 |
| query (Required) | A freeform partial address query. Example: “999 bak” or “bs328ga |
| country (Required) | A recognizable country name or ISO code. Example: “USA”, “DE” or “New Zealand” |
| result (Required) | The index of the desired result from the /address/complete result, starting at zero. |
| filters (Optional) | The object containing address filters. Available filters are: “PostalBox”, “SubBuilding”, “Premise”, “Thoroughfare”, “Locality”, “AdministrativeArea”, and “PostalCode”. Filters only work on the following countries: USA, CAN, GBR, and AUS. Example object with all possible filters is enclosed in “Example Request” below. |
| geocode (Optional) | Specifies whether to return geocode fields in the response. This is a chargable add-on. Example: …&geocode… (in URL) or “geocode”:“on” (within object) |
| certify (Optional) | Specifies whether to return certified fields in the response. This is a chargeable add-on. Example: …&certify… (in URL) or “certify”:“on” (within object) |
Response Parameters
| Name | Description |
|---|---|
| Status | The result of your call. “OK” indicates success, any other status indicates an error. Example: “Status”:“OK” |
| output[] | The address object corresponding to the requested result index. The returned fields will be dependent on the parsing methodology and reference data available in each individual country. Sample JSON output[] is enclosed below. |