The Address Metadata API is used to load the full metadata associated with an address selected from the Address Autocomplete API.
Build the request URL
Use the form below to build your request URL from the parameters. A URL string will be generated from these parameters and sent to the API in order to provide insight into how the API works and the responses it returns.
The API response will include all the attributes listed below in the format requested in the API request. Empty attributes for the matched address will be returned with a null value.
| ||String||Full address string. FAQ: alias address vs canonical address.||13 Neville Street, RYDE NSW 2112|
| ||String||The unique address identifier. This ID will change following a data refresh.||8097e3df-a3ab-43ad-bc66-22c8f5812361|
| ||String||The canonical or official full address string associated with this address. Can differ from the full_address in either street number, locality name or state name. FAQ: alias address vs canonical address.||11-15 Neville Street, RYDE NSW 2112|
| ||String||The ID of the canonical or official address associated with this search result. |
Note: The ID and Canonical Address ID will be identical when the search result is canonical. FAQ: alias address vs canonical address.
| ||String||Latitude coordinate (in WGS84 format) from the G-NAF dataset, or PAF dataset (for PAF-only addresses).||-37.899031|
| ||String||Longitude coordinate (in WGS84 format) from the G-NAF dataset, or PAF dataset (for PAF-only addresses).||144.999530|
| ||String||The meshblock identifier in which the address is located. These values are provided by the Australian Bureau of Statistics and are updated for each census. |
The format is
| ||String||The statistical area (SA1) identifier in which the address is located. These values are provided by the Australian Bureau of Statistics and are updated for each census. |
| ||String||The statistical area (SA2) identifier in which the address is located. These values are provided by the Australian Bureau of Statistics and are updated for each census. |
| ||String||The unique persistent identifier of the G-NAF address. Only returned when parameter ||GANSW705051429|
| ||String||Australia Post delivery point identifier. Only returned on canonical addresses from Australia Post when parameter ||99119187|
| ||String||Government legal property description. Only returned when parameter ||10//SP9489|
| ||String||Identifies a specific lot on a site. Can be an alpha, number or a combination.||3|
| ||String||The number portion of a PO Box address||123|
| ||String||The type portion of a PO Box address, including ||PO Box|
| ||String||Holds the address element that identifies the name of a site or building.||Kenilworth Police Station|
| ||String||Describes the level type within a multi-level building.||Basement|
| ||String||Identifies a specific level within a multi-level building. Can be an alpha, number or a combination.||3|
| ||String||Describes the category of a sub-dwelling.||Suite|
| ||String||Identifies a specific sub-dwelling. Can be an alpha, number or a combination.||2|
| ||String||The number of the building on the street.||1703|
| ||String||Holds the upper bound when this is a ranged address. For single number addresses this field is ||1705|
| ||String||Holds the full name of the street. This attribute is a composite of the street name, the street type, and the street suffix if present.||Queen Street North|
| ||String||Holds the name of the street. Note: This attribute does not include the street type or suffix.||Queen|
| ||String||The type of street.||Street|
| ||String||The suffix of the street. Typically contains a compass direction.||North|
| ||String||The locality/suburb of this address.||KATOOMBA|
| ||String||The Australian state or territory where the address is located.||NSW|
| ||String||Holds the four digit postcode.||0983|
| ||String||The name of the Local Government Area in which the address is located. These values are provided by the ABS and are an approximation of the gazetted local government boundaries. Only returned when parameter |
Code example - collect LGA data
| ||String||The code relating to the type (or status) of the Local Government Area. Codes used are Area ||DC|
| ||String||First line of the non-locality/state/postcode portion of the address||Unit 209|
| ||String||Second line of the non-locality/state/postcode portion of the address. This will be ||274 Harbour Drive|
| ||Boolean||Indicates if the request was successful or not.||true|
* Attributes marked with an asterisk will always be present in a successful API response.
Below are the possible errors that can be returned by the API.
| ||Validation error|| Returned when one of the supplied parameters is missing or incorrect. The response will contain a message attribute which explains the cause of the validation error. An example JSON response is shown below for a request which failed to include the ||Check that the supplied parameters contain valid values, and that the mandatory parameters have been included.|
| ||Account key not found||Returned when the key included in your API call cannot be found in our database. This will normally happen when you make a copy ’n paste error.|| Compare the key included in your API call with the key listed in the AddressFinder Portal overview page. |
Also confirm there are no additional spaces or characters in your API call.
| ||Account key is missing||Returned when you fail to send through your key with each request. The key is a mandatory parameter.|| Check that you are using the correct parameter name |
| ||Invalid domain||Returned when you embed AddressFinder on a website that differs from the domain that you specified in the AddressFinder Portal.|| The AddressFinder Portal records the whitelist of allowed domains for your account. |
Login to the AddressFinder Portal and add the domain of this website to your account.
| ||Account secret missing|| Returned when you fail to send through your secret with an API call. |
Can also occur when using the widget and the HTTP
| Include the secret listed in the AddressFinder Portal overview page in your API call. |
When using the widget, you must load the page from a web server (e.g. localhost) and not a
A Developer plan is available for customers in development. Contact us to request the necessary plan change
| ||Invalid secret value||Returned when the supplied secret value does not match the value stored in our database. This will normally happen when you make a copy ’n paste error.|| Compare the secret included in your API call with the secret listed in the AddressFinder Portal overview page. |
Also confirm there are no additional spaces or characters in your API call.
| ||Secret should not be supplied||This is a safety check to ensure that the secret parameter has not been included when making requests from your web browser. You should never include the secret on any web page.||The secret should be used for server-to-server API calls only.|
| ||Account has been suspended||Returned when your account (Free plans only) has hit its 100% usage limit for the billing period.|| Visit the AddressFinder Portal and upgrade your account to a Paid plan. |
Alternatively wait until the end of the month when suspended accounts are automatically reactivated.
| ||Record not found||Returned when the supplied address identifier cannot be found. This can happen when a stale identifier is included in the API call.||Do not save address identifiers in your database, as they are transisent and may change after each database update.|
| ||Account Disabled||Your account has been disabled by AddressFinder support.||Contact AddressFinder support to reactivate your account.|
| ||Cannot include domain parameter in a web request||You have included a domain parameter in your browser based API call.||Remove the domain parameter from your API call.|
| ||This activity is not permitted on your current plan||You have attempted to use an AddressFinder service that is not valid for current plan.|| Consider upgrading to a Pro plan. Visit the AddressFinder Portal to change plan. |
Alternatively Contact us to discuss plan options.