Skip to main content
Glama

Microburbs Australian Property Data

Suburb · Income by birthplace

suburbs_area_stats_income_by_birthplace
Read-onlyIdempotent

How much each migrant community earns: weekly personal income bands by region of birth (nine world regions), in every suburb and council area.

Coverage: About 10,800 suburbs and localities and 545 council areas across Australia, in all states and territories (areas with too few residents for reliable figures are left out); one snapshot at 10 August 2021. Current to 2021-08-10. Full description, field list and method: /v1/datasets/income-by-birthplace.

Price: 10¢ per call.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "suburb_name": "<suburb_name>"
    },
    "name": "suburbs_area_stats_income_by_birthplace"
  }
}

Input Schema

NameRequiredDescriptionDefault
toNoLast period to include, same formats as `from`.
fromNoFirst period to include: 2020, 2020-Q3, 2020-07 or 2020-07-01.
fieldsNoComma-separated subset of: all_income_stated, all_under_500_pct, all_500_to_999_pct, all_1000_to_1999_pct, all_2000_plus_pct, oceania_income_stated, oceania_under_500_count, oceania_under_500_pct, oceania_500_to_999_count, oceania_500_to_999_pct, oceania_1000_to_1999_count, oceania_1000_to_1999_pct, oceania_2000_plus_count, oceania_2000_plus_pct, north_west_europe_income_stated, north_west_europe_under_500_count, north_west_europe_under_500_pct, north_west_europe_500_to_999_count, north_west_europe_500_to_999_pct, north_west_europe_1000_to_1999_count, north_west_europe_1000_to_1999_pct, north_west_europe_2000_plus_count, north_west_europe_2000_plus_pct, southern_eastern_europe_income_stated, southern_eastern_europe_under_500_count, southern_eastern_europe_under_500_pct, southern_eastern_europe_500_to_999_count, southern_eastern_europe_500_to_999_pct, southern_eastern_europe_1000_to_1999_count, southern_eastern_europe_1000_to_1999_pct, southern_eastern_europe_2000_plus_count, southern_eastern_europe_2000_plus_pct, middle_east_north_africa_income_stated, middle_east_north_africa_under_500_count, middle_east_north_africa_under_500_pct, middle_east_north_africa_500_to_999_count, middle_east_north_africa_500_to_999_pct, middle_east_north_africa_1000_to_1999_count, middle_east_north_africa_1000_to_1999_pct, middle_east_north_africa_2000_plus_count, middle_east_north_africa_2000_plus_pct, south_east_asia_income_stated, south_east_asia_under_500_count, south_east_asia_under_500_pct, south_east_asia_500_to_999_count, south_east_asia_500_to_999_pct, south_east_asia_1000_to_1999_count, south_east_asia_1000_to_1999_pct, south_east_asia_2000_plus_count, south_east_asia_2000_plus_pct, north_east_asia_income_stated, north_east_asia_under_500_count, north_east_asia_under_500_pct, north_east_asia_500_to_999_count, north_east_asia_500_to_999_pct, north_east_asia_1000_to_1999_count, north_east_asia_1000_to_1999_pct, north_east_asia_2000_plus_count, north_east_asia_2000_plus_pct, southern_central_asia_income_stated, southern_central_asia_under_500_count, southern_central_asia_under_500_pct, southern_central_asia_500_to_999_count, southern_central_asia_500_to_999_pct, southern_central_asia_1000_to_1999_count, southern_central_asia_1000_to_1999_pct, southern_central_asia_2000_plus_count, southern_central_asia_2000_plus_pct, americas_income_stated, americas_under_500_count, americas_under_500_pct, americas_500_to_999_count, americas_500_to_999_pct, americas_1000_to_1999_count, americas_1000_to_1999_pct, americas_2000_plus_count, americas_2000_plus_pct, sub_saharan_africa_income_stated, sub_saharan_africa_under_500_count, sub_saharan_africa_under_500_pct, sub_saharan_africa_500_to_999_count, sub_saharan_africa_500_to_999_pct, sub_saharan_africa_1000_to_1999_count, sub_saharan_africa_1000_to_1999_pct, sub_saharan_africa_2000_plus_count, sub_saharan_africa_2000_plus_pct. Omit for all.
suburb_nameYesSuburb name exactly as /v1/suburbs/list returns it, e.g. `Bondi` or `St Kilda (Vic.)`.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A3.9/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already cover read-only, idempotent, non-destructive and closed-world properties, so the bar is lower; the description still adds genuinely useful facts beyond them — dataset size (about 10,800 suburbs, 545 council areas), the single-snapshot date of 10 August 2021, exclusion of areas with too few residents for reliable figures, and a 10¢ per-call price. It does not explain pagination or result ordering, but the cost and coverage caveats are exactly the kind of context an agent needs before calling.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The core definition leads, then coverage, then the documentation pointer, then price — each sentence carries distinct information with no repetition. Prose is compact despite the density of facts.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description does enough to convey what comes back (income bands by region of birth, pct and count variants are visible in the field list) and supplies coverage limits plus the data vintage. The remaining gap is that a required suburb_name plus the claim of council-area coverage gives no hint how to query a council area versus using the lga_ sibling.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline would be 3, but the description adds interpretation for the otherwise cryptic field list by explaining that fields are weekly income bands crossed with nine world regions of birth. The one unaddressed point is the from/to period parameters, which the description never reconciles with the stated single snapshot at 2021-08-10 — an agent could reasonably wonder whether time filtering does anything.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a specific resource — weekly personal income bands broken down by region of birth (nine world regions) — plus the geographic scope (suburbs and council areas). An agent can tell it apart from most siblings such as suburbs_area_stats_income_by_religion or suburbs_area_stats_birthplace. The one ambiguity is that it claims coverage of 'every suburb and council area', which overlaps with the lga_ variant and leaves the choice between them unresolved.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is implied rather than stated: the agent must infer that this is the tool to reach for when it wants income-by-birthplace figures for a location. There is no explicit when-to-use or when-not-to-use guidance, and no alternative tool is named for council-area-level or non-income requests.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources