Address Metadata API

The address metadata API is used to collect the metadata associated with an address selected from the Address Autocomplete API. Replace {country} in the path with the ISO 3166 alpha-2 code of the country where the address is located. Supported countries include: au, be, ca, cz, dk, fr, de, ie, nz, nl, pt, sg, es, se, gb, us.

Endpoint

international

https://api.addressfinder.io/api/{country}/address/v2/metadata

Parameters

Parameter	Description	Test Value
country	ISO 3166 alpha-2 country code. Type: string required
key	Your unique Addressfinder license key. Type: string required
secret	Your unique secret key from Portal Credentials. You can also pass your secret key into the Authorization header of the request. Only required for server-to-server calls. Type: string
format	The format of the response. Default value: json Type: string required	-- Select --jsonxml
id	Unique address identifier obtained from the Address Autocomplete API. Type: string required
gps	Include GPS coordinates in the results if available (0 or 1). Type: integer	-- Select --01
domain	Used to identify in the Addressfinder Portal which of your services is calling the API for activity monitoring purposes. The domain needs to be registered in the Portal. Type: string

Responses

200 Metadata for the selected address

Name	Description	Example
id	The unique address identifier. Type: string	_wEzMQD-UiYLas2j_kKyVwD...
address	Type: object	-
full_address	Full address in the country-specific format. Type: string	123 Edward St, Silver Berry, Toronto ON M5G
address_line_1	First address line. Type: string	123 Edward St
address_line_2	Second address line. Type: string	Silver Berry
address_line_combined	Combined address lines 1 and 2. Type: string	123 Edward St, Silver Berry
city	City, town or locality name. Type: string	Toronto
city_line	City formatted for postal services. Type: string	Toronto ON M5G
state	Country-specific state or region. Type: string	ON
postcode	Country-specific postcode or zipcode. Type: string	M5G
country_name	Country name. Type: string	Canada
country_code	ISO 3166 alpha-2 country code. Type: string	CA
metadata	Type: object	-
street	Full street name. Type: string	Edward St
street_number	Street number. Type: string	123
position	Type: object	-
latitude	Type: number	48.5827
longitude	Type: number	2.96747
success	Returns true if the service ran successfully. Type: boolean	true

400 Invalid input or missing parameters.

Name	Description	Example
error	Description of the error Type: string	Missing required parameter 'id'

See API Error Reference for details.