Autocomplete - prontiq

GET

https://api.prontiq.dev

address

autocomplete

Autocomplete addresses

curl --request GET \
  --url https://api.prontiq.dev/v1/address/autocomplete \
  --header 'X-Api-Key: <api-key>'

const url = 'https://api.prontiq.dev/v1/address/autocomplete';
const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.prontiq.dev/v1/address/autocomplete"

headers = {"X-Api-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

HttpResponse<String> response = Unirest.get("https://api.prontiq.dev/v1/address/autocomplete")
  .header("X-Api-Key", "<api-key>")
  .asString();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prontiq.dev/v1/address/autocomplete"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.prontiq.dev/v1/address/autocomplete")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

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

{
  "error": {
    "code": "INVALID_PARAMETERS",
    "message": "Invalid query parameters",
    "status": 400,
    "request_id": "req_01HZX7A8J5K9P4R2QW3E6T7Y8Z",
    "details": {
      "q": [
        "Required"
      ]
    }
  }
}

{
  "error": {
    "code": "MISSING_API_KEY",
    "message": "Missing X-Api-Key header",
    "status": 401,
    "request_id": "req_01HZX7A8J5K9P4R2QW3E6T7Y8Z"
  }
}

{
  "error": {
    "code": "PRODUCT_NOT_ALLOWED",
    "message": "Product not included in your plan",
    "status": 403,
    "request_id": "req_01HZX7A8J5K9P4R2QW3E6T7Y8Z"
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Rate limit exceeded",
    "status": 429,
    "request_id": "req_01HZX7A8J5K9P4R2QW3E6T7Y8Z"
  }
}

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error",
    "status": 500,
    "request_id": "req_01HZX7A8J5K9P4R2QW3E6T7Y8Z"
  }
}

Use Autocomplete for real-time address typeahead while a user is typing. It returns multiple suggestions and their G-NAF IDs so the user can select a canonical address before you call Enrich or submit the form. For usage guidance and SDK examples, see the Autocomplete guide.

Authorizations

X-Api-Key

string

header

required

Query Parameters

string

required

Partial address text typed by the user. Send 1-200 characters; omit coordinates and use state when you already know the state.

Required string length: 1 - 200

Example:

"9 endeavour cou"

state

string

Australian state or territory filter. Allowed values are NSW, VIC, QLD, SA, WA, TAS, NT, and ACT. Input is case-insensitive and responses normalize state codes to uppercase.

Example:

"QLD"

limit

integer

default:5

Maximum number of suggestions to return.

Required range: 1 <= x <= 20

Example:

3

debug

enum<string>

Optional diagnostic flag. Send exactly true or false. Invalid values are rejected; debug diagnostics are for support only and must not be used for business decisions.

Available options:

true,

false

Example:

"false"

Response

Address suggestions returned for the partial query. The array may be empty when no address matches.

Autocomplete suggestions for a partial address query. Suggestions include Prontiq-computed match quality; G-NAF confidence and internal search relevance are not returned in default responses.

suggestions

object[]

required

Suggested address records ordered for autocomplete display. The array may be empty when no candidate addresses match the query.

Show child attributes

total

integer

required

Number of suggestions returned in this response.

Required range: x >= 0

Example:

3

debug

object

Optional diagnostic metadata returned only when debug=true is supplied. Debug values are for support and troubleshooting, not production decision-making.

Show child attributes

Example:

{
  "scoringVersion": "address-match-v1",
  "queryMode": "autocomplete",
  "searchScore": 42.1
}

API Reference

Validate

Autocomplete addresses

curl --request GET \
  --url https://api.prontiq.dev/v1/address/autocomplete \
  --header 'X-Api-Key: <api-key>'

const url = 'https://api.prontiq.dev/v1/address/autocomplete';
const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.prontiq.dev/v1/address/autocomplete"

headers = {"X-Api-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

HttpResponse<String> response = Unirest.get("https://api.prontiq.dev/v1/address/autocomplete")
  .header("X-Api-Key", "<api-key>")
  .asString();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.prontiq.dev/v1/address/autocomplete"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.prontiq.dev/v1/address/autocomplete")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

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

{
  "error": {
    "code": "INVALID_PARAMETERS",
    "message": "Invalid query parameters",
    "status": 400,
    "request_id": "req_01HZX7A8J5K9P4R2QW3E6T7Y8Z",
    "details": {
      "q": [
        "Required"
      ]
    }
  }
}

{
  "error": {
    "code": "MISSING_API_KEY",
    "message": "Missing X-Api-Key header",
    "status": 401,
    "request_id": "req_01HZX7A8J5K9P4R2QW3E6T7Y8Z"
  }
}

{
  "error": {
    "code": "PRODUCT_NOT_ALLOWED",
    "message": "Product not included in your plan",
    "status": 403,
    "request_id": "req_01HZX7A8J5K9P4R2QW3E6T7Y8Z"
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Rate limit exceeded",
    "status": 429,
    "request_id": "req_01HZX7A8J5K9P4R2QW3E6T7Y8Z"
  }
}

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error",
    "status": 500,
    "request_id": "req_01HZX7A8J5K9P4R2QW3E6T7Y8Z"
  }
}