Resolve a street-address suggestion
GET /api/v5/locations/address-details
GET
/api/v5/locations/address-details
Resolves an Addressr place identifier into the split address fields used by the shared public/members address editor.
Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ” pid
required
Addressr place identifier returned by /address-suggestions.
string
Addressr place identifier returned by /address-suggestions.
Responses
Section titled “ Responses ”Address detail response
object
fields
required
object
unit
required
Unit, apartment, or suite number; empty when not applicable.
string
streetNumber
required
Street number portion of the address.
string
street
required
Street name without the street type.
string
streetType
required
Street type (e.g. Street, Road, Avenue).
string
address
required
Full street address line combining unit, number, street and type.
string
suburb
required
Suburb or town name.
string
state
required
State or territory code (e.g. NSW).
string
postcode
required
Postal code (4-digit for Australia).
string
country
required
Two-letter ISO country code.
string
Address detail was not found
object
error
required
string
message
required
string