Addresses v1 · Address

Authentication: Use your Consumer Key in the Authorization header.

Implementation Notes

This operation returns a list of known address attributes for a given specific building denoted by the buildingId. The optional parameter include accepts a comma-separated list of resources to add such resource information to the response.

addressRecordType describes if the address is a primary or secondary address (a unit or other form of sub-address) buildingRolloutStatus describes if the address is covered by the Buildings API yet

Intended use

This resource is a menu of what we know about a specific address. If you already know you want certain information returned, use the include parameter to reduce your call count and get to the data you need.

Include Parameter

To reduce the chattiness of the API, we've implemented a parameter that allows you to pull back multiple attributes from a resource without the need to make multiple requests. to use the include parameter, specify a comma-separated list of the attributes you want in the response. example: include=addressDetails,geo,localGovernmentArea

if you request multiple attributes using the include parameter, but we can't return all of them, we will return a message object in the JSON response advising what we didn't return and why.