Address Metadata API - United States | Addressfinder Australia

Build
Send
Response
Errors

The Address Metadata API is used to collect the metadata associated with an address selected from the Address Autocomplete API

Build the GET request URL

Use the form below to build your request URL from the available parameters. The URL string will be generated and can be sent to the API in order to provide insight into how the API works and the response it returns. Or, if you are using Postman for your investigation, development and testing, include the desired parameters and copy and paste the request URL below into Postman's GET request URL field.

Country

Field Name	Value	Type	Description
key *		String	Your unique licence key (find on Portal credentials)
secret *		String	Your unique secret key (find on Portal credentials). Alternatively, you can pass your secret key into the Authorization header of the request as such: `Authorization: your-secret`. FAQ: Learn more about authenticating direct API calls in request headers
format *		String	The format of the response.
	Options json `json` for a response in json format. xml `xml` for a response in xml format.
id *		String	Unique address id obtained from the Address Autocomplete
gps		String	Request GPS coordinates for `latitude` and `longitude` be returned when available
	Options Yes `1` GPS coordinates wil be included in the response No `0`
domain		String	Used to identify which of your services is calling the API for activity monitoring purposes. This domain needs to be registered in the portal. FAQ: learn more about the domain parameter

* Parameters marked with an asterisk are mandatory for this API call.

Request URL

https://api.addressfinder.io/api/:country_code:/address/v2/metadata/

      
        /* Click the button above to see a real API response here */
        {
          ...
        }

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	47.770876
`longitude`	Float	Longitude in the decimal degrees format	-122.391526
`success`	Boolean	Indicates if the request was successful or not.	true

Errors

Below are the possible errors that can be returned by the API.