Generate a list of address suggestions based on the supplied query. Use with the /address/capture endpoint to select and return the full address object.
Note: only old everythinglocation keys will work with this service.
https://api.everythinglocation.com/address/complete
Note: we don't support API connections using HTTP - all calls should use HTTPS.
| Preferred method | POST, GET |
| Response formats | JSON, XML, HTML |
| Requires authentication? | Yes, valid API key |
| Chargeable? | No |
| Name | Descrition |
|---|---|
| lqtkey Required |
A valid API key. 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" |
| filters Optional |
The object containing address filters. Available filters are: "PostalBox", "SubBuilding", "Premise", "Thoroughfare", "Locality", "AdministrativeArea", and "PostalCode". Filters will only function on the following countries: USA, CAN, GBR, and AUS. Example object with all possible filters is enclosed in "Example Request" below. |
| Name | Descrition |
|---|---|
| Status | The result of your call. "OK" indicates success, any other status indicates an error. Example: "Status":"OK" |
| output[] | The array containing the suggestions for the given input. The number of results returned is variable. For searches on United States, United Kingdom, Australia and Canada data, the result list length is determined by the ratio of complete and component-matched addresses that the search process compiles. For searches on all other country data, the maximum results are always 10. Sample JSON output[] is enclosed below. |
| metadata[] | The array containing address metadata for address suggestions. The metadata can be used in the "filters" input object for filtering address components on subsequent requests. If TotalRecordCount = 1, then the metadata object will not return any address fields. Sample JSON output[] is enclosed below. |
POST https://api.everythinglocation.com/address/complete
Accept: application/json
Content-Type: application/json
{
"lqtkey":"BFtd2UpC8Gl1jU1pPnDZIVpoz2XnBMyWEfVcAfoI",
"query":"941",
"country":"us",
"filters": {
"Locality": "San Francisco",
"AdministrativeArea": "CA"
}
}
200 OK
Content-Type: application/json; charset=utf8
Date: Thu, 15 Oct 2015 18:28:11 GMT
Server: Apache
X-Powered-By: PHP/5.4.16
Content-Length: 367
Connection: keep-alive
{
"Status":"OK",
"output":[
"San Francisco CA 94102",
"941 Buchanan St, San Francisco CA 94102",
"941 22nd St, San Francisco CA 94107",
"941 7th St, San Francisco CA 94107",
"941 Michigan St, San Francisco CA 94107",
"941 Pine St, San Francisco CA 94108",
"941 Esmeralda Ave, San Francisco CA 94110",
"941 Treat Ave, San Francisco CA 94110",
"941 Buena Vista Ave W, San Francisco CA 94117",
"941 Cesar Chavez, San Francisco CA 94124"
],
"metadata":[
{
"AdministrativeArea":"CA",
"Locality":"San Francisco",
"PostalCode":"94102",
"PostalCodePrimary":"94102",
"TotalRecordCount":"5182"
},
{"TotalRecordCount":"1"},
{"TotalRecordCount":"1"},
{"TotalRecordCount":"1"},
{"TotalRecordCount":"1"},
{"TotalRecordCount":"1"},
{"TotalRecordCount":"1"},
{"TotalRecordCount":"1"},
{"TotalRecordCount":"1"},
{"TotalRecordCount":"1"}
]
}