Microburbs API

Version V1.0.2

Welcome to the Microburbs API documentation. This API provides comprehensive property and suburb data for Australia, including demographics, market trends, amenities, and more.

Getting Started

To use the Microburbs API, you'll need an API key. You can request an API key by contacting our support team.

Authentication

All API requests must include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Base URL

All API URLs referenced in this documentation have the following base:

https://www.microburbs.com.au/report_generator/api

API Categories

The API is organized into the following categories:

Avm: No description available
Cma: No description available
Property: Retrieve detailed property information, market values, history, and comparative analysis for specific properties across Australia.
Property_finder: No description available
Suburb: Access comprehensive information about Australian suburbs including geographic data, demographics, amenities, market trends, schools, and risk factors.

Error Handling

The API uses standard HTTP status codes to indicate the success or failure of a request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error with the request, and codes in the 5xx range indicate a server error.

Status Code	Description
200 - OK	The request was successful.
400 - Bad Request	The request was invalid or cannot be served.
401 - Unauthorized	The API key is missing or invalid.
404 - Not Found	The requested resource could not be found.
429 - Too Many Requests	You have exceeded your rate limit.
500 - Server Error	An error occurred on the server.