---
title: "GET /suburbs/{suburbId}/flyover"
method: GET
path: "/suburbs/{suburbId}/flyover"
tags: ["suburbs"]
---

# GET /suburbs/{suburbId}/flyover

`GET /suburbs/{suburbId}/flyover`

Generate a 'flyover' of the suburb. A flyover is a summary of the recent sales and rental activity.

## Path parameters

- `suburbId` string, required

## Response `200`

successful operation

- SuburbFlyover
  - `suburb` Suburb
    - `id` string
    - `suburbName` string
    - `postcode` integer
    - `state` string
    - `disclaimer` string
    - `messages` Message[]
      - `code` integer
      - `text` string
    - `_self` string
  - `statistics` StatisticsWrapper
    - `propertyType` StatisticsPropertyTypeWrapper
      - `house` SuburbStatistics
        - `statisticsSummary` SuburbStatisticsSummary
          - `calculated` string, date-time
          - `medianSalePrice` number, double
          - `medianRentalPrice` number, double
          - `suburbGrowth` number, double
          - `saleCount` integer
          - `rentalCount` integer
          - `suburbRentalYield` number, double
        - `sales` SuburbSalesWrapper
          - `timeseries` SuburbSalesTimeseriesWrapper
            - `rolling12Month` SalesTimeSeries
              - …
            - `calendar12Month` SalesTimeSeries
              - …
          - `priceRangeSegments` PriceRangeSegments
            - `calculated` string, date-time
            - `segments` PriceRangeSegment[]
              - …
            - `period` TimeSeriesPeriod
              - …
            - `disclaimer` string
            - `messages` Message[]
              - …
          - `peakSellingPeriods` PeakSellingPeriods
            - `calculated` string, date-time
            - `disclaimer` string
            - `messages` Message[]
              - …
            - `period` TimeSeriesPeriod
              - …
            - `values` StatisticDouble[]
              - …
        - `rentals` SuburbRentalsByBedroomStatisticsWrapper
          - `beds` SuburbRentalsByBedroomStatistics
            - `one` SuburbRentalsTimeseriesWrapper
              - …
            - `two` SuburbRentalsTimeseriesWrapper
              - …
            - `three` SuburbRentalsTimeseriesWrapper
              - …
            - `threePlus` SuburbRentalsTimeseriesWrapper
              - …
            - `fourPlus` SuburbRentalsTimeseriesWrapper
              - …
      - `unit` SuburbStatistics
        - `statisticsSummary` SuburbStatisticsSummary
          - `calculated` string, date-time
          - `medianSalePrice` number, double
          - `medianRentalPrice` number, double
          - `suburbGrowth` number, double
          - `saleCount` integer
          - `rentalCount` integer
          - `suburbRentalYield` number, double
        - `sales` SuburbSalesWrapper
          - `timeseries` SuburbSalesTimeseriesWrapper
            - `rolling12Month` SalesTimeSeries
              - …
            - `calendar12Month` SalesTimeSeries
              - …
          - `priceRangeSegments` PriceRangeSegments
            - `calculated` string, date-time
            - `segments` PriceRangeSegment[]
              - …
            - `period` TimeSeriesPeriod
              - …
            - `disclaimer` string
            - `messages` Message[]
              - …
          - `peakSellingPeriods` PeakSellingPeriods
            - `calculated` string, date-time
            - `disclaimer` string
            - `messages` Message[]
              - …
            - `period` TimeSeriesPeriod
              - …
            - `values` StatisticDouble[]
              - …
        - `rentals` SuburbRentalsByBedroomStatisticsWrapper
          - `beds` SuburbRentalsByBedroomStatistics
            - `one` SuburbRentalsTimeseriesWrapper
              - …
            - `two` SuburbRentalsTimeseriesWrapper
              - …
            - `three` SuburbRentalsTimeseriesWrapper
              - …
            - `threePlus` SuburbRentalsTimeseriesWrapper
              - …
            - `fourPlus` SuburbRentalsTimeseriesWrapper
              - …
  - `demographics` Demographics
    - `censusTopics` CensusTopic[]
      - `topic` string
      - `title` string
      - `total` integer
      - `year` integer
      - `data` CensusValue[]
        - `category` string
        - `count` integer
    - `disclaimer` string
    - `messages` Message[]
      - `code` integer
      - `text` string
  - `recentSales` Sales
    - `disclaimer` string
    - `messages` Message[]
      - `code` integer
      - `text` string
    - `sales` Sale[]
      - `id` integer
      - `disclaimer` string
      - `messages` Message[]
        - `code` integer
        - `text` string
      - `price` SensitivePrice
        - `display` string
        - `value` number, double
        - `rawValue` number, double
        - `withheld` boolean
      - `listingHistory` SaleListingHistory
        - `originalListingId` ListingIdentifier
          - `id` integer
          - `rental` boolean
          - `_self` string
        - `originalPrice` SensitivePrice
          - `display` string
          - `value` number, double
          - `rawValue` number, double
          - `withheld` boolean
        - `originalPricePercentChange` SensitiveChange
          - `display` string
          - `value` number, double
          - `rawValue` number, double
        - `lastListingId` ListingIdentifier
          - `id` integer
          - `rental` boolean
          - `_self` string
        - `lastPrice` SensitivePrice
          - `display` string
          - `value` number, double
          - `rawValue` number, double
          - `withheld` boolean
        - `lastPricePercentChange` SensitiveChange
          - `display` string
          - `value` number, double
          - `rawValue` number, double
        - `daysToSell` integer
      - `saleDate` SensitiveDate
        - `display` string
        - `value` string, date-time
        - `rawValue` string, date-time
      - `settlementDate` SensitiveDate
        - `display` string
        - `value` string, date-time
        - `rawValue` string, date-time
      - `contractDate` SensitiveDate
        - `display` string
        - `value` string, date-time
        - `rawValue` string, date-time
      - `image` ImageIdentifier
        - `id` integer
        - `_self` string
      - `property` PropertyIdentifier
        - `id` integer
        - `matchlevel` 'suburb' | 'street' | 'property'
        - `location` Point
          - `lat` number, double
          - `lon` number, double
        - `parent` boolean
        - `_self` string
      - `street` StreetIdentifier
        - `id` string
      - `suburb` SuburbIdentifier
        - `id` string
        - `_self` string
      - `propertyType` string
      - `saleType` string
      - `agency` Agency
        - `id` integer
        - `name` string
        - `phoneNumber` string
      - `agent` Agent
        - `name` string
        - `phoneNumber` string
        - `agency` AgencyIdentifier
          - `id` integer
      - `location` Point
        - `lat` number, double
        - `lon` number, double
      - `metadata` SaleMetadata
        - `governmentSale` boolean
        - `pending` boolean
      - `address` Address
        - `street` string
        - `unit` string
        - `level` string
        - `lot` string
        - `streetNumber` string
        - `streetAddress` string
        - `locality` string
        - `streetLocation` string
        - `state` string
        - `postcode` string
        - `countryCode` string
        - `streetName` string
        - `streetSuffix` string
        - `streetType` string
        - `lga` string
      - `alternativeAddresses` Address[]
        - `street` string
        - `unit` string
        - `level` string
        - `lot` string
        - `streetNumber` string
        - `streetAddress` string
        - `locality` string
        - `streetLocation` string
        - `state` string
        - `postcode` string
        - `countryCode` string
        - `streetName` string
        - `streetSuffix` string
        - `streetType` string
        - `lga` string
      - `propertyFeatures` ExtendedPropertyFeatures
        - `bedrooms` integer
        - `bathrooms` integer
        - `carParks` integer
        - `rumpusRoom` boolean
        - `airConditioning` boolean
        - `doubleStorey` boolean
        - `highSet` boolean
        - `multiLevel` boolean
        - `splitLevel` boolean
        - `brickTile` boolean
        - `contemporary` boolean
        - `postWar` boolean
        - `queenslander` boolean
        - `ensuite` boolean
        - `study` boolean
        - `verandah` boolean
        - `builtIn` boolean
        - `modernKitchen` boolean
        - `pool` boolean
        - `scenicViews` boolean
        - `waterFrontage` boolean
        - `closeSchools` boolean
        - `closeTransport` boolean
        - `lowSet` boolean
        - `colonial` boolean
        - `entertainmentArea` boolean
        - `sleepout` boolean
        - `boreWater` boolean
        - `dams` boolean
        - `fullyFenced` boolean
        - `otherFeatures` string
        - `sheds` boolean
        - `balcony` boolean
        - `mainRooms` integer
        - `style` string
        - `buildYear` integer
        - `buildType` string
        - `storeys` integer
        - `roofStyle` string
        - `nathersRating` number, double
      - `landDetails` LandDetails
        - `propertyArea` number, double
        - `buildingArea` number, double
        - `volumeFolio` string
      - `rpd` string
      - `dealingNumber` string
      - `streetDisplay` string
      - `lowAskPrice` integer
      - `highAskPrice` integer
      - `extra` SearchExtra
        - `distance` number, double
        - `nameMatchType` string
        - `matchedName` string
      - `saleParticipants` SaleParticipantsSummary
        - `vendorsSummary` string
        - `purchasersSummary` string
      - `_self` string
  - `recentRentals` Listings
    - `disclaimer` string
    - `messages` Message[]
      - `code` integer
      - `text` string
    - `listings` Listing[]
      - `id` integer
      - `rental` boolean
      - `disclaimer` string
      - `messages` Message[]
        - `code` integer
        - `text` string
      - `agents` Agent[]
        - `name` string
        - `phoneNumber` string
        - `agency` AgencyIdentifier
          - `id` integer
      - `agencies` Agency[]
        - `id` integer
        - `name` string
        - `phoneNumber` string
      - `price` SensitivePrice
        - `display` string
        - `value` number, double
        - `rawValue` number, double
        - `withheld` boolean
      - `listingHistory` ListingListingHistory
        - `originalPrice` SensitivePrice
          - `display` string
          - `value` number, double
          - `rawValue` number, double
          - `withheld` boolean
        - `originalPricePercentChange` SensitiveChange
          - `display` string
          - `value` number, double
          - `rawValue` number, double
        - `daysOnMarket` integer
        - `lowAskPrice` integer
        - `highAskPrice` integer
      - `startDate` SensitiveDate
        - `display` string
        - `value` string, date-time
        - `rawValue` string, date-time
      - `image` ImageIdentifier
        - `id` integer
        - `_self` string
      - `property` PropertyIdentifier
        - `id` integer
        - `matchlevel` 'suburb' | 'street' | 'property'
        - `location` Point
          - `lat` number, double
          - `lon` number, double
        - `parent` boolean
        - `_self` string
      - `street` StreetIdentifier
        - `id` string
      - `suburb` SuburbIdentifier
        - `id` string
        - `_self` string
      - `location` Point
        - `lat` number, double
        - `lon` number, double
      - `propertyLegalDescription` string
      - `propertyType` string
      - `type` string
      - `status` ListingStatus
        - `historic` boolean
        - `underOffer` boolean
        - `listingStatus` string
      - `endDate` SensitiveDate
        - `display` string
        - `value` string, date-time
        - `rawValue` string, date-time
      - `lastModified` SensitiveDate
        - `display` string
        - `value` string, date-time
        - `rawValue` string, date-time
      - `propertyFeatures` ExtendedPropertyFeatures
        - `bedrooms` integer
        - `bathrooms` integer
        - `carParks` integer
        - `rumpusRoom` boolean
        - `airConditioning` boolean
        - `doubleStorey` boolean
        - `highSet` boolean
        - `multiLevel` boolean
        - `splitLevel` boolean
        - `brickTile` boolean
        - `contemporary` boolean
        - `postWar` boolean
        - `queenslander` boolean
        - `ensuite` boolean
        - `study` boolean
        - `verandah` boolean
        - `builtIn` boolean
        - `modernKitchen` boolean
        - `pool` boolean
        - `scenicViews` boolean
        - `waterFrontage` boolean
        - `closeSchools` boolean
        - `closeTransport` boolean
        - `lowSet` boolean
        - `colonial` boolean
        - `entertainmentArea` boolean
        - `sleepout` boolean
        - `boreWater` boolean
        - `dams` boolean
        - `fullyFenced` boolean
        - `otherFeatures` string
        - `sheds` boolean
        - `balcony` boolean
        - `mainRooms` integer
        - `style` string
        - `buildYear` integer
        - `buildType` string
        - `storeys` integer
        - `roofStyle` string
        - `nathersRating` number, double
      - `address` Address
        - `street` string
        - `unit` string
        - `level` string
        - `lot` string
        - `streetNumber` string
        - `streetAddress` string
        - `locality` string
        - `streetLocation` string
        - `state` string
        - `postcode` string
        - `countryCode` string
        - `streetName` string
        - `streetSuffix` string
        - `streetType` string
        - `lga` string
      - `originalListingAddress` Address
        - `street` string
        - `unit` string
        - `level` string
        - `lot` string
        - `streetNumber` string
        - `streetAddress` string
        - `locality` string
        - `streetLocation` string
        - `state` string
        - `postcode` string
        - `countryCode` string
        - `streetName` string
        - `streetSuffix` string
        - `streetType` string
        - `lga` string
      - `landDetails` LandDetails
        - `propertyArea` number, double
        - `buildingArea` number, double
        - `volumeFolio` string
      - `extra` SearchExtra
        - `distance` number, double
        - `nameMatchType` string
        - `matchedName` string
      - `_self` string
  - `disclaimer` string
  - `messages` Message[]
    - `code` integer
    - `text` string

---

[API](https://skmtc.net/pricefinder/apis/pricefinder-api-v1-13-1.md) · [All operations](https://skmtc.net/pricefinder/apis/pricefinder-api-v1-13-1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pricefinder/pricefinder-api-v1-13-1/revisions/10efa1470b1d/schema)