Addressify

Introduction

The Addressify API endpoints are accessed using HTTP GET requests. On success they will return a HTTP status code 200 OK and a JSON formatted result. On error they will return an error code.

The Addressify API base URL's are:

HTTP

http://api.addressify.com.au/

HTTP over SSL

https://api.addressify.com.au/

Addressify Pro

General Information

All Addressify Pro endpoints are only available to accounts on the Pro plan.

Addressify Pro Endpoints

addresspro/autoComplete

Returns a list of complete addresses for the given incomplete address term.

Arguments

api_key (Required)

Your API key.

term (Required)

The start of an address.

max_results (Optional)

The maximum number of results to return (minumum: 1, maximum: 20, default: 10).

info (Optional)

Set info to true or false. Default is false. When info=true is passed an array of address info objects will be returned instead of an array of strings. See addresspro/info for more information.

jsonp (Optional)

JSONP callback function name, if omitted the API will return JSON.

Example Call

http://api.addressify.com.au/addresspro/autoComplete?api_key={your API key}&term=1+george+st+t&max_results=5

Example Response

["1 GEORGE ST, TAMBELLUP WA 6320", "1 GEORGE ST, TANUNDA SA 5352", "1 GEORGE ST, TAYLORS HILL VIC 3037", "1 GEORGE ST, TELARAH NSW 2320", "1 GEORGE ST, TENTERFIELD NSW 2372", "1 GEORGE ST, TEWANTIN QLD 4565", "1 GEORGE ST, THEBARTON SA 5031", "1 GEORGE ST, TIGHES HILL NSW 2297", "1 GEORGE ST, TIMBOON VIC 3268", "1 GEORGE ST, TIVOLI QLD 4305"]

addresspro/info

Returns a parsed address, longitude, latitude, and whether the address is valid in a single call.

Arguments

api_key (Required)

Your API key.

term (Required)

The address to return information for.

jsonp (Optional)

JSONP callback function name, if omitted the API will return JSON.

Example Call

http://api.addressify.com.au/addresspro/info?api_key={your API key}&term=1+george+st+sydenham+nsw+2044

Example Response

{"Suburb":"SYDENHAM", "Number":"1", "NumberFirst":"1", "NumberLast":null, "StreetSuffix":null, "StreetSuffixFull":null, "State":"NSW", "Street":"GEORGE", "StreetLine":"1 GEORGE ST", "BuildingName":null, "StreetType":"ST", "StreetTypeFull":"STREET", "UnitType":null, "UnitTypeFull":null, "UnitNumber":null, "LevelType":null, "LevelTypeFull":null, "LevelNumber":null, "Postcode":"2044", "Longitude":151.17056839, "Latitude":-33.91759949, "Meshblock":"10516310000", "Gnaf_ID":"GANSW706417964", "Valid":true}

addresspro/getSimilar

Returns a list of valid addresses that are similar to the given term or are the correct version of an alias/vanity address, can be used to match misspelled, incorrect and alias/vanity addresses to valid addresses.

Arguments

api_key (Required)

Your API key.

term (Required)

The term to find similar addresses for

max_results (Optional)

The maximum number of results to return (minumum: 1, maximum: 10, default: 10).

aliases_only (Optional)

Will compare the given address to aliases and will limit the returned list to only the correct address of a given alias.

jsonp (Optional)

JSONP callback function name, if omitted the API will return JSON.

Example Call

http://api.addressify.com.au/addresspro/getSimilar?api_key={your API key}&term=1+gorge+rd+sydenhum+qld+2044

Example Response

["1 GEORGE ST, SYDENHAM NSW 2044"]

addresspro/validate

Checks whether the given address is valid.

Arguments

api_key (Required)

Your API key.

term (Required)

The address to validate.

jsonp (Optional)

JSONP callback function name, if omitted the API will return JSON.

Example Call

http://api.addressify.com.au/addresspro/validate?api_key={your API key}&term=1+george+st+sydenham+nsw+2044

