Developer Docs

Quick Start

1. Create an API consumer and issue credentials.
2. Call autocomplete with Basic auth.
3. Use PID from autocomplete to hydrate full address details.

curl "http://10.0.1.36:8082/v1/autocomplete?q=123+king+st&country=AU" \
  -H "Authorization: Basic <base64(key_id:secret_key)>"

Authentication

All v1 endpoints use Basic auth with key_id:secret_key. Browser credentials must include an allowed origin policy.

Open Swagger UI or view OpenAPI JSON.

Core Endpoints

• GET /v1/autocomplete search suggestions by partial input.
• GET /v1/addresses/{pid} resolve a selected PID to full address.
• GET /v1/dataset read active dataset/version metadata.

Error Format

{"error":{"code":"invalid_request","message":"country is required"}}