Free sandbox: try any request below on the sample suburbs, no signup. For every suburb, create an API key.

Microburbs Property Data API

Discovery

Search endpoints

GET/v1/endpoints/searchFree

Find the endpoint that answers a question, in plain English: how many people rent in Bondi, is this house in a flood zone, schools near 10 Smith St. Searches every endpoint's summary, documentation, section, parameters and response field names; tolerates typos and knows common synonyms (schools ↔ education, crime ↔ safety, DA ↔ development application).

Each result carries the path, price, a ready-to-run example call on the sandbox key, and the matching MCP tool name. No key needed; rate limited per IP.

About this data ↓

Authorization

Bearer tokentest

Sandbox key test works for the allowlisted GNAF + SAL — no signup.

Request

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

Query parameters

qstringrequired

What you want to know, in plain words.

limitinteger1–20optional

How many endpoints to return.

Responses

Successful Response

application/json

EndpointSearchResultfields returned to you

querystringalways returned

The query as received.

resultsarray of EndpointMatchmay be null

Best match first.

total_endpointsintegeralways returned

How many endpoints were searched.

rankingstringalways returned

`keyword` (BM25 + typo + synonyms) or `hybrid` (keyword blended with semantic similarity).

About this data

What this is

A search engine over this API. Ask a question in plain English, such as "how many people rent in Bondi" or "is this house in a flood zone", and get back the endpoints that answer it, best match first.

What people use it for

AI agents: pick the right tool from hundreds of endpoints without loading the whole catalogue.
Developers: find an endpoint by what it answers, not by its path.
Product teams: see which data exists for a feature idea before building it.

Tips

It is free and needs no key; it is rate limited per IP. It tolerates typos and knows common synonyms (schools and education, crime and safety, DA and development application). Each result includes a ready-to-run example call on the sandbox key and the matching MCP tool name, so you can try it at once.

GET/v1/endpoints/search

cURL

curl --request GET \
  --url 'https://api.microburbs.com.au/v1/endpoints/search?q=how%20many%20people%20rent%20in%20Bondi' \
  --header 'Authorization: Bearer test'

Example Responses

Show schema

{
  "data": {
    "query": "how many people rent in Bondi",
    "ranking": "keyword",
    "results": [
      {
        "description": "Shown in the suburb report as the 'Housing Tenure' card in the Demographics section. Explicit total owner-occupation rate plus owned-outright / mortgaged / renting / public-housing shares (percent, 0-100; renting pct includes…",
        "example_call": "curl 'https://api.microburbs.com.au/v1/suburbs/Belmont+North/demographics/tenure' -H 'Authorization: Bearer test'",
        "matched_fields": [
          "mortgaged_pct",
          "owned_outright_pct",
          "owner_occupied_pct"
        ],
        "matched_terms": [
          "rent",
          "tenure",
          "owner"
        ],
        "mcp_tool": "suburbs_demographics_tenure",
        "method": "GET",
        "path": "/v1/suburbs/{suburb_name}/demographics/tenure",
        "price_cents": 20,
        "score": 1,
        "section": "Suburb - Demographics",
        "summary": "Housing Tenure (by suburb)",
        "tags": [
          "Suburb - Demographics",
          "Mesh Block - Homes"
        ]
      },
      {
        "description": "Who owns and who rents here? For every mesh block in the suburb: shares of homes owned outright, mortgaged and rented in the surrounding area, the median mortgage repayment, the share of properties ever listed for rent, and rent assistance…",
        "example_call": "curl 'https://api.microburbs.com.au/v1/suburbs/Belmont+North/mesh-blocks/tenure' -H 'Authorization: Bearer test'",
        "matched_fields": [],
        "matched_terms": [
          "rent",
          "rented",
          "tenure"
        ],
        "mcp_tool": "suburbs_mesh_blocks_tenure",
        "method": "GET",
        "path": "/v1/suburbs/{suburb_name}/mesh-blocks/tenure",
        "price_cents": 20,
        "score": 0.9062,
        "section": "Suburb - Demographics",
        "summary": "Tenure by mesh block — owned, mortgaged, rented (by suburb)",
        "tags": [
          "Suburb - Demographics",
          "Mesh Block - Homes"
        ]
      },
      {
        "description": "Who owns and who rents here? For every mesh block around the property: shares of homes owned outright, mortgaged and rented in the surrounding area, the median mortgage repayment, the share of properties ever listed for rent, and rent…",
        "example_call": "curl 'https://api.microburbs.com.au/v1/properties/GANSW704074813/mesh-blocks/tenure' -H 'Authorization: Bearer test'",
        "matched_fields": [],
        "matched_terms": [
          "rent",
          "rented",
          "tenure"
        ],
        "mcp_tool": "properties_mesh_blocks_tenure",
        "method": "GET",
        "path": "/v1/properties/{gnaf_id}/mesh-blocks/tenure",
        "price_cents": 20,
        "score": 0.8981,
        "section": "Property - Context",
        "summary": "Tenure by mesh block — owned, mortgaged, rented within 1 km (by gnaf_id)",
        "tags": [
          "Property - Context",
          "Mesh Block - Homes"
        ]
      }
    ],
    "total_endpoints": 348
  }
}

Successful Response200

application/json