/* Click the button above to see a real API response here */
{
"success": true
}
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.
Key
GNAF Returned (if present) when searching the gnaf
database.
PAF Returned (if present) when searching the au_paf
database.
Field Name | Type | Description | Example |
---|---|---|---|
full_address | String | Full address string. FAQ: alias address vs canonical address. | 13 Neville Street, RYDE NSW 2112 |
id | String | The unique address identifier. This ID will change following a data refresh. | 8097e3df-a3ab-43ad-bc66-22c8f5812361 |
canonical_address | 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 |
canonical_address_id | 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. | d70230a9-a3d8-402f-971e-1b798d00f2f5 |
latitude | String | Latitude coordinate (in WGS84 format). | -37.899031 |
longitude | String | Longitude coordinate (in WGS84 format). | 144.999530 |
lot_identifier | String | Identifies a specific lot on a site. Can be an alpha, number or a combination. | 3 |
box_identifier | String | The number portion of a PO Box address | 123 |
box_type | String | The type portion of a PO Box address, including PO Box , Locked Bag , GPO Box , CMB , RMS , Care PO , MS and RSD | PO Box |
site_name | String | Holds the address element that identifies the name of a site or building. | Kenilworth Police Station |
level_type | String | Describes the level type within a multi-level building. | Basement |
level_number | String | Identifies a specific level within a multi-level building. Can be an alpha, number or a combination. | 3 |
unit_type | String | Describes the category of a sub-dwelling. | Suite |
unit_identifier | String | Identifies a specific sub-dwelling. Can be an alpha, number or a combination. | 2 |
street_number_1 | String | The number of the building on the street. | 1703 |
street_number_2 | String | Holds the upper bound when this is a ranged address. For single number addresses this field is null | 1705 |
street | 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 |
street_name | String | Holds the name of the street. Note: This attribute does not include the street type or suffix. | Queen |
street_type | String | The type of street. | Street |
street_suffix | String | The suffix of the street. Typically contains a compass direction. | North |
locality_name | String | The locality/suburb of this address. | KATOOMBA |
state_territory | String | The Australian state or territory where the address is located. | NSW |
postcode | String | Holds the four digit postcode. | 0983 |
address_line_1 | String | First line of the non-locality/state/postcode portion of the address | Unit 209 |
address_line_2 | String | Second line of the non-locality/state/postcode portion of the address. This will be null for addresses without a unit/level/etc number. | 274 Harbour Drive |
success | Boolean | Indicates if the request was successful or not. | true |
dpid | String | Australia Post delivery point identifier. | 99119187 |
lga_name | 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. Code example - collect LGA data | Bundaberg |
lga_type_code | String | The code relating to the type (or status) of the Local Government Area. Codes used are Area A , Aboriginal Council AC , Borough B , City C , District Council DC , Municipality / Municipal Council M , Regional Council R or RegC , Rural City RC , Shire S and Town T . | DC |
legal_parcel_id | String | Government legal property description. | 10//SP9489 |
meshblock | 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 MB , followed by a 2 digit year identifier, followed by the 11 digit meshblock identifier.Use the census parameter to select from either the 2011 and 2016 census. Defaults to 2016 if not provided. | MB1610671120000 |
sa1_id | 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. Use the census parameter to select from either the 2011 and 2016 census. Defaults to 2016 if not provided. | 12602159143 |
sa2_id | 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. Use the census parameter to select from either the 2011 and 2016 census. Defaults to 2016 if not provided. | 126021591 |
gnaf_id | String | The unique persistent identifier of the G-NAF address. | GANSW705051429 |
Below are the possible errors that can be returned by the API.
Code | Error | Cause | Resolution |
---|---|---|---|
1000 | 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 q parameter.{ | Check that the supplied parameters contain valid values, and that the mandatory parameters have been included. |
1001 | 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. |
1002 | Key not provided | 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 key . |
1003 | Domain not registered with AddressFinder | 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 domains that are allowed to use your account. Login to the AddressFinder Portal and add the domain of this website to your account. |
1004 | Secret not provided | Returned when you fail to send through your secret with an API call. Can also occur when using the widget and the HTTP Referer header is not included. | 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 file:// scheme. |
1005 | Direct API calls are not permitted on your current plan. | Returned if you try to call the API and you are on either a Free or Agile plan. These plan types provide access to the JavaScript Widget and plugins only. | Upgrade to a Business plan. Visit the AddressFinder Portal to change plan. |
1006 | Invalid credentials | Returned when the supplied key and/or secret value are incorrect. This will normally happen when you make a copy ’n paste error. | Compare the key and secret included in your API call with the values listed on the AddressFinder Portal credentials page. Also confirm there are no additional spaces or characters in your API call. |
1008 | 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. |
1009 | The AddressFinder plugin has exceeded the number of allowed lookups, and is now suspended | Returned when your account (free plans only) has hit its 100% usage limit for the billing period. | Visit the AddressFinder Portal and switch to a Paid plan. Alternatively wait until the end of the month when suspended accounts are automatically reactivated. |
1010 | Account not authorised to use this API | Returned when you make an API call that you are not permitted to use | Contact AddressFinder support to request access to this API. |
1011 | The record you are trying to load does not exist | 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 transient and may change after each database update. |
1012 | Account not authorised to use this API | Returned when you make an API call that you are not permitted to use | Contact AddressFinder support to request access to this API. |
1013 | This API has been discontinued | This API has been discontinued | Contact AddressFinder support to discuss alternatives. |
1014 | Account Disabled | Your account has been disabled by AddressFinder support. | Contact AddressFinder support to discuss reactivating your account. |
1015 | Domain parameter must not be included in a web request | You have included a domain parameter in your browser based API call. The domain parameter is for direct API calls only. | Remove the domain parameter from your web request. |
1016 | This domain has been blocked | These credentials are not permitted to be used on this domain. | Contact AddressFinder support to discuss removing the block. |
1017 | This service is not enabled on your current plan | You have attempted to use an AddressFinder service that is not enabled on your current plan. | Visit the AddressFinder Portal to change plan. |
1018 | Your IP address has been blocked for these credentials | This service has been configured to only allow access from defined IP addresses. | Visit the AddressFinder Portal and add your IP address to the IP Allow List. |
1019 | HTTP Referer or Origin header record must be present when making a browser initiated request | You have attempted to use the AddressFinder widget from a browser that does not include the referrer or orgin headers along with each request. | Confirm that this request was sent from a valid web server (not the local filesystem), and that you do not have browser plugins interfering with the request. |
1020 | Your AddressFinder trial has ended | Returned when the trial term has ended. | Log into the AddressFinder Portal and upgrade your account to a suitable plan. |
1021 | Your AddressFinder trial has exceeded its allowed lookups. | Returned when you have exceeded the number of lookups permitted on the trial plan. | Log into the AddressFinder Portal and upgrade your account to a suitable plan. |