This API call returns addresses within a defined geographic area or postcode. Because of the potential large result set, the data returned is kept to a minimum. You should supplement this query with the Address Metadata API to populate your full result set.
Response Specification
The API response will contain a hash with an element named completions
, which is an array of hashes containing the following fields.
Field Name | Type | Description | Example |
---|---|---|---|
pxid
|
String | The unique address identifier. | 2-.3.1q.2.4G.4c |
x
|
String | Longitude coordinate (in WGS84 format). | 174.643199 |
y
|
String | Latitude coordinate (in WGS84 format). | -36.426956 |
success
|
Boolean | Indicates if the request was successful or not. | true |
Errors
Below are the possible errors that can be returned by the API.
- Validation error (1000)
- Key not found (1001)
- Key not provided (1002)
- Domain not registered with Addressfinder (1003)
- Secret not provided (1004)
- Direct API calls are not permitted on your current plan. (1005)
- Invalid credentials (1006)
- Secret should not be supplied (1008)
- The Addressfinder plugin has exceeded the number of allowed lookups, and is now suspended (1009)
- The record you are trying to load does not exist (1011)
- Domain parameter must not be included in a web request (1015)
- This domain has been blocked (1016)
- This service is not enabled on your current plan (1017)
- Your IP address has been blocked for these credentials (1018)
- HTTP Referer or Origin header record must be present when making a browser initiated request (1019)
- Your Addressfinder trial has ended (1020)
- Your Addressfinder trial has exceeded its allowed lookups (1021)
- Postal addresses are not enabled on your current plan (1022)