openapi: 3.2.0 info: title: Pricefinder Postcodes API version: 1.13.1 contact: name: Pricefinder license: name: Terms and Conditions url: https://www.domain.com.au/group/api-terms-and-conditions/ description: 'Operations tagged postcodes across 2 of this provider''s published API definitions: pricefinder-api-swagger.json, pricefinder-api-swagger.yml. Each path carries the servers of the definition it was published in.' servers: - url: /v1 tags: - name: postcodes paths: /postcodes/{postcode}/listings: get: tags: - postcodes description: '' operationId: listings parameters: - name: postcode in: path required: true pds: hidden: false extra: false enumerate: false deprecated: false schema: type: string - name: area_gt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: area_lt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: baths_gt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: baths_lt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: beds_gt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: beds_lt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: car_parks_gt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: car_parks_lt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: date_end in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: string format: date-time default: now - name: date_start in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: string format: date-time default: today-90d - name: historic in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: boolean default: false - name: limit in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 default: 100 - name: matchlevel_max in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: string enum: - suburb - street - property - name: matchlevel_min in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: string enum: - suburb - street - property - name: max_area in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: max_baths in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: max_beds in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: max_car_parks in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: max_price in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: number format: double - name: min_area in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: min_baths in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: min_beds in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: min_car_parks in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: min_price in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: number format: double - name: price_gt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: number format: double - name: price_lt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: number format: double - name: property_type in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: string enum: - house - unit - vacant - commercial - industrial - land - rural - retail - office - other - name: sort in: query description: can pass sort multiple times, use - to indicate descending required: false pds: hidden: false extra: true enumerate: false deprecated: false style: form explode: true schema: type: array format: -?\w+ items: type: string enum: - date - -date - price - -price responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/Listings' servers: - url: /v1 /postcodes/{postcode}/properties: get: tags: - postcodes description: '' operationId: properties parameters: - name: postcode in: path required: true pds: hidden: false extra: false enumerate: false deprecated: false schema: type: string - name: area_gt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: area_lt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: baths_gt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: baths_lt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: beds_gt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: beds_lt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: car_parks_gt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: car_parks_lt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: limit in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 default: 100 - name: max_area in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: max_baths in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: max_beds in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: max_car_parks in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: min_area in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: min_baths in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: min_beds in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: min_car_parks in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: property_type in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: string enum: - house - unit - vacant - commercial - industrial - land - rural - retail - office - other responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/Properties' servers: - url: /v1 /postcodes/{postcode}/rentals: get: tags: - postcodes description: '' operationId: rentals parameters: - name: postcode in: path required: true pds: hidden: false extra: false enumerate: false deprecated: false schema: type: string - name: area_gt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: area_lt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: baths_gt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: baths_lt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: beds_gt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: beds_lt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: car_parks_gt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: car_parks_lt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: date_end in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: string format: date-time default: now - name: date_start in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: string format: date-time default: today-90d - name: historic in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: boolean default: false - name: limit in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 default: 100 - name: matchlevel_max in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: string enum: - suburb - street - property - name: matchlevel_min in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: string enum: - suburb - street - property - name: max_area in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: max_baths in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: max_beds in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: max_car_parks in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: max_price in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: number format: double - name: min_area in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: min_baths in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: min_beds in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: min_car_parks in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: min_price in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: number format: double - name: price_gt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: number format: double - name: price_lt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: number format: double - name: property_type in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: string enum: - house - unit - vacant - commercial - industrial - land - rural - retail - office - other - name: sort in: query description: can pass sort multiple times, use - to indicate descending required: false pds: hidden: false extra: true enumerate: false deprecated: false style: form explode: true schema: type: array format: -?\w+ items: type: string enum: - date - -date - price - -price responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/Listings' servers: - url: /v1 /postcodes/{postcode}/sales: get: tags: - postcodes description: '' operationId: sales parameters: - name: postcode in: path required: true pds: hidden: false extra: false enumerate: false deprecated: false schema: type: string - name: area_gt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: area_lt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: baths_gt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: baths_lt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: beds_gt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: beds_lt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: car_parks_gt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: car_parks_lt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: integer format: int64 - name: date_end in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: string format: date-time default: now - name: date_start in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: string format: date-time default: today-6m - name: limit in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 default: 100 - name: matchlevel_max in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: string enum: - suburb - street - property - name: matchlevel_min in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: string enum: - suburb - street - property - name: max_area in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: max_baths in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: max_beds in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: max_car_parks in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: max_price in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: number format: double - name: min_area in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: min_baths in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: min_beds in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: min_car_parks in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: integer format: int64 - name: min_price in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: number format: double - name: price_gt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: number format: double - name: price_lt in: query required: false pds: hidden: false extra: true enumerate: false deprecated: true schema: type: number format: double - name: property_type in: query required: false pds: hidden: false extra: true enumerate: false deprecated: false schema: type: string enum: - house - unit - vacant - commercial - industrial - land - rural - retail - office - other - name: sort in: query description: can pass sort multiple times, use - to indicate descending required: false pds: hidden: false extra: true enumerate: false deprecated: false style: form explode: true schema: type: array format: -?\w+ items: type: string enum: - date - -date - price - -price responses: '200': description: successful operation headers: {} content: application/json: schema: $ref: '#/components/schemas/Sales' servers: - url: /v1 components: schemas: SensitivePrice: type: object properties: display: type: string value: type: number format: double rawValue: type: number format: double withheld: type: boolean OwnershipSummary: type: object properties: names: type: string ownerOccupied: type: boolean ownerAddress: type: string ListingStatus: type: object properties: historic: type: boolean underOffer: type: boolean listingStatus: type: string Phone: type: object properties: surname: type: string initials: type: string address: $ref: '#/components/schemas/Address' number: type: string doNotCall: type: boolean doNotCallWashDate: type: string format: date-time SuburbIdentifier: type: object properties: id: type: string _self: type: string Sale: type: object properties: id: type: integer format: int64 disclaimer: type: string messages: type: array items: $ref: '#/components/schemas/Message' price: $ref: '#/components/schemas/SensitivePrice' listingHistory: $ref: '#/components/schemas/SaleListingHistory' saleDate: $ref: '#/components/schemas/SensitiveDate' settlementDate: $ref: '#/components/schemas/SensitiveDate' contractDate: $ref: '#/components/schemas/SensitiveDate' image: $ref: '#/components/schemas/ImageIdentifier' property: $ref: '#/components/schemas/PropertyIdentifier' street: $ref: '#/components/schemas/StreetIdentifier' suburb: $ref: '#/components/schemas/SuburbIdentifier' propertyType: type: string saleType: type: string agency: $ref: '#/components/schemas/Agency' agent: $ref: '#/components/schemas/Agent' location: $ref: '#/components/schemas/Point' metadata: $ref: '#/components/schemas/SaleMetadata' address: $ref: '#/components/schemas/Address' alternativeAddresses: type: array items: $ref: '#/components/schemas/Address' propertyFeatures: $ref: '#/components/schemas/ExtendedPropertyFeatures' landDetails: $ref: '#/components/schemas/LandDetails' rpd: type: string dealingNumber: type: string streetDisplay: type: string lowAskPrice: type: integer format: int64 highAskPrice: type: integer format: int64 extra: $ref: '#/components/schemas/SearchExtra' saleParticipants: $ref: '#/components/schemas/SaleParticipantsSummary' _self: type: string Agency: type: object properties: id: type: integer format: int64 name: type: string phoneNumber: type: string Property: type: object properties: id: type: integer format: int64 matchlevel: type: string enum: - suburb - street - property location: $ref: '#/components/schemas/Point' parent: type: boolean disclaimer: type: string messages: type: array items: $ref: '#/components/schemas/Message' address: $ref: '#/components/schemas/Address' features: $ref: '#/components/schemas/ExtendedPropertyFeatures' alternativeAddresses: type: array items: $ref: '#/components/schemas/Address' landDetails: $ref: '#/components/schemas/LandDetails' image: $ref: '#/components/schemas/ImageIdentifier' map: $ref: '#/components/schemas/PropertyMapIdentifier' street: $ref: '#/components/schemas/StreetIdentifier' suburb: $ref: '#/components/schemas/SuburbIdentifier' type: type: string rpd: type: string marketStatus: $ref: '#/components/schemas/MarketStatus' lastModified: type: string format: date-time owners: $ref: '#/components/schemas/OwnershipSummary' ownership: $ref: '#/components/schemas/OwnershipSummary' lastSale: $ref: '#/components/schemas/Sale' recentListing: $ref: '#/components/schemas/Listing' recentRental: $ref: '#/components/schemas/Listing' extra: $ref: '#/components/schemas/SearchExtra' phoneNumbers: type: array items: $ref: '#/components/schemas/Phone' _self: type: string PropertyMapIdentifier: type: object properties: id: type: integer format: int64 _self: type: string Sales: type: object properties: disclaimer: type: string messages: type: array items: $ref: '#/components/schemas/Message' sales: type: array items: $ref: '#/components/schemas/Sale' Message: type: object properties: code: type: integer format: int64 text: type: string MarketStatus: type: object properties: status: type: string recentlySold: type: boolean recentlyForSale: type: boolean recentlyForRent: type: boolean forSale: type: boolean forRent: type: boolean likelyToList: type: boolean lastMarketEvent: $ref: '#/components/schemas/MarketStatusEventObject' Properties: type: object properties: disclaimer: type: string messages: type: array items: $ref: '#/components/schemas/Message' properties: type: array items: $ref: '#/components/schemas/Property' ImageIdentifier: type: object properties: id: type: integer format: int64 _self: type: string SensitiveDate: type: object properties: display: type: string value: type: string format: date-time rawValue: type: string format: date-time ListingIdentifier: type: object properties: id: type: integer format: int64 rental: type: boolean _self: type: string Point: type: object properties: lat: type: number format: double lon: type: number format: double SearchExtra: type: object properties: distance: type: number format: double nameMatchType: type: string matchedName: type: string AgencyIdentifier: type: object properties: id: type: integer format: int64 Address: type: object properties: street: type: string unit: type: string level: type: string lot: type: string streetNumber: type: string streetAddress: type: string locality: type: string streetLocation: type: string state: type: string postcode: type: string countryCode: type: string streetName: type: string streetSuffix: type: string streetType: type: string lga: type: string ListingListingHistory: type: object properties: originalPrice: $ref: '#/components/schemas/SensitivePrice' originalPricePercentChange: $ref: '#/components/schemas/SensitiveChange' daysOnMarket: type: integer format: int64 lowAskPrice: type: integer format: int64 highAskPrice: type: integer format: int64 StreetIdentifier: type: object properties: id: type: string Listings: type: object properties: disclaimer: type: string messages: type: array items: $ref: '#/components/schemas/Message' listings: type: array items: $ref: '#/components/schemas/Listing' SensitiveChange: type: object properties: display: type: string value: type: number format: double rawValue: type: number format: double Listing: type: object properties: id: type: integer format: int64 rental: type: boolean disclaimer: type: string messages: type: array items: $ref: '#/components/schemas/Message' agents: type: array items: $ref: '#/components/schemas/Agent' agencies: type: array items: $ref: '#/components/schemas/Agency' price: $ref: '#/components/schemas/SensitivePrice' listingHistory: $ref: '#/components/schemas/ListingListingHistory' startDate: $ref: '#/components/schemas/SensitiveDate' image: $ref: '#/components/schemas/ImageIdentifier' property: $ref: '#/components/schemas/PropertyIdentifier' street: $ref: '#/components/schemas/StreetIdentifier' suburb: $ref: '#/components/schemas/SuburbIdentifier' location: $ref: '#/components/schemas/Point' propertyLegalDescription: type: string propertyType: type: string type: type: string status: $ref: '#/components/schemas/ListingStatus' endDate: $ref: '#/components/schemas/SensitiveDate' lastModified: $ref: '#/components/schemas/SensitiveDate' propertyFeatures: $ref: '#/components/schemas/ExtendedPropertyFeatures' address: $ref: '#/components/schemas/Address' originalListingAddress: $ref: '#/components/schemas/Address' landDetails: $ref: '#/components/schemas/LandDetails' extra: $ref: '#/components/schemas/SearchExtra' _self: type: string SaleMetadata: type: object properties: governmentSale: type: boolean pending: type: boolean SaleParticipantsSummary: type: object properties: vendorsSummary: type: string purchasersSummary: type: string PropertyIdentifier: type: object properties: id: type: integer format: int64 matchlevel: type: string enum: - suburb - street - property location: $ref: '#/components/schemas/Point' parent: type: boolean _self: type: string LandDetails: type: object properties: propertyArea: type: number format: double buildingArea: type: number format: double volumeFolio: type: string MarketStatusEventObject: type: object properties: type: type: string event: type: object Agent: type: object properties: name: type: string phoneNumber: type: string agency: $ref: '#/components/schemas/AgencyIdentifier' ExtendedPropertyFeatures: type: object properties: bedrooms: type: integer format: int64 bathrooms: type: integer format: int64 carParks: type: integer format: int64 rumpusRoom: type: boolean airConditioning: type: boolean doubleStorey: type: boolean highSet: type: boolean multiLevel: type: boolean splitLevel: type: boolean brickTile: type: boolean contemporary: type: boolean postWar: type: boolean queenslander: type: boolean ensuite: type: boolean study: type: boolean verandah: type: boolean builtIn: type: boolean modernKitchen: type: boolean pool: type: boolean scenicViews: type: boolean waterFrontage: type: boolean closeSchools: type: boolean closeTransport: type: boolean lowSet: type: boolean colonial: type: boolean entertainmentArea: type: boolean sleepout: type: boolean boreWater: type: boolean dams: type: boolean fullyFenced: type: boolean otherFeatures: type: string sheds: type: boolean balcony: type: boolean mainRooms: type: integer format: int64 style: type: string buildYear: type: integer format: int64 buildType: type: string storeys: type: integer format: int64 roofStyle: type: string nathersRating: type: number format: double SaleListingHistory: type: object properties: originalListingId: $ref: '#/components/schemas/ListingIdentifier' originalPrice: $ref: '#/components/schemas/SensitivePrice' originalPricePercentChange: $ref: '#/components/schemas/SensitiveChange' lastListingId: $ref: '#/components/schemas/ListingIdentifier' lastPrice: $ref: '#/components/schemas/SensitivePrice' lastPricePercentChange: $ref: '#/components/schemas/SensitiveChange' daysToSell: type: integer format: int64 x-refined-from: - pricefinder-api-swagger.json - pricefinder-api-swagger.yml