The Address Metadata API is used to collect the metadata associated with an address selected from the Address Autocomplete API
Response Specification
The API response will contain a hash with an element named address
, which is an array of hashes containing the following fields.
Field Name | Type | Description | Example |
---|---|---|---|
id
|
String | Unique address identifier obtained from the Address Autocomplete | 2fjZ2wvSHufT0ruefqNH13rYtBKS6ZZukGxPowcuqmUB/s_nIJl_--trguceJRa_eztyLG--jl1iVIoZZZaQYvF/erphow== |
address
|
Group | Address information as supplied by our sources. Contains the following fields: | |
address_line_1 |
String |
First address line in the country specific format, usually includes unit number, street number, name, etc. Can be used on forms with multiple address fields. | 123 Edward St |
address_line_2 |
String |
Second address line in the country specific format, usually includes locality, neighbourhood, etc. Can be used on forms with multiple address fields. | Silver Berry |
address_line_combined |
String |
Country specific lines 1 and 2 combined into one. Can be used on forms with a single address field. | 123 Edward St, Silver Berry |
city |
String |
The city, town or locality name as assigned by our sources | Toronto |
city_line |
String |
The city in a format suitable for postal services | Toronto ON M5G |
postcode |
String |
Holds the country specific postcode | M5G |
state |
String |
Country specific state/region/district | ON |
country_name |
String |
Name of the country the address belongs to | Canada |
country_code |
String |
ISO 3166-1 alpha-2 code of the country | CA |
metadata
|
Group | Other metadata as supplied by our sources. Contains the following fields: | |
street |
String |
Holds the full name of the street as supplied by our sources | Edward St |
street_number |
String |
Holds the street number as supplied by our sources | 123 |
position
|
Group | Contains the GPS coordinates if requested via the gps param | |
latitude |
Float |
Latitude in the decimal degrees format | 59.35692 |
longitude |
Float |
Longitude in the decimal degrees format | 17.96996 |
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 address autocomplete feature is unavailable as it has exceeded the number of free lookups. Please contact the website owner (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)
- Your Addressfinder plan is paused (1023)