Example Response

true

addresspro/geocode

Returns the longitude and latitude for a given address term.

Arguments

api_key (Required)

Your API key.

term (Required)

The address to geocode.

jsonp (Optional)

JSONP callback function name, if omitted the API will return JSON.

Example Call

http://api.addressify.com.au/addresspro/geocode?api_key={your API key}&term=1+george+st+sydenham+nsw+2044

Example Response

{"Longitude":151.17056839,"Latitude":-33.91759949}

addresspro/meshblock

Returns the ABS meshblock for a given address term.

Arguments

api_key (Required)

Your API key.

term (Required)

The address to return a meshblock for.

jsonp (Optional)

JSONP callback function name, if omitted the API will return JSON.

Example Call

http://api.addressify.com.au/addresspro/meshblock?api_key={your API key}&term=1+george+st+sydenham+nsw+2044

Example Response

"10516310000"

Addressify Lite (Previously Business)

General Information

All Addressify Lite endpoints are available to accounts on the Pro and Lite (Previously Business) plans.

Addressify Lite Endpoints

address/autoComplete

Returns a list of complete addresses for the given incomplete address term. Building/Unit/Level/Street number information is piped through from the user input. To include this information and to only return addresses where the Unit/Level/Street number exists please refer to the addresspro/autoComplete endpoint.

Arguments

api_key (Required)

Your API key.

term (Required)

The start of an address.

state (Optional)

The state to search for addresses in. ('NSW', 'ACT', 'VIC', 'QLD', 'SA', 'WA', 'NT', 'TAS')

postcode (Optional)

The postcode to search for addresses in.

max_results (Optional)

The maximum number of results to return (minumum: 1, maximum: 20, default: 10).

info (Optional)

Set info to true or false. Default is false. When info=true is passed an array of address info objects will be returned instead of an array of strings. See addresspro/info for more information. Note that this is a lite call so geocode and meshblock values will be returned as null and validation will work as per address/validate.

jsonp (Optional)

JSONP callback function name, if omitted the API will return JSON.

Example Call

http://api.addressify.com.au/address/autoComplete?api_key={your API key}&term=1+George+st+t&state=nsw&max_results=5

Example Response

["1 GEORGE ST, TAHMOOR NSW 2573","1 GEORGE ST, TELARAH NSW 2320","1 GEORGE ST, TEMORA NSW 2666","1 GEORGE ST, TENTERFIELD NSW 2372","1 GEORGE ST, THE ROCKS NSW 2000"]

address/parse

Parses the given address into it's individual address fields.

Arguments

api_key (Required)

Your API key.

term (Required)

The address to parse.

jsonp (Optional)

JSONP callback function name, if omitted the API will return JSON.

Example Call

http://api.addressify.com.au/address/parse?api_key={your API key}&term=1+george+st+sydenham+nsw+2044

Example Response

{"UnitNumber":null, "Number":"1", "Street":"GEORGE", "StreetType":"ST", "Suburb":"SYDENHAM", "NumberFirst":"1", "NumberLast":null, "StreetSuffix":null, "State":"NSW", "StreetLine":"1 GEORGE ST", "BuildingName":null, "StreetSuffixFull":null, "StreetTypeFull":"STREET", "UnitType":null, "UnitTypeFull":null, "LevelType":null, "LevelTypeFull":null, "LevelNumber":null, "Postcode":"2044"}

address/getSimilar

Returns a list of valid addresses that are similar to the given term or are the correct version of an alias/vanity address, can be used to match misspelled, incorrect and alias/vanity addresses to valid addresses. All addresses will be valid to the street level, to return only valid addresses to the Unit/Level/Street number level please refer to the addresspro/getSimilar endpoint.

Arguments

api_key (Required)

Your API key.

term (Required)

The term to find similar addresses for

max_results (Optional)

The maximum number of results to return (minumum: 1, maximum: 10, default: 10).

