Property - Context

Street profile — this property's street vs its suburb

The property's own street: current median price, 2/4/8-year price forecasts, realised growth, sale/rental turnover, renter share and houses/units on the street — plus the suburb-wide medians to judge it against and the street's rank on 4-year forecast growth.

404s when the street has no forecast row rather than falling back to suburb-wide figures, which would answer a different question.

Price: 20¢ per call.

get/v1/properties/{gnaf_id}/street/profile

Request

  • Base URL: https://api.microburbs.com.au
  • URL: https://api.microburbs.com.au/v1/properties/{gnaf_id}/street/profile
  • Auth: HTTP bearer

Path parameters

gnaf_idstring required
Example:GANSW704074813

Response

Successful Response

availableboolean nullable

false on no-data responses. Omitted on success — branch on data !== null if you want a single discriminator.

reasonstring nullable

Machine-readable slug naming the no-data condition (e.g. no_avm_for_GANSW704074813). Stable per endpoint. Omitted on success.

messagestring nullable

Human-readable explanation. Omitted on success.

Example response

{
  "data": {
    "address": "15 Rengor Close",
    "forecast_rank": {
      "band": "Top 1%",
      "percentile_from_top": 1,
      "rank": 1,
      "tercile": "upper third",
      "total": 81
    },
    "gnaf_id": "GANSW717662275",
    "profile": {
      "annual_2y": 14.2,
      "annual_4y": 11.1,
      "annual_8y": 8.7,
      "confidence": "Medium",
      "current_price": 1300000,
      "history": [
        {
          "price": 1002844.58,
          "suburb_med": 866399,
          "year": 2024
        },
        {
          "price": 1300000,
          "suburb_med": 948908,
          "year": 2025
        },
        {
          "price": 1300000,
          "suburb_med": 1040068,
          "year": 2026
        }
      ],
      "houses_on_street": 12,
      "median_house_rent_week": 986.5,
      "n_sales": 47,
      "past_growth_pct": 2.82,
      "renters_pct": "0%",
      "renters_pct_num": 0,
      "sale_turnover": "Every 9.2 years (very high turnover)",
      "sale_turnover_years": 9.2,
      "street": "Rengor Cl",
      "target_2y": 1694197.26,
      "target_4y": 1979978.08,
      "target_8y": 2532146.5,
      "title": "Rengor Close",
      "units_on_street": 0
    },
    "street": "Rengor Close",
    "streets_in_suburb": 81,
    "suburb": "Belmont North",
    "suburb_medians": {
      "annual_4y": 6.3,
      "annual_8y": 4.6,
      "past_growth_pct": 3.23,
      "rental_turnover_years": 6,
      "renters_pct": 16,
      "sale_turnover_years": 14.4
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.