canonical: https://jentic.com/apis/microburbs.com.au/microburbs

# Microburbs Property Data API

The Microburbs Property Data API returns suburb and property data for Australian localities, keyed to GNAF property IDs and ABS suburb names. It resolves an address to a gnaf_id, then returns a property's automated valuation (AVM), sale and rent history, comparables, zoning, nearby schools and transport, and risk layers such as bushfire, flood, landslide, and heritage. At suburb level it covers median sale price and rent series, yield, days on market, sale forecasts, demographics, crime, schools, development applications, and boundary shapes, plus a suburb finder that filters and sorts across the country. Pricing is per endpoint, and every metered response reports its cost in the X-Cost-Cents header.

## For AI agents

Look up Australian property and suburb data: resolve an address to a GNAF ID, then get valuations, sales and rent history, risks, demographics, and market indicators.

## Scope

Does not cover properties outside Australia, list properties for sale on your behalf, or process mortgage applications. Use for Australian property and suburb data lookups only.

## Capabilities

- Resolve an Australian street address to a GNAF property ID with the geocode address operation
- Get a property's automated valuation with predicted_price and its low and high range
- Read a property's sale history, rent history, and comparable recent sales nearby
- Check property hazards including bushfire, flood, historical flood, landslide, erosion, and heritage
- Pull suburb market indicators such as median sale price, median rent, yield-pct, and days on market
- Search and rank suburbs with the suburb finder by filter, states, and a sort such as grossYield or vacancyRate
- Retrieve suburb demographics, crime summaries, school catchments, and development applications

## Use cases

### Property research agent through Jentic

A buyer's agent or property research assistant answers questions about a specific Australian address. Through Jentic it resolves the address to a gnaf_id, then calls the AVM, sale history, and risks operations for that property and summarises value, past sales, and hazards. Your Microburbs key stays on your own Jentic One instance, and your rules can hold the agent to the property operations you choose so it does not run up per-call costs elsewhere.

Example prompt: GET `/v1/geocode/address` with address '27 Arlington St, Belmont North NSW', then GET `/v1/properties/GANSW704074813/valuation/avm` and `/v1/properties/GANSW704074813/risks/all` and summarise the result

### Suburb screening for investors

Investors comparing markets can screen every Australian suburb with the finder search, filtering by states and property_type and sorting by fields such as grossYield, vacancyRate, or growthForecast4yr. The count operation sizes the result first, and each shortlisted suburb can be followed up with its market, forecast, and supply-pressure operations.

Example prompt: GET `/v1/suburbs/finder/search` with states 'QLD', property_type 'house', sort '-grossYield', limit 20, then GET `/v1/suburbs/{suburb_name}/market/vacancy-rate` for each result

### Hazard and risk checks for lending and insurance

Lenders and insurers can check a property's exposure before quoting. The risks operations cover bushfire, flood, historical flood, landslide, erosion, high-voltage power lines, mobile black spots, and environment, and the risks/all bundle returns them in one call at a flat bundle price.

Example prompt: GET `/v1/properties/GAVIC419929404/risks/all` and flag any non-empty bushfire or flood result

### Suburb profiles for listings and content

Real estate portals and agencies can add suburb context to a listing: median price and rent series, demographics such as age and income, school catchments, crime summaries, lifestyle points of interest, and boundary shapes as GeoJSON for maps.

