# HtAG Developer Portal — Full Reference

> Complete API reference for LLMs. 89 endpoints, 5 MCP servers, 6 AI agents.
> For the condensed version, see [llms.txt](https://developer.htagai.com/llms.txt).

## Overview

HtAG provides programmatic access to Australian property intelligence through three channels:

1. **HTTP API** — 89+ RESTful endpoints covering market analytics, property valuations, spatial data (H3), demographics, economics, and geographic concordance
2. **MCP Servers** — 5 Model Context Protocol servers with 82+ tools, enabling AI assistants (Claude, Perplexity, Cursor, Codex) to query property data via natural language
3. **AI Agents** — 6 turnkey micro-agents for suburb analysis, market cycle timing, suburb comparison, and portfolio assessment

## Docs

- [API Documentation](https://developer.htagai.com/docs)
- [HTTP API Reference](https://developer.htagai.com/docs/rest)
- [MCP Server Guide](https://developer.htagai.com/docs/mcp)
- [MCP Setup Guide](https://developer.htagai.com/docs/mcp/setup)
- [AI Agents](https://developer.htagai.com/docs/agents)
- [Education Hub](https://developer.htagai.com/learn)
- [Pricing](https://developer.htagai.com/pricing)
- [Consulting](https://developer.htagai.com/consulting)

## API Base URLs

- HTTP API: `https://api.htagai.com/v1`
- MCP SSE endpoint: `https://api.htagai.com/mcp/v1/servers/htag/sse`
- MCP Streaming HTTP: `https://api.htagai.com/mcp/v1/servers/htag/mcp`
- Agent executions: `https://agent.htagai.com/micro-agents/agents/{agent-id}/execute`

## Authentication

- HTTP API: `x-api-key` header or Bearer token
- MCP (Claude/Perplexity): OAuth 2.0 with client_id and client_secret
- MCP (Cursor): `x-api-key` header in mcp.json config

## Key API Categories

| Category | Endpoints | Tier |
|----------|-----------|------|
| Address (geocode, environment, demographics, schools, standardise) | 5 | Standard-Premium |
| Property (summary, estimates, market, sold search, CMA) | 5 | Enhanced-Restricted |
| Market Overview (summary, growth, supply, demand, scores, fundamentals, cycle, risk, query, rank) | 15 | Standard-Premium |
| Market Trends (price, rent, yield, growth rates, demand profile) | 5 | Standard-Enhanced |
| Supply-Demand Trends (stock, inventory, DOM, clearance, vacancy, hold period, search index) | 7 | Restricted |
| Demographics (census, business activity, healthcare) | 3 | Standard |
| Economics (CPI factor/adjust/series/latest, cash rate/series) | 6 | Standard |
| Spatial H3 — Price & Rent (median price, rent, yield, years-to-own) | 4 | Enhanced |
| Spatial H3 — Market (DOM, DORM, lot size, age, holding return, discounting, hold period, listed price) | 8 | Enhanced |
| Spatial H3 — Socio-Environmental (IRSD, IRSAD, IER, IEO, public housing, flood, rental, bushfire) | 8 | Enhanced |
| Spatial H3 — Reference (resolutions, boundary, center, parent, children, neighbors) | 6 | Reference |
| Reference (locality, LGA, address keys) | 3 | Reference |
| Concordance (SA2, locality, LGA, postcode, SAL, H3, GCCSA) | 14 | Reference |

## MCP Servers

| Server | Tools | Auth | Description |
|--------|-------|------|-------------|
| Intelligence | 57 | OAuth/API Key | Core property, market, spatial, demographic data |
| Trends | 7 | Internal/Partner | Historical time series |
| Data Analytics | 7 | Internal/Partner | Read-only SQL warehouse |
| Spatial | 6 | OAuth/API Key | H3 hexagonal metrics |
| Docs | 5 | Public | Platform discovery — no auth required |

## AI Agents

| Agent | Status | Description |
|-------|--------|-------------|
| Market Cycle Timing | Live | BUY/HOLD/SELL signals with confidence scoring |
| Suburb Analysis | Live | 8-section comprehensive suburb deep-dive |
| Suburb Comparison | Live | Side-by-side comparison of 2-5 suburbs |
| Portfolio Health | Coming Soon | Loan stress testing, equity, cashflow |
| Portfolio Stress Test | Coming Soon | AI disruption & fuel crisis risk |
| Defence & Counter-Cyclical | Coming Soon | Crisis resilience scoring |

## SDKs

- Python: `pip install htag-sdk`
- TypeScript: `npm install htag-sdk`

## Contact

- Email: dev@htag.com.au
- Phone: +61 (0)2 5563 4415
- Consulting: https://developer.htagai.com/consulting

---

## Complete Endpoint Reference

### Address Geocode

#### GET /v1/address/geocode
**Summary:** Resolve address identity and coordinates
**Tier:** Standard
**Parameters:** address, mb_category_2021
**Description:** Returns the canonical address key, GNAF identifiers, coordinates, ABS geography codes, mesh block classification, and standardised address elements for the requested address.

### Address Environment

#### GET /v1/address/environment
**Summary:** Retrieve environmental risk overlays for an address
**Tier:** Premium | **Rate Limit:** 100,000/month
**Parameters:** address, address_keys, legal_parcel_id, mb_category_2021
**Description:** Returns flood, bushfire, heritage, and zoning indicators for the requested address(es).

### Address Demographics

#### GET /v1/address/demographics
**Summary:** Retrieve socio-economic and demographic indicators for an address
**Tier:** Standard | **Rate Limit:** 100,000/month
**Parameters:** address, address_keys, legal_parcel_id, mb_category_2021
**Description:** Returns ABS SEIFA indices and Census-derived housing tenure metrics for the requested address(es).

### Address Schools

#### GET /v1/address/schools
**Summary:** Retrieve schools relevant to an address
**Tier:** Standard | **Rate Limit:** 100,000/month
**Parameters:** address, address_key, radius_m
**Description:** Returns schools relevant to an Australian address.

### Address Standardisation

#### POST /v1/address/standardise
**Summary:** Batch standardise Australian addresses and generate address keys
**Tier:** Standard
**Parameters:** (request body)
**Description:** Accepts up to 50 single-line (free text) Australian addresses, standardises each into its component elements, and generates a canonical address key.

### Property

#### GET /v1/property/summary
**Summary:** Retrieve physical property attributes for an address
**Tier:** Enhanced | **Rate Limit:** 100,000/month
**Parameters:** address_key
**Description:** Returns the physical characteristics of the property at the specified address key, including property type, bedrooms, bathrooms, parking, land area, floor area, and build/renovation date.

#### GET /v1/property/estimates
**Summary:** Retrieve valuation estimates and transaction history for an address
**Tier:** Premium | **Rate Limit:** 100,000/month
**Parameters:** address_key, cma_method
**Description:** Returns index-adjusted CMA (comparative market analysis) estimates for sale price and rent.

#### GET /v1/property/market
**Summary:** Retrieve market position indicators for an address
**Tier:** Enhanced | **Rate Limit:** 100,000/month
**Parameters:** address_key
**Description:** Returns property-level market position metrics for the specified address key, including rental proportion, years to own, and typical hold period.

#### GET /v1/property/sold/search
**Summary:** Search for sold properties within a radius of an address or coordinates
**Tier:** Enhanced | **Rate Limit:** 100,000/month
**Parameters:** address, address_key, lat, lon, radius, proximity, propertyType, saleValueMin, saleValueMax, includeSaleValueUnknown, saleFromDate, saleToDate, bedrooms, bathrooms, limit, offset
**Description:** Radius-based search of sold properties using an address key, free-text address, or lat/lon point.

#### POST /v1/property/cma-structural-adjustment
**Summary:** Compute CMA structural adjustments between a subject and comparables
**Tier:** Restricted | **Rate Limit:** 10,000/month
**Parameters:** (request body)
**Description:** Returns structural price or rent adjustments between a subject property and up to 50 comparables.

### Market Summary

#### GET /v1/markets/summary
**Summary:** Retrieve core market headline metrics
**Tier:** Standard | **Rate Limit:** 100,000/month
**Parameters:** level, area_id, property_type, bedrooms, limit, offset
**Description:** Returns current market essentials: typical price, rent, yield, sales/rental volumes, estimated dwellings, adult population, and confidence level.

### Market Growth

#### GET /v1/markets/growth/cumulative
**Summary:** Retrieve cumulative growth rates
**Tier:** Enhanced | **Rate Limit:** 10,000/month
**Parameters:** level, area_id, property_type, limit, offset
**Description:** Multi-horizon cumulative growth rates for prices, rents, and yields.

#### GET /v1/markets/growth/annualised
**Summary:** Retrieve annualised compounded growth rates
**Tier:** Enhanced | **Rate Limit:** 10,000/month
**Parameters:** level, area_id, property_type, limit, offset
**Description:** Annualised compounded growth rates.

### Market Supply

#### GET /v1/markets/supply
**Summary:** Retrieve supply-side metrics snapshot
**Tier:** Enhanced | **Rate Limit:** 10,000/month
**Parameters:** level, area_id, property_type, limit, offset
**Description:** Current supply-side snapshot: lot size, inventory, building approvals, and hold period.

#### GET /v1/markets/supply/ls
**Summary:** Retrieve long-term supply slope metrics
**Tier:** Premium | **Rate Limit:** 10,000/month
**Parameters:** level, area_id, property_type, limit, offset
**Description:** Long-term slope (LS) of supply-side indicators, calculated via trend analysis regression on metric time series.

#### GET /v1/markets/supply/ss
**Summary:** Retrieve short-term supply slope metrics
**Tier:** Premium | **Rate Limit:** 10,000/month
**Parameters:** level, area_id, property_type, limit, offset
**Description:** Short-term slope (SS) of supply-side indicators, calculated via trend analysis regression on metric time series.

### Market Demand

#### GET /v1/markets/demand
**Summary:** Retrieve demand-side metrics snapshot
**Tier:** Enhanced | **Rate Limit:** 10,000/month
**Parameters:** level, area_id, property_type, limit, offset
**Description:** Current demand-side snapshot: days on market, discounting, vacancy, clearance rate, and search interest.

#### GET /v1/markets/demand/ls
**Summary:** Retrieve long-term demand slope metrics
**Tier:** Premium | **Rate Limit:** 10,000/month
**Parameters:** level, area_id, property_type, limit, offset
**Description:** Long-term slope (LS) of demand-side indicators, calculated via trend analysis regression on metric time series.

#### GET /v1/markets/demand/ss
**Summary:** Retrieve short-term demand slope metrics
**Tier:** Premium | **Rate Limit:** 10,000/month
**Parameters:** level, area_id, property_type, limit, offset
**Description:** Short-term slope (SS) of demand-side indicators, calculated via trend analysis regression on metric time series.

### Market Scores

#### GET /v1/markets/scores
**Summary:** Retrieve market scores and indices
**Tier:** Premium | **Rate Limit:** 10,000/month
**Parameters:** level, area_id, property_type, limit, offset
**Description:** Returns Relative Composite Score (RCS) rankings, HAPI score, volatility index, and confidence level.

### Market Rank

#### POST /v1/markets/rank
**Summary:** Rank a shortlist of markets by weighted metric deciles
**Tier:** Premium | **Rate Limit:** 10,000/month
**Parameters:** (request body)
**Description:** Computes a decile-based weighted score for each supplied area_id and returns a dense sequential ranking.

### Market Fundamentals

#### GET /v1/markets/fundamentals
**Summary:** Retrieve fundamental ratios and affordability metrics
**Tier:** Premium | **Rate Limit:** 10,000/month
**Parameters:** level, area_id, property_type, limit, offset
**Description:** Socio-economic fundamentals: IRSAD index, ownership/housing ratios, and affordability (years to own).

### Market Cycle

#### GET /v1/markets/cycle
**Summary:** Retrieve growth rate cycle and forward projections
**Tier:** Premium | **Rate Limit:** 10,000/month
**Parameters:** level, area_id, property_type, limit, offset
**Description:** Growth rate cycle position, GRC index, growth projection decomposition (GPD), growth stability profile (GSP), minima, and forward-looking projected annual returns.

### Market Risk

#### GET /v1/markets/risk
**Summary:** Retrieve environmental and economic risk indices
**Tier:** Premium | **Rate Limit:** 10,000/month
**Parameters:** level, area_id, property_type, limit, offset
**Description:** Environmental risk indices (flood, bushfire) and economic diversity measures for an area.

### Market Query

#### POST /v1/markets/query
**Summary:** Query market snapshots with the public filter DSL
**Tier:** Premium | **Rate Limit:** 10,000/month
**Parameters:** (request body)
**Description:** Query suburb or LGA market snapshot views using the public market filter DSL.

### Market Trends

#### GET /v1/markets/trends/price
**Summary:** Retrieve historical price trends
**Tier:** Standard | **Rate Limit:** 100,000/month
**Parameters:** level, area_id, property_type, bedrooms, limit, offset, period_end_min, period_end_max
**Description:** Historical monthly price trends for areas by property type.

#### GET /v1/markets/trends/rent
**Summary:** Retrieve historical rent trends
**Tier:** Standard | **Rate Limit:** 100,000/month
**Parameters:** level, area_id, property_type, bedrooms, limit, offset, period_end_min, period_end_max
**Description:** Historical monthly rent trends for areas by property type.

#### GET /v1/markets/trends/yield
**Summary:** Retrieve historical yield trends
**Tier:** Standard | **Rate Limit:** 100,000/month
**Parameters:** level, area_id, property_type, bedrooms, limit, offset, period_end_min, period_end_max
**Description:** Historical yield trends for areas by property type.

#### GET /v1/markets/trends/growth-rates
**Summary:** Retrieve historical growth rate changes
**Tier:** Premium | **Rate Limit:** 100,000/month
**Parameters:** level, area_id, property_type, limit, offset, period_end_min, period_end_max
**Description:** Historical annual growth rate changes for prices, rents, and yields.

#### GET /v1/markets/trends/demand-profile
**Summary:** Retrieve demand profile by bedroom count
**Tier:** Enhanced | **Rate Limit:** 100,000/month
**Parameters:** level, area_id, limit, offset
**Description:** Demand profile showing sales distribution across dwelling types and bedroom counts.

### Supply-Demand Trends

#### GET /v1/markets/trends/stock-on-market
**Summary:** Retrieve stock on market trends (rate-limited)
**Tier:** Restricted | **Rate Limit:** 10,000/month
**Parameters:** level, area_id, property_type, limit, offset, period_end_min, period_end_max
**Description:** Historical stock on market (SoM) and SoM% trends.

#### GET /v1/markets/trends/inventory
**Summary:** Retrieve inventory (months of supply) trends (rate-limited)
**Tier:** Restricted | **Rate Limit:** 10,000/month
**Parameters:** level, area_id, property_type, limit, offset, period_end_min, period_end_max
**Description:** Historical inventory trends.

#### GET /v1/markets/trends/days-on-market
**Summary:** Retrieve days on market trends (rate-limited)
**Tier:** Restricted | **Rate Limit:** 10,000/month
**Parameters:** level, area_id, property_type, limit, offset, period_end_min, period_end_max
**Description:** Historical DOM and discounting trends.

#### GET /v1/markets/trends/clearance-rate
**Summary:** Retrieve clearance rate trends (rate-limited)
**Tier:** Restricted | **Rate Limit:** 10,000/month
**Parameters:** level, area_id, property_type, limit, offset, period_end_min, period_end_max
**Description:** Historical clearance rate and auction/scheduled counts trends.

#### GET /v1/markets/trends/vacancy
**Summary:** Retrieve vacancy rate trends (rate-limited)
**Tier:** Restricted | **Rate Limit:** 10,000/month
**Parameters:** level, area_id, property_type, limit, offset, period_end_min, period_end_max
**Description:** Historical vacancy rate and vacancy count trends.

#### GET /v1/markets/trends/hold-period
**Summary:** Retrieve historical hold period trends (rate-limited)
**Tier:** Restricted | **Rate Limit:** 10,000/month
**Parameters:** level, area_id, property_type, limit, offset, period_end_min, period_end_max
**Description:** Historical hold period trends for areas.

#### GET /v1/markets/trends/search-index
**Summary:** Retrieve historical search index trends (rate-limited)
**Tier:** Restricted | **Rate Limit:** 10,000/month
**Parameters:** level, area_id, property_type, limit, offset, period_end_min, period_end_max
**Description:** Historical buy and rent search index trends for areas.

### Demographics

#### GET /v1/demographics/census-medians
**Summary:** Get Census 2021 median values for a locality (CPI-adjusted)
**Tier:** Standard | **Rate Limit:** 100,000/month
**Parameters:** loc_pid, cpi_adjusted
**Description:** Returns Census 2021 median income, rent, mortgage, age, and household metrics for a locality.

#### GET /v1/demographics/business-activity
**Summary:** Get CABEE business activity data for a locality or LGA
**Tier:** Standard | **Rate Limit:** 100,000/month
**Parameters:** loc_pid, lga_pid, period
**Description:** Returns business counts, employment breakdown, top industry, employer anchor flag, and turnover analysis.

#### GET /v1/demographics/healthcare
**Summary:** Get healthcare cluster data for a locality
**Tier:** Standard | **Rate Limit:** 100,000/month
**Parameters:** loc_pid
**Description:** Returns healthcare cluster status and hospital details for a locality.

### Spatial H3 -- Price & Rent

#### GET /v1/spatial/h3/price-rent/median-price
**Summary:** Median sale price per H3 cell
**Tier:** Enhanced | **Rate Limit:** 100,000/month
**Parameters:** resolution, loc_pid, lga_pid, sa2_code, sa3_code, sa4_code, gcc_name, property_type, beds, baths, min_n, strict_granularity, limit, offset
**Description:** Returns the median sale price aggregated to H3 cells at the requested resolution.

#### GET /v1/spatial/h3/price-rent/median-rent
**Summary:** Median weekly rent per H3 cell
**Tier:** Enhanced | **Rate Limit:** 100,000/month
**Parameters:** resolution, loc_pid, lga_pid, sa2_code, sa3_code, sa4_code, gcc_name, property_type, beds, baths, min_n, strict_granularity, limit, offset
**Description:** Returns the median weekly rent aggregated to H3 cells at the requested resolution.

#### GET /v1/spatial/h3/price-rent/median-yield
**Summary:** Median gross yield per H3 cell
**Tier:** Enhanced | **Rate Limit:** 100,000/month
**Parameters:** resolution, loc_pid, lga_pid, sa2_code, sa3_code, sa4_code, gcc_name, property_type, beds, baths, min_n, strict_granularity, limit, offset
**Description:** Returns the median gross rental yield aggregated to H3 cells.

#### GET /v1/spatial/h3/price-rent/median-years-to-own
**Summary:** Median years to own per H3 cell
**Tier:** Enhanced | **Rate Limit:** 100,000/month
**Parameters:** resolution, loc_pid, lga_pid, sa2_code, sa3_code, sa4_code, gcc_name, property_type, beds, baths, min_n, strict_granularity, limit, offset
**Description:** Returns the median years-to-own (price / annual rent) aggregated to H3 cells.

### Spatial H3 -- Market

#### GET /v1/spatial/h3/market/median-dom
**Summary:** Median days on market per H3 cell
**Tier:** Enhanced | **Rate Limit:** 100,000/month
**Parameters:** resolution, loc_pid, lga_pid, sa2_code, sa3_code, sa4_code, gcc_name, property_type, beds, baths, min_n, strict_granularity, limit, offset
**Description:** Returns the median days on market aggregated to H3 cells.

#### GET /v1/spatial/h3/market/median-dorm
**Summary:** Median days on rental market (DORM) per H3 cell
**Tier:** Enhanced | **Rate Limit:** 100,000/month
**Parameters:** resolution, loc_pid, lga_pid, sa2_code, sa3_code, sa4_code, gcc_name, property_type, beds, baths, min_n, strict_granularity, limit, offset
**Description:** Returns the median days on rental market (DORM) percentage aggregated to H3 cells.

#### GET /v1/spatial/h3/market/median-lot-size
**Summary:** Median lot size per H3 cell
**Tier:** Enhanced | **Rate Limit:** 100,000/month
**Parameters:** resolution, loc_pid, lga_pid, sa2_code, sa3_code, sa4_code, gcc_name, property_type, beds, baths, min_n, strict_granularity, limit, offset
**Description:** Returns the median lot size (m2) aggregated to H3 cells.

#### GET /v1/spatial/h3/market/median-estimated-age
**Summary:** Median estimated building age per H3 cell
**Tier:** Enhanced | **Rate Limit:** 100,000/month
**Parameters:** resolution, loc_pid, lga_pid, sa2_code, sa3_code, sa4_code, gcc_name, property_type, beds, baths, min_n, strict_granularity, limit, offset
**Description:** Returns the median estimated building age (years) aggregated to H3 cells.

#### GET /v1/spatial/h3/market/median-holding-return
**Summary:** Median holding return rate per H3 cell
**Tier:** Enhanced | **Rate Limit:** 100,000/month
**Parameters:** resolution, loc_pid, lga_pid, sa2_code, sa3_code, sa4_code, gcc_name, property_type, beds, baths, min_n, strict_granularity, limit, offset
**Description:** Returns the median holding return rate aggregated to H3 cells.

#### GET /v1/spatial/h3/market/median-discounting
**Summary:** Median vendor discounting per H3 cell
**Tier:** Enhanced | **Rate Limit:** 100,000/month
**Parameters:** resolution, loc_pid, lga_pid, sa2_code, sa3_code, sa4_code, gcc_name, property_type, beds, baths, min_n, strict_granularity, limit, offset
**Description:** Returns the median vendor discounting rate aggregated to H3 cells.

#### GET /v1/spatial/h3/market/median-hold-period
**Summary:** Median hold period per H3 cell
**Tier:** Enhanced | **Rate Limit:** 100,000/month
**Parameters:** resolution, loc_pid, lga_pid, sa2_code, sa3_code, sa4_code, gcc_name, property_type, beds, baths, min_n, strict_granularity, limit, offset
**Description:** Returns the median hold period (years) aggregated to H3 cells.

#### GET /v1/spatial/h3/market/median-listed-price
**Summary:** Median listed price per H3 cell
**Tier:** Enhanced | **Rate Limit:** 100,000/month
**Parameters:** resolution, loc_pid, lga_pid, sa2_code, sa3_code, sa4_code, gcc_name, property_type, beds, baths, min_n, strict_granularity, limit, offset
**Description:** Returns the median current listing price aggregated to H3 cells.

### Spatial H3 -- Socio-Environmental

#### GET /v1/spatial/h3/socio-env/irsd
**Summary:** IRSD deprivation index per H3 cell
**Tier:** Enhanced | **Rate Limit:** 100,000/month
**Parameters:** resolution, loc_pid, lga_pid, sa2_code, sa3_code, sa4_code, gcc_name, min_n, strict_granularity, limit, offset
**Description:** Returns the Index of Relative Socio-economic Disadvantage (IRSD) aggregated to H3 cells.

#### GET /v1/spatial/h3/socio-env/irsad
**Summary:** IRSAD advantage/disadvantage index per H3 cell
**Tier:** Enhanced | **Rate Limit:** 100,000/month
**Parameters:** resolution, loc_pid, lga_pid, sa2_code, sa3_code, sa4_code, gcc_name, min_n, strict_granularity, limit, offset
**Description:** Returns the Index of Relative Socio-economic Advantage and Disadvantage (IRSAD) aggregated to H3 cells.

#### GET /v1/spatial/h3/socio-env/ier
**Summary:** IER economic resources index per H3 cell
**Tier:** Enhanced | **Rate Limit:** 100,000/month
**Parameters:** resolution, loc_pid, lga_pid, sa2_code, sa3_code, sa4_code, gcc_name, min_n, strict_granularity, limit, offset
**Description:** Returns the Index of Economic Resources (IER) aggregated to H3 cells.

#### GET /v1/spatial/h3/socio-env/ieo
**Summary:** IEO education/occupation index per H3 cell
**Tier:** Enhanced | **Rate Limit:** 100,000/month
**Parameters:** resolution, loc_pid, lga_pid, sa2_code, sa3_code, sa4_code, gcc_name, min_n, strict_granularity, limit, offset
**Description:** Returns the Index of Education and Occupation (IEO) aggregated to H3 cells.

#### GET /v1/spatial/h3/socio-env/public-housing
**Summary:** Public housing percentage per H3 cell
**Tier:** Enhanced | **Rate Limit:** 100,000/month
**Parameters:** resolution, loc_pid, lga_pid, sa2_code, sa3_code, sa4_code, gcc_name, min_n, strict_granularity, limit, offset
**Description:** Returns the share of dwellings classified as public housing aggregated to H3 cells (decimal fraction, 0-1).

#### GET /v1/spatial/h3/socio-env/pct-flood
**Summary:** Flood exposure percentage per H3 cell
**Tier:** Enhanced | **Rate Limit:** 100,000/month
**Parameters:** resolution, loc_pid, lga_pid, sa2_code, sa3_code, sa4_code, gcc_name, min_n, strict_granularity, limit, offset
**Description:** Returns the percentage of each H3 cell overlapping flood-prone land.

#### GET /v1/spatial/h3/socio-env/private-rental
**Summary:** Private rental percentage per H3 cell
**Tier:** Enhanced | **Rate Limit:** 100,000/month
**Parameters:** resolution, loc_pid, lga_pid, sa2_code, sa3_code, sa4_code, gcc_name, min_n, strict_granularity, limit, offset
**Description:** Returns the share of dwellings classified as private rentals aggregated to H3 cells (decimal fraction, 0-1).

#### GET /v1/spatial/h3/socio-env/pct-bushfire
**Summary:** Bushfire exposure percentage per H3 cell
**Tier:** Enhanced | **Rate Limit:** 100,000/month
**Parameters:** resolution, loc_pid, lga_pid, sa2_code, sa3_code, sa4_code, gcc_name, min_n, strict_granularity, limit, offset
**Description:** Returns the percentage of each H3 cell overlapping bushfire-prone land.

### Spatial H3 -- Reference

#### GET /v1/spatial/h3/reference/resolutions
**Summary:** List available H3 resolutions
**Tier:** Reference | **Rate Limit:** 100,000/month
**Description:** Returns the set of H3 resolutions (3-7) supported by the spatial API, with cell area and count metadata.

#### GET /v1/spatial/h3/cells/{h3_index}/boundary
**Summary:** Get GeoJSON boundary of an H3 cell
**Tier:** Reference | **Rate Limit:** 100,000/month
**Parameters:** h3_index
**Description:** Returns the GeoJSON polygon boundary for the given H3 cell index.

#### GET /v1/spatial/h3/cells/{h3_index}/center
**Summary:** Get center point of an H3 cell
**Tier:** Reference | **Rate Limit:** 100,000/month
**Parameters:** h3_index
**Description:** Returns the latitude and longitude of the center of the given H3 cell.

#### GET /v1/spatial/h3/cells/{h3_index}/parent
**Summary:** Get parent cell at a coarser resolution
**Tier:** Reference | **Rate Limit:** 100,000/month
**Parameters:** h3_index, parent_resolution
**Description:** Returns the parent H3 cell index at the specified (coarser) resolution.

#### GET /v1/spatial/h3/cells/{h3_index}/children
**Summary:** Get child cells at a finer resolution
**Tier:** Reference | **Rate Limit:** 100,000/month
**Parameters:** h3_index, child_resolution
**Description:** Returns all child H3 cell indices at the specified (finer) resolution.

#### GET /v1/spatial/h3/cells/{h3_index}/neighbors
**Summary:** Get neighboring cells (k-ring)
**Tier:** Reference | **Rate Limit:** 100,000/month
**Parameters:** h3_index, k
**Description:** Returns the k-ring of neighboring H3 cell indices at distance k (default 1).

### Reference

#### GET /v1/reference/locality
**Summary:** Look up Australian localities (suburbs)
**Tier:** Reference | **Rate Limit:** 10,000/month
**Parameters:** name, loc_pid, state_name, lga_pid, postcode, limit, offset
**Description:** Search and filter Australian localities by name, state, postcode, or LGA.

#### GET /v1/reference/lga
**Summary:** Look up Australian LGAs (Local Government Areas)
**Tier:** Reference | **Rate Limit:** 10,000/month
**Parameters:** name, state_name, lga_pid, limit, offset
**Description:** Search and filter Australian Local Government Areas by name or state.

#### GET /v1/reference/address-keys
**Summary:** Enumerate address keys for a single geography
**Tier:** Reference | **Rate Limit:** 1,000,000/month
**Parameters:** area_type, area_id, property_group, min_beds, max_beds, min_baths, max_baths, min_parking, max_parking, min_lot_size, max_lot_size, include_unknown, limit, offset
**Description:** Returns paginated address_key rows for exactly one geography identifier, with optional filters on dwelling attributes.

### Concordance

#### GET /v1/reference/concordance/sa2-to-locality
**Summary:** Translate SA2 to overlapping localities with area weights
**Tier:** Reference | **Rate Limit:** 100,000/month
**Parameters:** sa2_code
**Description:** Given an ABS SA2 code, returns all overlapping HTAG localities with area-based disaggregation weights.

#### GET /v1/reference/concordance/locality-to-sa2
**Summary:** Translate locality to overlapping SA2s with area weights
**Tier:** Reference | **Rate Limit:** 100,000/month
**Parameters:** loc_pid
**Description:** Given a HTAG loc_pid, returns all overlapping SA2 regions with the full ASGS hierarchy and area weights.

#### GET /v1/reference/concordance/lga-code-to-lga
**Summary:** Translate ABS LGA code to HTAG lga_pid
**Tier:** Reference | **Rate Limit:** 100,000/month
**Parameters:** lga_code
**Description:** Maps an ABS LGA code (5-digit) to the HTAG lga_pid identifier.

#### GET /v1/reference/concordance/postcode-to-locality
**Summary:** Get all localities for a postcode
**Tier:** Reference | **Rate Limit:** 100,000/month
**Parameters:** postcode
**Description:** Returns all HTAG localities (suburbs) that share the given Australian 4-digit postcode.

#### GET /v1/reference/concordance/locality-to-lga
**Summary:** Get the LGA(s) for a locality
**Tier:** Reference | **Rate Limit:** 100,000/month
**Parameters:** loc_pid
**Description:** Returns the Local Government Area(s) that contain the given locality.

#### GET /v1/reference/concordance/lga-to-localities
**Summary:** Get all localities within an LGA
**Tier:** Reference | **Rate Limit:** 100,000/month
**Parameters:** lga_pid
**Description:** Returns all HTAG localities (suburbs) within the given LGA.

#### GET /v1/reference/concordance/sal-to-locality
**Summary:** Translate ABS SAL code to HTAG locality
**Tier:** Reference | **Rate Limit:** 100,000/month
**Parameters:** sal_code
**Description:** Maps an ABS Suburb and Locality (SAL) code from Census 2021 to the corresponding HTAG loc_pid.

#### GET /v1/reference/concordance/lga-to-h3
**Summary:** LGA to H3 cells
**Tier:** Reference | **Rate Limit:** 100,000/month
**Parameters:** lga_pid, resolution
**Description:** Returns all H3 cells at the requested resolution that intersect the given LGA.

#### GET /v1/reference/concordance/locality-to-h3
**Summary:** Locality to H3 cells
**Tier:** Reference | **Rate Limit:** 100,000/month
**Parameters:** loc_pid, resolution
**Description:** Returns all H3 cells at the requested resolution that intersect the given locality.

#### GET /v1/reference/concordance/sa2-to-h3
**Summary:** SA2 to H3 cells
**Tier:** Reference | **Rate Limit:** 100,000/month
**Parameters:** sa2_code, resolution
**Description:** Returns all H3 cells at the requested resolution that intersect the given SA2 region.

#### GET /v1/reference/concordance/sa3-to-h3
**Summary:** SA3 to H3 cells
**Tier:** Reference | **Rate Limit:** 100,000/month
**Parameters:** sa3_code, resolution
**Description:** Returns all H3 cells at the requested resolution that intersect the given SA3 region.

#### GET /v1/reference/concordance/sa4-to-h3
**Summary:** SA4 to H3 cells
**Tier:** Reference | **Rate Limit:** 100,000/month
**Parameters:** sa4_code, resolution
**Description:** Returns all H3 cells at the requested resolution that intersect the given SA4 region.

#### GET /v1/reference/concordance/gcc-to-h3
**Summary:** GCCSA to H3 cells
**Tier:** Reference | **Rate Limit:** 100,000/month
**Parameters:** gcc_name, resolution
**Description:** Returns all H3 cells at the requested resolution that intersect the given Greater Capital City Statistical Area.

#### GET /v1/reference/concordance/h3-to-geo
**Summary:** H3 cell to geographic identifiers
**Tier:** Reference | **Rate Limit:** 100,000/month
**Parameters:** h3_index
**Description:** Returns the geographic identifiers (locality, LGA, SA2, SA3, SA4, GCCSA) that contain the center of the given H3 cell.

### CPI

#### GET /v1/economics/cpi/factor
**Summary:** Get CPI adjustment factor between two periods
**Tier:** Standard | **Rate Limit:** 100,000/month
**Parameters:** from_period, to_period, region
**Description:** Returns the CPI multiplier to convert dollar values from one quarter to another.

#### GET /v1/economics/cpi/adjust
**Summary:** Adjust a dollar value for CPI inflation
**Tier:** Standard | **Rate Limit:** 100,000/month
**Parameters:** value, from_period, to_period, region
**Description:** Takes a dollar amount and adjusts it from one quarter to another using CPI.

#### GET /v1/economics/cpi/series
**Summary:** Get CPI index time series
**Tier:** Standard | **Rate Limit:** 100,000/month
**Parameters:** region, from_period, to_period
**Description:** Returns quarterly CPI index values for a region.

#### GET /v1/economics/cpi/latest
**Summary:** Get latest CPI index values for all regions
**Tier:** Standard | **Rate Limit:** 100,000/month
**Description:** Returns the most recent CPI index value and quarter for every region.

### Cash Rate

#### GET /v1/economics/cash-rate
**Summary:** Get current RBA cash rate
**Tier:** Standard | **Rate Limit:** 100,000/month
**Description:** Returns the latest RBA official cash rate target.

#### GET /v1/economics/cash-rate/series
**Summary:** Get RBA cash rate time series
**Tier:** Standard | **Rate Limit:** 100,000/month
**Parameters:** from_date, to_date, changes_only
**Description:** Returns monthly RBA cash rate history with optional filtering for rate-change events only.

---

## MCP Tool Reference

### Intelligence Server (57 tools)

- `standardise_addresses` -- Parse and standardise free-text addresses to GNAF format
- `get_address_geocode` -- Resolve address identity and coordinates
- `get_address_environment` -- Flood, bushfire, heritage, zoning overlays
- `get_address_demographics` -- SEIFA indices and Census-derived housing tenure metrics
- `get_address_schools` -- Government catchment and nearby Catholic/Independent schools
- `enumerate_address_keys` -- List address keys for a geography with dwelling filters
- `get_property_summary` -- Physical property attributes (type, beds, baths, land area)
- `get_property_estimates` -- Index-adjusted CMA sale price and rent estimates
- `get_property_market` -- Property-level market position (rental proportion, years to own)
- `search_sold_properties` -- Radius-based sold property search with filters
- `post_property_structural_adjustment` -- CMA structural adjustments between subject and comparables
- `get_market_summary` -- Typical price, rent, yield, volumes, dwellings, population
- `get_market_growth_cumulative` -- Multi-horizon cumulative growth rates
- `get_market_growth_annualised` -- Annualised compounded growth rates
- `get_market_supply` -- Supply snapshot: lot size, inventory, approvals, hold period
- `get_market_supply_ls` -- Long-term supply slope indicators
- `get_market_supply_ss` -- Short-term supply slope indicators
- `get_market_demand` -- Demand snapshot: DOM, discounting, vacancy, clearance, search
- `get_market_demand_ls` -- Long-term demand slope indicators
- `get_market_demand_ss` -- Short-term demand slope indicators
- `get_market_scores` -- RCS rankings, HAPI score, volatility index
- `get_market_fundamentals` -- IRSAD, ownership ratios, affordability
- `get_market_cycle` -- GRC index, growth projections, cycle position
- `get_market_risk` -- Environmental risk indices and economic diversity
- `query_markets` -- Filter markets using public DSL (and/or/not logic)
- `rank_markets` -- Weighted decile scoring of a shortlist of markets
- `match_brief` -- Match an investment brief to qualifying markets
- `get_market_trends_price` -- Historical monthly price trends
- `get_market_trends_rent` -- Historical monthly rent trends
- `get_market_trends_yield` -- Historical yield trends
- `get_market_trends_growth_rates` -- Historical annual growth rate changes
- `get_market_trends_demand_profile` -- Demand profile by dwelling type and bedroom count
- `get_market_trends_stock_on_market` -- Historical stock on market trends
- `get_market_trends_inventory` -- Historical inventory (months of supply) trends
- `get_market_trends_days_on_market` -- Historical DOM and discounting trends
- `get_market_trends_clearance_rate` -- Historical clearance rate trends
- `get_market_trends_vacancy` -- Historical vacancy rate and count trends
- `get_market_trends_hold_period` -- Historical hold period trends
- `get_market_trends_search_index` -- Historical buy and rent search index trends
- `get_census_medians` -- Census 2021 median income, rent, mortgage, age, household
- `get_business_activity` -- CABEE business counts, employment, top industry
- `get_healthcare_clusters` -- Healthcare cluster status and hospital details
- `get_cpi_factor` -- CPI adjustment factor between two quarters
- `get_cpi_adjusted_value` -- Adjust a dollar value for CPI inflation
- `get_cpi_series` -- Quarterly CPI index time series
- `get_cpi_latest` -- Latest CPI index values for all regions
- `get_cash_rate` -- Current RBA cash rate target
- `get_cash_rate_series` -- Monthly RBA cash rate history
- `lookup_localities` -- Search Australian localities by name, state, postcode, LGA
- `lookup_lgas` -- Search Australian LGAs by name or state
- `concordance_sa2_to_locality` -- SA2 to overlapping localities with area weights
- `concordance_locality_to_sa2` -- Locality to overlapping SA2s with area weights
- `concordance_lga_code_to_lga` -- ABS LGA code to HTAG lga_pid
- `concordance_postcode_to_locality` -- All localities for a postcode
- `concordance_locality_to_lga` -- LGA(s) containing a locality
- `concordance_lga_to_localities` -- All localities within an LGA
- `concordance_sal_to_locality` -- ABS SAL code to HTAG locality

### Spatial Server (6 tools)

- `get_h3_price_rent` -- H3 median price, rent, yield, years-to-own
- `get_h3_market` -- H3 DOM, DORM, lot size, age, holding return, discounting
- `get_h3_socio_env` -- H3 IRSD, IRSAD, IER, IEO, public housing, flood, bushfire
- `get_h3_reference` -- H3 resolutions, boundary, center, parent, children, neighbors
- `get_h3_concordance` -- H3 cell to geographic identifiers
- `get_h3_cells` -- H3 cells for a given geography

### Trends Server (7 tools)

- `get_price_trends` -- Historical price time series
- `get_rent_trends` -- Historical rent time series
- `get_yield_trends` -- Historical yield time series
- `get_growth_rate_trends` -- Historical growth rate changes
- `get_demand_profile_trends` -- Demand profile by bedroom count
- `get_supply_demand_trends` -- Stock, inventory, DOM, clearance, vacancy trends
- `get_search_index_trends` -- Buy and rent search index trends

### Data Analytics Server (7 tools)

- `query_market_data` -- Read-only SQL queries against market warehouse
- `list_tables` -- List available data tables
- `describe_table` -- Get table schema and column descriptions
- `get_sample_data` -- Sample rows from a table
- `query_demographics` -- Read-only SQL queries against demographics data
- `query_spatial` -- Read-only SQL queries against spatial data
- `get_query_history` -- View recent query history

### Docs Server (5 tools)

- `list_api_endpoints` -- List all available API endpoints
- `get_api_endpoint` -- Get details for a specific endpoint
- `list_mcp_servers` -- List all MCP servers and their tools
- `list_mcp_tools` -- List tools for a specific MCP server
- `list_micro_agents` -- List all AI micro-agents

---

## AI Agent Reference

### Market Cycle Timing

- **Status:** Live
- **Endpoint:** POST https://agent.htagai.com/micro-agents/agents/market-cycle/execute
- **Input:** `{"suburb": "string", "state": "string", "property_type": "house|unit"}`
- **Output:** Phase (Recovery/Expansion/Slowdown/Contraction), GRC index, confidence score, projected annual return, BUY/HOLD/SELL signal
- **Execution modes:** Sync (5-30s), Streaming (SSE), Async (job queue)

### Suburb Analysis

- **Status:** Live
- **Endpoint:** POST https://agent.htagai.com/micro-agents/agents/suburb-analysis/execute
- **Input:** `{"suburb": "string", "state": "string", "property_type": "house|unit"}`
- **Output:** 8-section comprehensive report: market summary, growth analysis, supply-demand dynamics, demographics, risk profile, infrastructure, investment outlook, comparable suburbs
- **Execution modes:** Sync (10-60s), Streaming (SSE), Async (job queue)

### Suburb Comparison

- **Status:** Live
- **Endpoint:** POST https://agent.htagai.com/micro-agents/agents/suburb-comparison/execute
- **Input:** `{"suburbs": [{"suburb": "string", "state": "string"}], "property_type": "house|unit"}`
- **Output:** Side-by-side comparison of 2-5 suburbs across price, growth, yield, risk, demographics, and overall ranking
- **Execution modes:** Sync (15-90s), Streaming (SSE), Async (job queue)

### Portfolio Health

- **Status:** Coming Soon
- **Endpoint:** POST https://agent.htagai.com/micro-agents/agents/portfolio-health/execute
- **Input:** Portfolio of properties with purchase prices, loan details, rental income
- **Output:** Loan stress testing, equity position, cashflow analysis, rebalancing recommendations

### Portfolio Stress Test

- **Status:** Coming Soon
- **Endpoint:** POST https://agent.htagai.com/micro-agents/agents/portfolio-stress-test/execute
- **Input:** Portfolio of properties with scenario parameters
- **Output:** AI disruption risk, fuel crisis impact, interest rate shock analysis

### Defence & Counter-Cyclical

- **Status:** Coming Soon
- **Endpoint:** POST https://agent.htagai.com/micro-agents/agents/defence-counter-cyclical/execute
- **Input:** Target location and property type
- **Output:** Crisis resilience scoring, counter-cyclical opportunity identification