Location Metadata API
The Location Metadata API is used to collect the metadata associated with a location selected from the Location Autocomplete API. This includes attributes like full location string, state, postcode, latitude/longitude, and street details.
Endpoint
Australia
https://api.addressfinder.io/api/au/location/metadata
Parameters
Parameter | Description | Test Value |
---|---|---|
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 Type: string | |
format | The format of the response. Default value: Type: json string required | |
id | Unique location identifier obtained from the Location Autocomplete API. Type: string required | |
domain | Used to identify in the Addressfinder Portal which of your services is calling the API. The domain needs to be registered in the Portal. Type: string |
Responses
200 Metadata for the selected location
Name | Description | Example |
---|---|---|
full_location | Full location string. Type: string | Martin Street, NYABING WA 6341 |
location_type | Type of location. Values are street , locality (suburb), or state .Type: string | street |
latitude | Latitude coordinate in WGS84 format. Type: string | -33.54227326 |
longitude | Longitude coordinate in WGS84 format. Type: string | 118.14670128 |
street_name | Name of the street without type or suffix. Type: string | Martin |
street_type | The street type. Type: string | Street |
street | The full name of the street. Type: string | Queen Street North |
locality_name | The locality or suburb of this address. Type: string | KATOOMBA |
state_territory | The state or territory where the address is located. Type: string | NSW |
postcode | The 4 digits postcode. Type: string | 0983 |
success | Returns true if the service ran successfully. Type: boolean | true |