# 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](/guides/predictive/quickstart) to request suggestions and retrieve a selected address.

| You want to… | Use |
| --- | --- |
| Suggest addresses from partial input | [Suggest addresses](/reference/predictive-v1-predictions#suggest-addresses) |
| Suggest localities from partial input | [Suggest localities](/reference/predictive-v1-predictions#suggest-localities) |
| Retrieve a selected address | [Get address details](/reference/predictive-v1-predictions#get-address-details) |
| Configure an ArcGIS-compatible locator | [ArcGIS Locator guide](/guides/predictive/esri-compatible-locator) |

**Access:** Use a Geoscape Hub application with Predictive API access.

Send its Consumer Key directly in the `Authorization` header. See [Authentication](/guides/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](/guides/predictive/autocomplete): choose filters, handle suggestions, and retrieve selected records
- [ArcGIS Locator](/guides/predictive/esri-compatible-locator): configure the locator in ArcGIS Online
- [Error Handling](/guides/errors), [Rate Limiting](/guides/rate-limiting), and [Attribution](/guides/attribution): apply shared integration requirements

## Versions

| Version | Reference |
| --- | --- |
| v1 | [Endpoint reference](/reference/predictive-v1-predictions) |