Address Autocomplete API
/address_autocomplete
Address Auto-Complete is a powerful API query that can save users time and reduce errors by predicting and suggesting Australian addresses as they are being typed. This feature can be integrated into any web or mobile application to streamline data entry and improve overall data accuracy.
Example Request
GETRequest Schema
partial_address
The first 4 or more characters of the address, street, suburb or postcode.
type
address (full addresses with GNAF id), street (street names with suburb/postcode/state), suburb (suburbs with postcode/state), or postcode (suburbs within a postcode). Default address.
max_results
Maximum number of results to return. Default 20.
Available Response Data
3 Data Pointsmatches array
Each match contains type, address_id GNAF, address_option single-line address ready for a SELECT element, address_combined just the street part for address/street type, suburb, postcode, state
more_results boolean
indicates whether there are more results beyond max_results
api_reference for log tracing
API Data Scale & Coverage tag
Unmatched data depth to power your compliance and verification workflows.
Technical Use Cases tag
Form Optimisation
Can be integrated into any web or mobile application to streamline data entry and improve overall data accuracy.
Checkout Optimisation
Reduce cart abandonment and shipping errors by instantly validating customer addresses during checkout.
CRM Data Hygiene
Standardise address data at the point of entry for sales and support teams.
Compliance & Security tag
Enterprise-grade infrastructure audited against the standards your regulators require.
Common Questions tag
Everything you need to know about implementation details and compliance infrastructure.
rocket_launch Implementation
Why is the minimum query length 4 characters?
add
Why is the minimum query length 4 characters?
Anything shorter returns too many matches to be useful and triggers a lot of unnecessary load. The minimum is enforced server-side and you’ll get a 400 back if you send fewer than 4 characters.
rocket_launch Implementation
How do I render the results in a SELECT element?
add
How do I render the results in a SELECT element?
Each match has an address_option field with the full address as a single string (e.g. “6 PACKHAM PL CHARNWOOD ACT 2615”), ready to use as the visible option text. Use address_id as the option value so you can resolve it back to a GNAF later.
API Testing Sandbox tag
Test the Address Autocomplete API directly in your browser with live mock data and see instant results.
rocket_launch Request Sandbox AccessAccess to live sandbox environments requires manual approval from our compliance team.