# prontiq

## Docs

- [Autocomplete](https://docs.prontiq.dev/api-reference/autocomplete.md): Suggest Australian addresses as a user types. Use this endpoint for typeahead UI flows, then pass the selected `id` to [Enrich](/api-reference/enrich) when you need coordinates, boundaries, and full record metadata. Suggestions include Prontiq match-quality fields; G-NAF confidence and internal sear…
- [Enrich](https://docs.prontiq.dev/api-reference/enrich.md): Return the richest public address document for a known G-NAF address `id` returned by Autocomplete, Validate, or Reverse geocode. Use this after a user selects an address when you need structured components, geocodes, boundaries, locality and street context, aliases, secondaries, and source-record m…
- [API Reference](https://docs.prontiq.dev/api-reference/overview.md): Interactive reference for the public Prontiq Address API.
- [Postcode Lookup](https://docs.prontiq.dev/api-reference/postcode-lookup.md): List suburbs or localities that have address records in a four-digit Australian postcode. Use this for postcode-first forms, locality dropdowns, and coverage checks. `address_count` is dataset cardinality, not billing usage.
- [Reverse Geocode](https://docs.prontiq.dev/api-reference/reverse.md): Find addresses near a latitude and longitude. Use this when a workflow starts from a map pin, device coordinate, or spatial search. Results are ordered by distance and include `distance_m` in metres.
- [Suburb Lookup](https://docs.prontiq.dev/api-reference/suburb-lookup.md): Find postcodes for an Australian suburb or locality. Add `state` to disambiguate common locality names that exist in multiple states. Responses may include an approximate bounding box and total address count.
- [Validate](https://docs.prontiq.dev/api-reference/validate.md): Find the best G-NAF match for a submitted address string and classify request match quality. Use `prontiqMatchScore` and `prontiqMatchQuality` for acceptance thresholds and user prompts. If `match` is present, `match.confidence` is separate G-NAF source-record metadata for the address record.
- [Autocomplete](https://docs.prontiq.dev/guides/address/autocomplete.md): Build real-time Australian address typeahead.
- [Data Dictionary](https://docs.prontiq.dev/guides/address/data-dictionary.md): Definitive field reference for every public Address API attribute: types, meanings, edge cases, and source context.
- [Enrich](https://docs.prontiq.dev/guides/address/enrich.md): Fetch the richest public address document by G-NAF ID: structured components, geocodes, boundaries, aliases, and source context.
- [Address API](https://docs.prontiq.dev/guides/address/overview.md): Australian address validation, enrichment, geocoding, and lookup endpoints powered by G-NAF.
- [Postcode Lookup](https://docs.prontiq.dev/guides/address/postcode-lookup.md): Find localities inside an Australian postcode.
- [Reverse Geocode](https://docs.prontiq.dev/guides/address/reverse.md): Find Australian addresses near a latitude and longitude.
- [Suburb Lookup](https://docs.prontiq.dev/guides/address/suburb-lookup.md): Find postcodes, counts, and bounds for an Australian suburb.
- [Validate](https://docs.prontiq.dev/guides/address/validate.md): Verify a submitted Australian address string.
- [API conventions](https://docs.prontiq.dev/guides/api-conventions.md): Public field naming and response semantics used across Prontiq APIs.
- [Authentication](https://docs.prontiq.dev/guides/authentication.md): API key authentication for public Prontiq data endpoints.
- [Billing](https://docs.prontiq.dev/guides/billing.md): How Prontiq credits, plan changes, invoices, and current-period usage work.
- [Credits](https://docs.prontiq.dev/guides/credits.md): How Prontiq credits are consumed and reported in API responses.
- [Error Handling](https://docs.prontiq.dev/guides/error-handling.md): Handle Prontiq API errors, retries, and request-id tracing.
- [Prontiq](https://docs.prontiq.dev/guides/introduction.md): Australian address intelligence through one API.
- [Quickstart](https://docs.prontiq.dev/guides/quickstart.md): Create an account, create an API key, and make your first request.
- [Rate Limits & Quotas](https://docs.prontiq.dev/guides/rate-limits.md): Request-time usage headers, quota outcomes, and retry behaviour.
- [Python SDK](https://docs.prontiq.dev/guides/sdks/python.md): Python client for the Prontiq API, published as prontiq on PyPI.
- [TypeScript SDK](https://docs.prontiq.dev/guides/sdks/typescript.md): Type-safe client for the Prontiq API, auto-generated from the OpenAPI spec.

## OpenAPI Specs

- [openapi](https://docs.prontiq.dev/openapi.json)