Quickstart

1. Create an account

Create a Prontiq account from the product site, then open the console. The console is where you manage API keys, usage, and billing.

Open Prontiq

Create your account, then continue in the console.

2. Create an API key

In the console, open API keys and create a key for your organization. Copy the raw key when it is revealed; Prontiq only shows it once. Store the key in an environment variable:

export PRONTIQ_API_KEY="YOUR_API_KEY"

API keys are server-side secrets. Do not put them in browser code, mobile apps, screenshots, docs, or source control.

3. Make your first call

curl -i "https://api.prontiq.dev/v1/address/autocomplete?q=9+endeavour+cou" \
  -H "X-Api-Key: $PRONTIQ_API_KEY"

const response = await fetch(
  "https://api.prontiq.dev/v1/address/autocomplete?q=9+endeavour+cou",
  {
    headers: { "X-Api-Key": process.env.PRONTIQ_API_KEY ?? "" },
  },
);

const data = await response.json();
console.log(data.suggestions[0].addressLabel);

import os
import requests

response = requests.get(
    "https://api.prontiq.dev/v1/address/autocomplete",
    params={"q": "9 endeavour cou"},
    headers={"X-Api-Key": os.environ["PRONTIQ_API_KEY"]},
)

data = response.json()
print(data["suggestions"][0]["addressLabel"])

4. Confirm the response

Successful responses include a request id and request-time usage headers. Header values are based on the current account state and may vary by plan, product, and billing period.

HTTP/2 200
X-Request-Id: req_018f4d8c-...
X-RateLimit-Product: address
X-RateLimit-Reset: <period reset timestamp>
X-RateLimit-Limit: <current limit when applicable>
X-RateLimit-Remaining: <remaining credits when applicable>

{
  "suggestions": [
    {
      "id": "GAQLD156786950",
      "addressLabel": "9 ENDEAVOUR COURT",
      "localityName": "LAMMERMOOR",
      "state": "QLD",
      "postcode": "4703",
      "prontiqMatchScore": 92,
      "prontiqMatchQuality": "high"
    }
  ],
  "total": 1
}

5. What’s next?

Authentication

Learn how API keys work and how to handle auth failures.

Error handling

Handle 4xx and 5xx responses with request-id tracing.

Rate limits

Understand request-time headers, quota outcomes, and retries.

Autocomplete

Build real-time typeahead with the Address API.

Getting Started

Address API

SDKs

1. Create an account

Open Prontiq

2. Create an API key

3. Make your first call

4. Confirm the response

5. What’s next?

Authentication

Error handling

Rate limits

Autocomplete

​1. Create an account

Open Prontiq

​2. Create an API key

​3. Make your first call

​4. Confirm the response

​5. What’s next?

Authentication

Error handling

Rate limits

Autocomplete

1. Create an account

2. Create an API key

3. Make your first call

4. Confirm the response

5. What’s next?