Reverse Geocode

GET

https://api.prontiq.dev

address

reverse

Reverse geocode nearby addresses

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

const url = 'https://api.prontiq.dev/v1/address/reverse';
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/reverse"

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/reverse")
  .header("X-Api-Key", "<api-key>")
  .asString();

package main

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

func main() {

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

	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/reverse")

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

{
  "results": [
    {
      "id": "GAQLD156786950",
      "addressLabel": "9 ENDEAVOUR COURT",
      "localityName": "LAMMERMOOR",
      "state": "QLD",
      "postcode": "4703",
      "confidence": 2,
      "geocode": {
        "latitude": -23.1601,
        "longitude": 150.7596,
        "type": "PROPERTY CENTROID",
        "reliability": 2
      },
      "location": {
        "lat": -23.1601,
        "lon": 150.7596
      },
      "boundaries": {
        "lga": {
          "name": "Livingstone Shire"
        },
        "stateElectorate": {
          "name": "Keppel"
        },
        "commonwealthElectorate": {
          "name": "Capricornia"
        },
        "meshBlock": {
          "code": "30000000000",
          "category": "Residential"
        },
        "sa2": {
          "name": "Yeppoon",
          "code": "308011188"
        },
        "sa3": {
          "name": "Rockhampton",
          "code": "30801"
        },
        "sa4": {
          "name": "Central Queensland",
          "code": "308"
        }
      },
      "distance_m": 0
    }
  ],
  "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 Reverse Geocode when your input is a latitude and longitude and you need nearby Australian addresses sorted by distance. For request examples and response handling, see the Reverse geocode guide.

Authorizations

X-Api-Key

string

header

required

Query Parameters

lat

number

required

Latitude in WGS84 decimal degrees for the reverse-geocode search point.

Required range: -90 <= x <= 90

Example:

-23.1601

lon

number

required

Longitude in WGS84 decimal degrees for the reverse-geocode search point.

Required range: -180 <= x <= 180

Example:

150.7596

radius

number

default:100

Search radius in metres.

Required range: 1 <= x <= 50000

Example:

200

limit

integer

default:5

Maximum number of nearby addresses 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

Nearby addresses sorted by distance from the submitted coordinate.

Addresses nearest to the supplied latitude and longitude.

results

object[]

required

Nearby address documents sorted by distance from the submitted coordinate. The array may be empty when no address falls within the radius.

Show child attributes

total

integer

required

Total address records found within the requested radius.

Required range: x >= 0

Example:

1

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
}

Enrich

Postcode Lookup

Reverse geocode nearby addresses

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

const url = 'https://api.prontiq.dev/v1/address/reverse';
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/reverse"

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/reverse")
  .header("X-Api-Key", "<api-key>")
  .asString();

package main

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

func main() {

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

	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/reverse")

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

{
  "results": [
    {
      "id": "GAQLD156786950",
      "addressLabel": "9 ENDEAVOUR COURT",
      "localityName": "LAMMERMOOR",
      "state": "QLD",
      "postcode": "4703",
      "confidence": 2,
      "geocode": {
        "latitude": -23.1601,
        "longitude": 150.7596,
        "type": "PROPERTY CENTROID",
        "reliability": 2
      },
      "location": {
        "lat": -23.1601,
        "lon": 150.7596
      },
      "boundaries": {
        "lga": {
          "name": "Livingstone Shire"
        },
        "stateElectorate": {
          "name": "Keppel"
        },
        "commonwealthElectorate": {
          "name": "Capricornia"
        },
        "meshBlock": {
          "code": "30000000000",
          "category": "Residential"
        },
        "sa2": {
          "name": "Yeppoon",
          "code": "308011188"
        },
        "sa3": {
          "name": "Rockhampton",
          "code": "30801"
        },
        "sa4": {
          "name": "Central Queensland",
          "code": "308"
        }
      },
      "distance_m": 0
    }
  ],
  "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"
  }
}