Start here. Build with confidence.
Follow our MCP and API setup guides, understand the core concepts and market metrics, then explore practical examples. All the onboarding articles in one place.
Read the getting started guide Manage API and MCP costsHTAG RESEARCH BENCH / API EXPLORER
Don’t just read the data.
See what it can do.
A property record. A market signal. A neighbourhood in focus. Explore what comes back, understand what it means, and find the ingredients for your next build.
Select an endpoint from the index below.
YOUR BUILDING BLOCKS
Keep the useful ones.
Collect up to seven endpoints, then copy your set for your team.
Complete endpoint index · 105 operations
Discretionary lifestyle amenities for an address
Dining, drinking, fitness, golf, and cultural amenities — cafés, restaurants, pubs, fitness specialty venues, golf courses, museum / galleries.
GET /address/amenitiesAviation flight-path and runway adjacency for an address
Flight-path overhead and runway adjacency signals.
GET /address/aviationCBD, airport, and major-road proximity for an address
Long-distance travel context: distance to nearest CBD/GPO, airport, and major-road network.
GET /address/cbd-proximityCoastal / water-adjacent feature proximity for an address
Beach, coastline, water-body, surf club, and marina proximity.
GET /address/coastalSocio-economic and demographic indicators for an address
Returns ABS SEIFA indices and Census-derived housing tenure metrics for the requested address(es).
GET /address/demographicsEnvironmental risk overlays for an address
Returns flood, bushfire, heritage, and zoning indicators for the requested address(es).
GET /address/environmentDay-to-day essentials and community services proximity for an address
Day-to-day necessities: groceries (supermarket, shopping centre, food retail), healthcare (hospital, medical clinic, pharmacy), childcare, university, plus community services (community centre, library).
GET /address/essentialsAddress identity and coordinates
Returns the canonical address key, GNAF identifiers, coordinates, ABS geography codes, mesh block classification, and standardised address elements for the requested address.
GET /address/geocodePark, dog-park, and recreation proximity for an address
Park, dog-park, and recreation-area proximity and density.
GET /address/green-spaceHazard-adjacent landmark proximity for an address
Proximity to natural-hazard and culturally-undesirable landmarks: nearest bushfire-prone vegetation, landfill, cemetery.
GET /address/hazardsIndustrial sites and electrical infrastructure adjacency for an address
Negative-signal due-diligence bundle: proximity to industrial sites and electrical infrastructure (power lines, substations).
GET /address/nuisanceLocal road-infrastructure features for an address
Local road-geometry features.
GET /address/road-infrastructureEmergency-services proximity for an address
Distance to nearest fire station and police station, plus a 500 m police-presence boolean.
GET /address/safetySchools relevant to an address
Returns schools relevant to an Australian address.
GET /address/schoolsBatch standardise Australian addresses and generate address keys
Accepts up to 50 single-line (free text) Australian addresses, standardises each into its component elements, and generates a canonical address key.
POST /address/standardisePublic-transit, active-transport, and EV refuelling proximity for an address
Distance metrics for rail, bus, tram, and ferry infrastructure plus the nearest EV charging station.
GET /address/transportWalkability score and urban-tier classification for an address
Composite walkability score (0–10) and urban-tier classification for the requested address(es).
GET /address/walkabilityCABEE business activity data for a locality or LGA
Returns business counts, employment breakdown, top industry, employer anchor flag, and turnover analysis.
GET /demographics/business-activityCensus 2021 median values for a locality (CPI-adjusted)
Returns Census 2021 median income, rent, mortgage, age, and household metrics for a locality.
GET /demographics/census-mediansHealthcare cluster data for a locality
Returns healthcare cluster status and hospital details for a locality.
GET /demographics/healthcareCurrent RBA cash rate
Returns the latest RBA official cash rate target.
GET /economics/cash-rateRBA cash rate time series
Returns monthly RBA cash rate history with optional filtering for rate-change events only.
GET /economics/cash-rate/seriesA dollar value for CPI inflation
Takes a dollar amount and adjusts it from one quarter to another using CPI.
GET /economics/cpi/adjustCPI adjustment factor between two periods
Returns the CPI multiplier to convert dollar values from one quarter to another.
GET /economics/cpi/factorLatest CPI index values for all regions
Returns the most recent CPI index value and quarter for every region.
GET /economics/cpi/latestCPI index time series
Returns quarterly CPI index values for a region.
GET /economics/cpi/seriesGCCSA → H3 cells
Returns all H3 cells at the requested resolution that intersect the given Greater Capital City Statistical Area.
GET /reference/concordance/gcc-to-h3H3 cell → geographic identifiers
Returns the geographic identifiers (locality, LGA, SA2, SA3, SA4, GCCSA) that contain the center of the given H3 cell.
GET /reference/concordance/h3-to-geoTranslate ABS LGA code to HTAG lga_pid
Maps an ABS LGA code (5-digit) to the HTAG lga_pid identifier.
GET /reference/concordance/lga-code-to-lgaLGA → H3 cells
Returns all H3 cells at the requested resolution that intersect the given LGA.
GET /reference/concordance/lga-to-h3All localities within an LGA
Returns all HTAG localities (suburbs) within the given LGA.
GET /reference/concordance/lga-to-localitiesLocality → H3 cells
Returns all H3 cells at the requested resolution that intersect the given locality.
GET /reference/concordance/locality-to-h3The LGA(s) for a locality
Returns the Local Government Area(s) that contain the given locality.
GET /reference/concordance/locality-to-lgaTranslate locality to overlapping SA2s with area weights
Given a HTAG loc_pid, returns all overlapping SA2 regions with the full ASGS hierarchy and area weights.
GET /reference/concordance/locality-to-sa2All localities for a postcode
Returns all HTAG localities (suburbs) that share the given Australian 4-digit postcode.
GET /reference/concordance/postcode-to-localitySA2 → H3 cells
Returns all H3 cells at the requested resolution that intersect the given SA2 region.
GET /reference/concordance/sa2-to-h3Translate SA2 to overlapping localities with area weights
Given an ABS SA2 code, returns all overlapping HTAG localities with area-based disaggregation weights.
GET /reference/concordance/sa2-to-localitySA3 → H3 cells
Returns all H3 cells at the requested resolution that intersect the given SA3 region.
GET /reference/concordance/sa3-to-h3SA4 → H3 cells
Returns all H3 cells at the requested resolution that intersect the given SA4 region.
GET /reference/concordance/sa4-to-h3Translate ABS SAL code to HTAG locality
Maps an ABS Suburb and Locality (SAL) code from Census 2021 to the corresponding HTAG loc_pid.
GET /reference/concordance/sal-to-localityAI-generated market commentary
Retrieve AI-generated market commentary.
GET /markets/commentaryGrowth rate cycle and forward projections
Growth rate cycle position, GRC index, growth projection decomposition (GPD), growth stability profile (GSP), minima, and forward-looking projected annual returns.
GET /markets/cycleDemand-side metrics snapshot
Current demand-side snapshot: days on market, discounting, vacancy, clearance rate, and search interest.
GET /markets/demandLong-term demand slope metrics
Long-term slope (LS) of demand-side indicators, calculated via trend analysis regression on metric time series.
GET /markets/demand/lsShort-term demand slope metrics
Short-term slope (SS) of demand-side indicators, calculated via trend analysis regression on metric time series.
GET /markets/demand/ssFundamental ratios and affordability metrics
Socio-economic fundamentals: IRSAD index, ownership/housing ratios, and affordability (years to own).
GET /markets/fundamentalsAnnualised compounded growth rates
Annualised compounded growth rates, computed from the matching cumulative figures (e.g.
GET /markets/growth/annualisedCumulative growth rates
Multi-horizon cumulative growth rates for prices, rents, and yields.
GET /markets/growth/cumulativeMarket snapshots with the public filter DSL
Query suburb or LGA market snapshot views using the public market filter DSL.
POST /markets/queryRank a shortlist of markets by weighted metric deciles
Computes a decile-based weighted score for each supplied `area_id` and returns a dense sequential ranking.
POST /markets/rankEnvironmental and economic risk indices
Environmental risk indices (flood, bushfire) and economic diversity measures for an area.
GET /markets/riskMarket scores and indices
Returns Relative Composite Score (RCS™) rankings, HAPI score, volatility index, and confidence level.
GET /markets/scoresCore market headline metrics
Returns current market essentials: typical price, rent, yield, sales/rental volumes, estimated dwellings, adult population, and confidence level.
GET /markets/summarySupply-side metrics snapshot
Current supply-side snapshot: lot size, inventory, building approvals, and hold period.
GET /markets/supplyLong-term supply slope metrics
Long-term slope (LS) of supply-side indicators, calculated via trend-analysis regression on metric time series.
GET /markets/supply/lsShort-term supply slope metrics
Short-term slope (SS) of supply-side indicators, calculated via trend-analysis regression on metric time series.
GET /markets/supply/ssClearance rate trends
Historical clearance rate and auction/scheduled counts trends.
GET /markets/trends/clearance-rateDays on market trends
Historical DOM and discounting trends.
GET /markets/trends/days-on-marketDemand profile by bedroom count
Demand profile showing sales distribution across dwelling types and bedroom counts.
GET /markets/trends/demand-profileHistorical growth rate changes
Historical annual growth rate changes for prices, rents, and yields.
GET /markets/trends/growth-ratesHistorical hold period trends
Historical hold period trends for areas.
GET /markets/trends/hold-periodInventory (months of supply) trends
Historical inventory trends.
GET /markets/trends/inventoryHistorical price trends
Historical monthly price trends for areas by property type.
GET /markets/trends/priceHistorical rent trends
Historical monthly rent trends for areas by property type.
GET /markets/trends/rentHistorical search index trends
Historical buy and rent search index trends for areas.
GET /markets/trends/search-indexStock on market trends
Historical stock on market (SoM) and SoM% trends.
GET /markets/trends/stock-on-marketVacancy rate trends
Historical vacancy rate and vacancy count trends.
GET /markets/trends/vacancyHistorical years-to-own trends
Historical years-to-own trends (years required to pay off the median price using median rent) for areas by property type and bedroom count.
GET /markets/trends/years-to-ownHistorical yield trends
Historical yield trends for areas by property type.
GET /markets/trends/yieldCMA structural adjustments between a subject and comparables
Returns **structural price or rent adjustments** between a subject property and up to 50 comparables.
POST /property/cma-structural-adjustmentValuation estimates and transaction history for an address
Returns index-adjusted CMA (comparative market analysis) estimates for sale price and rent.
GET /property/estimatesThe full sale and rental history for an address
Returns every recorded sale and/or rental transaction for the specified address key, ordered most-recent first within each array.
GET /property/historyMarket position indicators for an address
Returns property-level market position metrics for the specified address key, including rental proportion, years to own, and typical hold period.
GET /property/marketRented properties within a radius of an address or coordinates
Radius-based search of rental listings using an address key, free-text address, or lat/lon point.
GET /property/rented/searchSold properties within a radius of an address or coordinates
Radius-based search of sold properties using an address key, free-text address, or lat/lon point.
GET /property/sold/searchPhysical property attributes for an address
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 /property/summaryEnumerate address keys for a single geography
Returns paginated `address_key` rows for exactly one geography identifier, with optional filters on dwelling attributes.
GET /reference/address-keysAustralian LGAs (Local Government Areas)
Search and filter Australian Local Government Areas by name or state.
GET /reference/lgaAustralian localities (suburbs)
Search and filter Australian localities by name, state, postcode, or LGA.
GET /reference/localityGeoJSON boundary of an H3 cell
Returns the GeoJSON polygon boundary for the given H3 cell index.
GET /spatial/h3/cells/{h3_index}/boundaryCenter point of an H3 cell
Returns the latitude and longitude of the center of the given H3 cell.
GET /spatial/h3/cells/{h3_index}/centerChild cells at a finer resolution
Returns all child H3 cell indices at the specified (finer) resolution.
GET /spatial/h3/cells/{h3_index}/childrenNeighboring cells (k-ring)
Returns the k-ring of neighboring H3 cell indices at distance k (default 1).
GET /spatial/h3/cells/{h3_index}/neighborsParent cell at a coarser resolution
Returns the parent H3 cell index at the specified (coarser) resolution.
GET /spatial/h3/cells/{h3_index}/parentMedian vendor discounting per H3 cell
Returns the median vendor discounting rate aggregated to H3 cells.
GET /spatial/h3/market/median-discountingMedian days on market per H3 cell
Returns the median days on market aggregated to H3 cells.
GET /spatial/h3/market/median-domMedian days on rental market (DORM) per H3 cell
Returns the median days on rental market (DORM) percentage aggregated to H3 cells.
GET /spatial/h3/market/median-dormMedian estimated building age per H3 cell
Returns the median estimated building age (years) aggregated to H3 cells.
GET /spatial/h3/market/median-estimated-ageMedian hold period per H3 cell
Returns the median hold period (years) aggregated to H3 cells.
GET /spatial/h3/market/median-hold-periodMedian holding return rate per H3 cell
Returns the median holding return rate aggregated to H3 cells.
GET /spatial/h3/market/median-holding-returnMedian listed price per H3 cell
Returns the median current listing price aggregated to H3 cells.
GET /spatial/h3/market/median-listed-priceMedian lot size per H3 cell
Returns the median lot size (m²) aggregated to H3 cells.
GET /spatial/h3/market/median-lot-sizeMedian sale price per H3 cell
Returns the median sale price aggregated to H3 cells at the requested resolution.
GET /spatial/h3/price-rent/median-priceMedian weekly rent per H3 cell
Returns the median weekly rent aggregated to H3 cells at the requested resolution.
GET /spatial/h3/price-rent/median-rentMedian years to own per H3 cell
Returns the median years-to-own (price / annual rent) aggregated to H3 cells.
GET /spatial/h3/price-rent/median-years-to-ownMedian gross yield per H3 cell
Returns the median gross rental yield aggregated to H3 cells.
GET /spatial/h3/price-rent/median-yieldAvailable H3 resolutions
Returns the set of H3 resolutions (5–9) supported by the spatial API, with cell area and count metadata.
GET /spatial/h3/reference/resolutionsIEO education/occupation index per H3 cell
Returns the Index of Education and Occupation (IEO) aggregated to H3 cells.
GET /spatial/h3/socio-env/ieoIER economic resources index per H3 cell
Returns the Index of Economic Resources (IER) aggregated to H3 cells.
GET /spatial/h3/socio-env/ierIRSAD advantage/disadvantage index per H3 cell
Returns the Index of Relative Socio-economic Advantage and Disadvantage (IRSAD) aggregated to H3 cells.
GET /spatial/h3/socio-env/irsadIRSD deprivation index per H3 cell
Returns the Index of Relative Socio-economic Disadvantage (IRSD) aggregated to H3 cells.
GET /spatial/h3/socio-env/irsdBushfire exposure percentage per H3 cell
Returns the percentage of each H3 cell overlapping bushfire-prone land.
GET /spatial/h3/socio-env/pct-bushfireFlood exposure percentage per H3 cell
Returns the percentage of each H3 cell overlapping flood-prone land.
GET /spatial/h3/socio-env/pct-floodPrivate rental percentage per H3 cell
Returns the share of dwellings classified as private rentals aggregated to H3 cells (decimal fraction, 0–1).
GET /spatial/h3/socio-env/private-rentalPublic housing percentage per H3 cell
Returns the share of dwellings classified as public housing aggregated to H3 cells (decimal fraction, 0–1).
GET /spatial/h3/socio-env/public-housing