aliases_only (Optional)

Will compare the given address to aliases and will limit the returned list to only the correct address of a given alias.

jsonp (Optional)

JSONP callback function name, if omitted the API will return JSON.

Example Call

http://api.addressify.com.au/address/getSimilar?api_key={your API key}&term=1+Gearge+Drive+Sidney+QLD+2000

Example Response

["1 GEORGE ST, SYDNEY NSW 2000"]

address/validate

Checks whether the given address is valid. Please note that validation is only performed on the street, suburb, state and postcode. Street and unit numbers are not checked for validity. For Unit/Level/Street number validation please refer to the addresspro/validate endpoint

Arguments

api_key (Required)

Your API key.

term (Required)

The address to validate.

jsonp (Optional)

JSONP callback function name, if omitted the API will return JSON.

Example Call

http://api.addressify.com.au/address/validate?api_key={your API key}&term=680+George+Street+Sydney+NSW+2000

Example Response

true

address/addressLineAutoComplete

Returns a list of complete address lines for the given incomplete address line term. Building/Unit/Level/Street number information is piped through from the user input. To include this information and to only return addresses where the Unit/Level/Street number exists please refer to the addresspro/autoComplete endpoint.

Arguments

api_key (Required)

Your API key.

term (Required)

The start of an address line.

state (Optional)

The state to search for addresses in. ('NSW', 'ACT', 'VIC', 'QLD', 'SA', 'WA', 'NT', 'TAS')

postcode (Optional)

The postcode to search for addresses in.

max_results (Optional)

The maximum number of results to return (minumum: 1, maximum: 20, default: 10).

jsonp (Optional)

JSONP callback function name, if omitted the API will return JSON.

Example Call

http://api.addressify.com.au/address/addressLineAutoComplete?api_key={your API key}&term=1+Geor&state=nsw&max_results=5&jsonp=callback

Example Response

callback(["1 GEORDIE ST","1 GEORGANN ST","1 GEORGE AVE","1 GEORGE CL","1 GEORGE CRES"]);

address/suburbAutoComplete

Returns a list of suburbs that begin with the given term.

Arguments

api_key (Required)

Your API key.

term (Required)

The start of a suburb name

state (Optional)

The state to search for addresses in. ('NSW', 'ACT', 'VIC', 'QLD', 'SA', 'WA', 'NT', 'TAS')

postcode (Optional)

The postcode to search for addresses in.

max_results (Optional)

The maximum number of results to return (minumum: 1, maximum: 20, default: 10).

jsonp (Optional)

JSONP callback function name, if omitted the API will return JSON.

Example Call

http://api.addressify.com.au/address/suburbAutoComplete?api_key={your API key}&term=Su&state=nsw&max_results=5

Example Response

["SUFFOLK PARK","SUGARLOAF","SUMMER HILL","SUMMER HILL CREEK","SUMMER ISLAND"]

address/suburbStatePostcodeAutoComplete

Returns a list of suburbs and postcodes where the suburb begins with the given term.

Arguments

api_key (Required)

Your API key.

term (Required)

The start of a suburb name.

state (Optional)

The state to search for addresses in. ('NSW', 'ACT', 'VIC', 'QLD', 'SA', 'WA', 'NT', 'TAS')

postcode (Optional)

The postcode to search for addresses in.

max_results (Optional)

The maximum number of results to return (minumum: 1, maximum: 20, default: 10).

jsonp (Optional)

JSONP callback function name, if omitted the API will return JSON.

Example Call

http://api.addressify.com.au/address/suburbStatePostcodeAutoComplete?api_key={your API key}&term=Sum&max_results=5

Example Response

["SUMMER HILL, NSW 2130","SUMMER HILL, NSW 2421","SUMMER HILL CREEK, NSW 2800","SUMMER ISLAND, NSW 2440","SUMMERHILL, TAS 7250"]

address/getSuburbsForPostcode

Returns a list of suburbs for the given postcode.

