Documentation
Predictive API
Use this page to choose a suggestion endpoint, prepare your first request, and find guidance on autocomplete and ArcGIS integration.
When to use this API
Suggest Australian addresses or localities while a user types. Retrieve structured address details after the user selects an address suggestion.
Start with the Predictive Quickstart to request suggestions and retrieve a selected address.
| You want to… | Use |
|---|---|
| Suggest addresses from partial input | Suggest addresses |
| Suggest localities from partial input | Suggest localities |
| Retrieve a selected address | Get address details |
| Configure an ArcGIS-compatible locator | ArcGIS Locator guide |
Access: Use a Geoscape Hub application with Predictive API access.
Send its Consumer Key directly in the Authorization header. See Authentication for application and tester setup.
Responses
- Address suggestions identify candidates. Retrieve the selected candidate's details using its returned ID
- Handle an empty suggestion list without treating it as a confirmed address
- Use the endpoint's response fields and supported CRS values when displaying or storing results
- Retain the returned attribution
Further guidance
- Autocomplete: choose filters, handle suggestions, and retrieve selected records
- ArcGIS Locator: configure the locator in ArcGIS Online
- Error Handling, Rate Limiting, and Attribution: apply shared integration requirements
Versions
| Version | Reference |
|---|---|
| v1 | Endpoint reference |
Last modified on