Microburbs
Microburbs API
Live sandbox. Send any request below against one sample suburb and property — no signup needed. For full coverage, create an API key.
Classic docs
Microburbs Property Data API
Account

Health check

GET/v1/pingFree

Returns immediately if the API is up. No authentication required and not metered — safe to poll from a load balancer, uptime monitor, or status dashboard without affecting your usage.

Free.

Authorization

Request

The only values you send. Fields under Responses below are what comes back — you never pass those.

Query parameters

None — this endpoint accepts no query parameters. Call the path above with your bearer token and nothing else.

Responses

Successful Response

application/json
Response Pingfields returned to you
Type: object
GET/v1/ping
cURL
curl --request GET \
  --url 'https://api.microburbs.com.au/v1/ping' \
  --header 'Authorization: Bearer test'
Example Responses
{}
Successful Response200
application/json