Arguments

api_key (Required)

Your API key.

term (Required)

The postcode.

jsonp (Optional)

JSONP callback function name, if omitted the API will return JSON.

Example Call

http://api.addressify.com.au/address/getSuburbsforPostcode?api_key={your API key}&term=2000

Example Response

["BARANGAROO, NSW 2000","DAWES POINT, NSW 2000","HAYMARKET, NSW 2000","MILLERS POINT, NSW 2000","SYDNEY, NSW 2000","SYDNEY SOUTH, NSW 2000","THE ROCKS, NSW 2000"]

address/getStateForPostcode

Returns the state in which the given postcode is located.

Arguments

api_key (Required)

Your API key.

term (Required)

The postcode.

jsonp (Optional)

JSONP callback function name, if omitted the API will return JSON.

Example Call

http://api.addressify.com.au/address/getStateForPostcode?api_key={your API key}&term=2000

Example Response

"NSW"

Account Endpoints

account.getDailyAPICallCount

Returns the current daily API call count for your account. This counter will reset at 12:00 AM AEST. When this counter reaches the daily API call limit for your account type all other Addressify API calls will throw a 1002 error code until the counter resets. Will return -1 if the api_key does not exist.

Arguments

api_key (Required)

Your API key.

jsonp (Optional)

JSONP callback function name, if omitted the API will return JSON.

Example Call

http://api.addressify.com.au/account/getDailyAPICallCount?api_key={your API key}

Example Response

1000

Legacy Endpoints

address/getParsedAddress

Parses the given address into it's individual address fields. Please note: This is a legacy endpoint included for backwards compatibility with previous versions of Addressify and has been superseded. Please use the address/parse endpoint for all new implementations. This endpoint will duplicate the values in the LevelType and LevelNumber keys into the UnitType and UnitNumber keys when the UnitType and UnitNumber keys are null to cater for the fact that previous versions of addressify treated levels as units.

Arguments

api_key (Required)

Your API key.

term (Required)

The address to parse.

jsonp (Optional)

JSONP callback function name, if omitted the API will return JSON.

Example Call

http://api.addressify.com.au/address/getParsedAddress?api_key={your API key}&term=1+george+st+sydenham+nsw+2044

Example Response

{"UnitNumber":null, "Number":"1", "Street":"GEORGE", "StreetType":"ST", "Suburb":"SYDENHAM", "State":"NSW", "Postcode":"2044", "NumberFirst":"1", "NumberLast":null, "StreetSuffix":null, "StreetLine":"1 GEORGE ST", "BuildingName":null, "StreetSuffixFull":null, "StreetTypeFull":"STREET", "UnitType":null, "UnitTypeFull":null, "LevelType":null, "LevelTypeFull":null, "LevelNumber":null}

Error Codes

1000 Missing Parameter

Is returned when a required parameter is missing

HTTP Status Code

400 Bad Request

errorCode

1000

errorMessage

Required parameter missing: {parameter}

Example Response

{"errorCode":1000,"errorMessage":"Required parameter missing: term"}

1001 API Key Incorrect

Is returned when the API key is missing or incorrect

HTTP Status Code

401 Unauthorized

errorCode

1001

errorMessage

api_key missing or incorrect

Example Response

{"errorCode":1001,"errorMessage":"api_key missing or incorrect"}

1002 Daily Calls Exceeded

Is returned when the daily call allocation is exceeded on a plan with a set daily call limit

HTTP Status Code

400 Bad Request

errorCode

1002

errorMessage

Daily API call allocation exceeded

Example Response

{"errorCode":1002,"errorMessage":"Daily API call allocation exceeded"}

1003 Incorrect Plan

Is returned when a call is made to an endpoint that is unavailable on the current plan

HTTP Status Code

400 Bad Request

errorCode

1003

errorMessage

Call not available on this plan

Example Response

{"errorCode":1003,"errorMessage":"Call not available on this plan"}