Base URL and authentication
Hosted requests use https://addressr.p.rapidapi.com.
Send the API key and host headers supplied by RapidAPI. Keep the key on your server, never in public browser code. A self-hosted default installation uses http://localhost:8080 and its authentication depends on your deployment.
curl "https://addressr.p.rapidapi.com/addresses?q=300+Barangaroo+Ave" \
-H "x-rapidapi-key: $RAPIDAPI_KEY" \
-H "x-rapidapi-host: addressr.p.rapidapi.com"Need a key? Select an Addressr plan on RapidAPI.
Common tasks
Search addresses
GET /addresses?q={query}
Search by any known component, such as street, suburb, postcode or state. Results include sla, pid and links to related resources.
curl "https://addressr.p.rapidapi.com/addresses?q=1+George+St+Sydney" \
-H "x-rapidapi-key: $RAPIDAPI_KEY" \
-H "x-rapidapi-host: addressr.p.rapidapi.com"Get structured address details
GET /addresses/{pid}
Use the pid returned by search to retrieve structured address fields and available geocoding. Follow the response Link headers to related locality, postcode and state resources.
Search suburbs and towns
GET /localities?q={query}
Search locality names and receive state, postcode and classification details.
Search postcodes
GET /postcodes?q={prefix}
Search by postcode prefix and receive associated suburbs and towns.
Search states and territories
GET /states?q={query}
Search by state or territory name or abbreviation.
Runtime contract and errors
This page is a task guide, not the authoritative API contract. A running Addressr service publishes supplementary OpenAPI at /api-docs; response links are the authoritative way to navigate available resources.
- 400: correct the query or path parameter.
- 401 or 403: check the hosted API key and plan.
- 404: the requested identifier was not found.
- 429: the RapidAPI plan limit or rate limit was reached.
- 5xx: retry with backoff and check the Addressr service status.
For a complete first request, see the hosted API quick start.