Example prompt: GET `/v1/suburbs/Unley/profile`, `/v1/suburbs/Unley/market/median-sale-price-series`, and `/v1/suburbs/Unley/shapes/boundary` with geojson true

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/v1/geocode/address` | Resolve an address to a GNAF ID |
| GET | `/v1/properties/{gnaf_id}/valuation/avm` | Automated valuation |
| GET | `/v1/properties/{gnaf_id}/sale-history` | Property sale history |
| GET | `/v1/properties/{gnaf_id}/risks/all` | All property risks |
| GET | `/v1/suburbs/{suburb_name}/profile` | Suburb profile |
| GET | `/v1/suburbs/{suburb_name}/market/all` | All suburb market indicators |
| GET | `/v1/suburbs/finder/search` | Search and rank suburbs |

## Key resources

- **Properties** — Valuation, basics, history, comparables, zoning, schools, transport, and risks per gnaf_id
- **Suburbs** — Market, forecast, demographics, crime, schools, development, lifestyle, and shapes per suburb_name
- **Suburb finder** — Filter, count, and sort suburbs nationally
- **Geocode** — Resolve addresses to GNAF IDs and match suburb names
- **Area stats** — Query statistics for regions at a chosen region_level

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 61 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 92 / 100
  - Developer Experience & Jentic Compatibility: 65 / 100
  - AI-Readiness & Agent Experience: 50 / 100
  - Agent Usability: 55 / 100
  - Security: 60 / 100
  - AI Discoverability: 66 / 100
- **View full report:** https://jentic.com/apis/microburbs.com.au/microburbs/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring Microburbs by hand means handling its bearer key, resolving addresses to GNAF IDs first, branching on null data responses, and reading per-call cost headers. Through Jentic you install once, import Microburbs from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Microburbs puts the property gnaf_id and the suburb_name in the URL path (`/v1/properties/{gnaf_id}/...`), so a rule can limit your agent to one property or suburb and the operations you pick. Because every call is metered, choosing a narrow operation set also bounds what the agent can spend.
- **Credential handling:** Your Microburbs key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'flood risk for an Australian address' or 'median rent in a suburb', and Jentic returns the matching Microburbs operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **ATTOM API** — Property, valuation, and hazard data for the United States
- **RentCast API** — Rent estimates, valuations, and listings for US properties
- **Geoapify API** — Geocoding, routing, and maps worldwide

## FAQ

### What authentication does the Microburbs Property Data API use?

Per its OpenAPI spec, the Microburbs API uses an API key sent as a bearer token (BearerAuth): `Authorization: Bearer <key>`. The key `test` works as a public sandbox for a fixed set of sample properties and suburbs at no cost, and any other value needs a key minted on the Microburbs developer portal. Through Jentic the key is stored encrypted by your own Jentic One instance and injected when the agent calls.

### How is the Microburbs API priced?

Pricing is per endpoint and prepaid. Every metered response carries X-Cost-Cents with the exact cents billed, X-Spent-Cents and X-Remaining-Cents for the wallet, and calls stop when the remaining credit reaches zero. Bundle endpoints such as `/v1/properties/{gnaf_id}/risks/all` ship at a flat bundle price.

### How do I value a property through Jentic?

Install Jentic One with `curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh`, import the Microburbs API from the directory, and store your key. Your agent searches 'get an automated valuation for an Australian property', resolves the address with GET `/v1/geocode/address`, then calls GET `/v1/properties/{gnaf_id}/valuation/avm.` To run it on your own infrastructure, install Jentic One from its GitHub repo.

### Can I limit what my agent is allowed to do with the Microburbs API?

Yes. For example, allow only GET `/v1/geocode/address` and the `/v1/properties/{gnaf_id}/valuation` and risks operations, so a lending assistant can value and risk-check addresses but cannot run up per-call charges on the suburb demographic and lifestyle endpoints. Every call it makes is logged.

### Is there a Microburbs MCP server?

Yes - Microburbs offers an official MCP server, documented in its API reference. You can also connect the Microburbs API directly through Jentic: your agent gets the full 174-endpoint surface from the spec without loading another server's tool definitions into its context, your key is injected at call time by your self-hosted instance instead of living in an MCP config, and your rules decide which operations the agent may call.

### What are the rate limits for the Microburbs API?

The OpenAPI spec does not state numeric rate limits; it documents 429 responses for throttling. Check the Microburbs API docs at https://www.microburbs.com.au/developers/api-docs for current limits.

### What happens when Microburbs has no data for a property?

The call still returns HTTP 200, with data set to null, available false, and a stable reason slug such as no_avm_for_GANSW704074813 plus a human-readable message. Branch on data being non-null rather than on the status code.