PropTrack Listings API
Listing detail by listingId plus two cursor-paginated search shapes - point and radius, and suburb and postcode - exposing for-sale and for-rent listing data from realestate.com.au and realcommercial.com.au.
OpenAPI Specification
openapi: 3.1.0
info:
version: v2
title: Listings API
description: "- **[Listings/{listingId}](https://developer.proptrack.com.au/docs/apis/listings%2Foperations%2Fget-a-api-v-2-listing):\
\ GET /api/v2/listings/{listingId}**</br>Retrieves current and historic listings for a given listing</br>\n\
- **[Listings/Point & Radius Search](https://developer.proptrack.com.au/docs/apis/listings%2Foperations%2Fget-a-api-v-2-listing-search-point-and-radius):\
\ GET /api/v2/listings/search/point-and-radius**</br>Retrieves current and historic listings within\
\ a given radius of a target point\n- **[Listings/Suburb & Postcode Search](https://developer.proptrack.com.au/docs/apis/listings%2Foperations%2Fget-a-api-v-2-listing-search-suburb-and-postcode):\
\ GET /api/v2/listings/search/point-and-radius**</br>Retrieves current and historic listings for a\
\ specified suburb name and postcode\n</br>\n\n<div class=\"section-about\" style=\"margin-top: 40px\"\
>\n <div class=\"page-section__inner\" style=\"margin: 0px auto; max-width: 1250px; -webkit-font-smoothing:\
\ antialiased\" >\n <div\n class=\"cards-list\"\n style=\"\n display: flex;\n\
\ flex-wrap: wrap;\n justify-content: space-between;\n margin: 20px 0px;\n \
\ max-width: 900px;\n padding: px;\n box-sizing: 1px;\n border-box: 1px;\n\
\ border-color: black;\n \"\n >\n <div\n class=\"cards-list__item\"\n \
\ style=\"\n margin-top: 16px;\n padding: 0px 16px;\n max-width:\
\ 250px;\n min-width: 200px;\n margin-bottom: 0px;\n box-sizing: border-box;\n\
\ \"\n >\n <div\n class=\"card__thumb\"\n style=\"height: 49px;\
\ width: 50px; background-color: #0078BD; border-radius: 4px; padding: 4px; display: flex; align-items:\
\ center; justify-content: center;\"\n >\n <i class=\"fa-regular fa-badge-check\"\
\ style=\"font-size: 24px; color: #F7F8F9;\"></i>\n </div>\n <div\n class=\"\
card__title\"\n style=\"\n margin-top: 22px;\n font-family: Graphik,\
\ Arial, sans-serif;\n font-size: 24px;\n line-height: 36px;\n font-weight:\
\ 700;\n color: rgb(44, 44, 44);\n \"\n >\n Getting Started\n\
\ </div>\n <div\n class=\"card__text\"\n style=\"\n margin-top:\
\ 8px;\n font-size: 14px;\n line-height: 24px;\n font-family: 'Open\
\ Sans', Arial, sans-serif;\n font-weight: 400;\n color: rgb(44, 44, 44);\n\
\ \"\n >\n Start your journey\n </div>\n <ul>\n <li>\n\
\ <a href=\"https://developer.proptrack.com.au/docs/apis/api-trials\"\n >\
\ API Trials</a\n >\n </li>\n <li><a href=\"https://developer.proptrack.com.au/docs/apis/how-to-authenticate\"\
>Authentication</a></li>\n <li>\n <a href=\"https://developer.proptrack.com.au/docs/apis/error-handling\"\
>Error Handling</b></a>\n </li>\n </ul>\n </div>\n <div\n class=\"\
cards-list__item\"\n style=\"\n margin-top: 16px;\n padding: 0px 16px;\n\
\ max-width: 250px;\n min-width: 200px;\n margin-bottom: 0px;\n \
\ box-sizing: border-box;\n \"\n >\n <div\n class=\"card__thumb\"\n\
\ style=\"height: 49px; width: 50px; background-color: #0078BD; border-radius: 4px; padding:\
\ 4px; display: flex; align-items: center; justify-content: center;\"\n >\n <i class=\"\
fa-regular fa-list\" style=\"font-size: 24px; color: #F7F8F9;\"></i>\n </div>\n <div\n\
\ class=\"card__title\"\n style=\"\n margin-top: 22px;\n font-family:\
\ Graphik, Arial, sans-serif;\n font-size: 24px;\n line-height: 36px;\n \
\ font-weight: 700;\n color: rgb(44, 44, 44);\n \"\n >\n \
\ API References\n </div>\n <div\n class=\"card__text\"\n style=\"\
\n margin-top: 8px;\n font-size: 14px;\n line-height: 24px;\n \
\ font-family: 'Open Sans', Arial, sans-serif;\n font-weight: 400;\n \
\ color: rgb(44, 44, 44);\n \"\n >\n Explore our knowledge base\n \
\ </div>\n <ul>\n <li>\n <a href=\"https://developer.proptrack.com.au/docs/apis/guide\"\
\n >API Guide</a\n >\n </li>\n <li><a href=\"https://developer.proptrack.com.au/docs/apis/rate-limits\"\
>Rate Limiting</a></li>\n <li>\n <a href=\"https://developer.proptrack.com.au/docs/apis/getting-support\"\
\n >Getting Support</a\n >\n </li>\n </ul>\n </div>\n\
\ <div\n class=\"cards-list__item\"\n style=\"\n margin-top: 16px;\n \
\ padding: 0px 16px;\n max-width: 250px;\n min-width: 200px;\n \
\ margin-bottom: 0px;\n box-sizing: border-box;\n \"\n >\n <div\n \
\ class=\"card__thumb\"\n style=\"height: 49px; width: 50px; background-color: #0078BD;\
\ border-radius: 4px; padding: 4px; display: flex; align-items: center; justify-content: center;\"\
\n >\n <i class=\"fa-regular fa-files\" style=\"font-size: 24px; color: #F7F8F9;\"\
></i>\n </div>\n <div\n class=\"card__title\"\n style=\"\n \
\ margin-top: 22px;\n font-family: Graphik, Arial, sans-serif;\n font-size:\
\ 24px;\n line-height: 36px;\n font-weight: 700;\n color: rgb(44,\
\ 44, 44);\n \"\n >\n Useful Docs\n </div>\n <div\n \
\ class=\"card__text\"\n style=\"\n margin-top: 8px;\n font-size:\
\ 14px;\n line-height: 24px;\n font-family: 'Open Sans', Arial, sans-serif;\n\
\ font-weight: 400;\n color: rgb(44, 44, 44);\n \"\n >\n \
\ Helpful resources\n </div>\n <ul>\n <li>\n <a href=\"https://developer.proptrack.com.au/docs/apis/pagination\"\
>Pagination</a>\n </li>\n <li><a href=\"https://developer.proptrack.com.au/docs/apis/rules-engine\"\
>Rules Engine</a></li>\n <li><a href=\"https://developer.proptrack.com.au/docs/apis/faqs\"\
>FAQs</a></li>\n </ul>\n </div>\n <div\n class=\"cards-list__item\"\n \
\ style=\"\n margin-top: 16px;\n padding: 0px 16px;\n max-width: 250px;\n\
\ min-width: 200px;\n margin-bottom: 0px;\n box-sizing: border-box;\n \
\ \"\n >\n <div\n class=\"card__thumb\"\n style=\"height: 49px;\
\ width: 50px; background-color: #0078BD; border-radius: 4px; padding: 4px; display: flex; align-items:\
\ center; justify-content: center;\"\n >\n <i class=\"fa-regular fa-tag\" style=\"\
font-size: 24px; color: #F7F8F9;\"></i></i>\n </div>\n <div\n class=\"card__title\"\
\n style=\"\n margin-top: 22px;\n font-family: Graphik, Arial, sans-serif;\n\
\ font-size: 24px;\n line-height: 36px;\n font-weight: 700;\n \
\ color: rgb(44, 44, 44);\n \"\n >\n Get in Touch\n </div>\n\
\ <div\n class=\"card__text\"\n style=\"\n margin-top: 8px;\n\
\ font-size: 14px;\n line-height: 24px;\n font-family: 'Open Sans',\
\ Arial, sans-serif;\n font-weight: 400;\n color: rgb(44, 44, 44);\n \
\ \"\n >\n Connect with us\n </div>\n <ul>\n <li><a href=\"\
https://www.proptrack.com.au/contact-us/sales/\">Contact Sales</a></li>\n <li><a href=\"\
https://www.proptrack.com.au/support/contact-support/\">Contact Support</a></li>\n </ul>\n\
\ </div>\n </div>\n </div>\n</div>"
termsOfService: https://developer.proptrack.com.au/docs/apis/terms-of-use
contact:
url: https://www.proptrack.com.au/contact-us
email: https://www.proptrack.com.au/contact-us
name: PropTrack
servers:
- url: https://data.proptrack.com
paths:
/api/v2/listings/{listingId}:
get:
summary: /api/v2/listings/{listingId}
description: Retrieves current and historic listings based on the `listingId`.
operationId: listings
parameters:
- name: Authorization
in: header
description: Provide your bearer token as a string, in the format `Bearer {access_token}` in the
Authorization Header</br>Refer to [Authentication](https://developer.proptrack.com.au/docs/apis/authentication/operations/create-a-oauth-2-token)
required: true
schema:
type: string
examples:
- Bearer jyJraWQiOiJiYWRmKzUyNC1jYzBkLTQ9YWUtYTAzMC02MjBlYTE3ZDNlZjMiLCJ0eXAiO
default: Bearer {access_token}
example: Bearer jyJraWQiOiJiYWRmKzUyNC1jYzBkLTQ9YWUtYTAzMC02MjBlYTE3ZDNlZjMiLCJ0eXAiO
- name: listingId
in: path
description: Unique identifier for a listing
required: true
schema:
type: string
examples:
- '7654321'
responses:
'200':
description: '<!-- theme: success -->
> #### Success (200)
'
content:
application/json:
schema:
type: object
x-examples:
example-1:
propertyId: '1234567'
listings:
- listingId: '7654321'
listedAddress:
addressIdentifier: LG/21-23 Seven Hill Road, Baulkham Hills, NSW 2153
country: AU
latitude: -33.762436
longitude: 150.99017
postcode: '2153'
state: NSW
street: LG/21-23 Seven Hill Road
streetName: Seven Hill Road
streetNumber: 21-23
suburb: Baulkham Hills
agency:
agencyName: Hualei Properties - Sydney
agent:
agentName: Danny (Lei) Shi
attributes:
bedrooms: 4
bathrooms: 2
carSpaces: 2
floorArea: 143
landArea: 615
propertyType: strata
propertySubType: apartment
yearBuilt: 1920
features:
- builtInRobes
- airConditioning
auctionDate: '2021-10-18'
auctionTime: 01:00:00 am
daysToSale: 23
description: This stunning apartment is located in the heart of Baulkham Hills,
with only few minutes walking distance to Stockland Shopping Centre, close to
express buses to the City and Parramatta, and ONLY minutes away from local schools.<br/><br/>Other
Features Include:<br/>- 2 Spacious bedrooms with build in wardrobes, main with
ensuite;<br/>- Open plan kitchen with gas cooking, oven and dishwasher;<br/>-
Two tiny and bright bathrooms;<br/>- Combined dinning and lounge area throughout
to the balcony;<br/>- With internal laundry and dryer;<br/>- With security intercom,
secured access and car space.<br/><br/>Please contact us for inspection.
firstSeenDate: '2021-09-27'
listingType: sale
priceDescription: Offers over $1,000,000
listingPrice: 998000
status: sold
saleDate: '2021-10-18'
saleValue: 1030000
auctionResult: soldAtAuction
source: REA
videoUrl: https://www.youtube.com/embed/j4clLwXYYXA
images:
id: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4.jpg
extension: jpg
type: image
orderIndex: 0
date: '2018-09-27'
sha: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4
attachments:
url: https://insights.proptrack.com/documents/5c4de68d682dfaa984d4470e1326707d88cb8a4ae667de309810a7aae8a7840f/statement_of_information1.pdf
type: statement_of_information
date: '2018-09-27'
required:
- listingId
- propertyId
properties:
listingId:
type: string
description: Unique identifier for a listing
examples:
- '7654321'
propertyId:
type:
- integer
- 'null'
description: Unique identifier for a property
examples:
- 1234567
address:
type: object
properties:
fullAddress:
type:
- string
- 'null'
description: 'Listed address, as provided by the selling agent '
examples:
- 1/67 Louisa Rd, Birchgrove, NSW 2041
location:
type:
- object
- 'null'
properties:
latitude:
type:
- number
- 'null'
description: Listed latitude, as provided by the selling agent
examples:
- -34.05438
longitude:
type:
- number
- 'null'
description: Listed longitude, as provided by the selling agent
examples:
- 151.6941
attributes:
type: object
properties:
bedrooms:
type:
- integer
- 'null'
description: Number of bedrooms
examples:
- 4
bathrooms:
type:
- integer
- 'null'
description: Number of bathrooms
examples:
- 2
carSpaces:
type:
- integer
- 'null'
description: Number of car spaces
examples:
- 2
floorArea:
type:
- integer
- 'null'
description: Floor space area (measured in m2)
examples:
- 260
landArea:
type:
- integer
- 'null'
description: Land space area (measured in m2)
examples:
- 600
propertyType:
description: Classification of the type of property
examples:
- house
enum:
- house
- unit
- land
propertySubType:
enum:
- apartment
- retire
- serviced_apartment
- studio
- unit
- townhouse
- alpine
- flat
- villa
- terrace
- house
- warehouse
- duplex_semi_detached
- acreage
- mixedfarming
- lifestyle
- horticulture
- dairy
- farmlet
- residential_land
- viticulture
- livestock
- cropping
- rural_other
- unitblock
- residential_other
description: Refer to [Property Sub-Types](https://developer.proptrack.com.au/docs/apis/guide#property-types--property-sub-types)
type: string
yearBuilt:
type:
- integer
- 'null'
description: The year that the property was built
examples:
- 1998
features:
type: array
description: Refer to [Features](https://developer.proptrack.com.au/docs/apis/guide#features)
items:
enum:
- airConditioning
- alarmSystem
- balcony
- broadband
- builtInRobes
- courtyard
- deck
- dishwasher
- ductedCooling
- ductedHeating
- electricHeating
- electricHotWater
- evaporativeCooling
- floorboards
- fullyFenced
- furnished
- gasHeating
- gasHotWater
- greyWaterSystem
- gym
- heatPumpHotWater
- hydronicHeating
- insideSpa
- intercom
- multiDwelling
- newConstruction
- openFireplace
- outdoorEnt
- outsideSpa
- payTV
- petFriendly
- poolAbove
- poolInG
- remoteGarage
- reverseCycleAirCon
- rumpusRoom
- secureParking
- shed
- smokers
- solarHotWater
- solarPanels
- spa
- splitSystemAirCon
- splitSystemHeating
- study
- tennisCourt
- vacuumSystem
- waterTank
- workshop
auctionDateTime:
type:
- string
- 'null'
description: Auction's local start date and time based on the listing's location (only
available when the listing type is sale)
examples:
- '2023-02-19T12:00:00+10:00'
format: date-time
auctionDate:
type:
- string
- 'null'
description: Auction local start date based on the listing's location (only available
when the listing type is sale)</br>Format `YYYY-MM-DD`
examples:
- '2023-02-19'
format: date
auctionTime:
type:
- string
- 'null'
description: Auction local start time based on the listing's location (only available
when the listing type is sale)
examples:
- 12:00:00 pm
format: time
auctionResult:
enum:
- passedIn
- passedInVendorBid
- soldAfterAuction
- soldAtAuction
- soldPriorToAuction
- withdrawn
description: Auction outcome for sale listings</br>Refer to [Auction Results](https://developer.proptrack.com.au/docs/apis/guide#auction-results)
type: string
daysOnSite:
type:
- integer
- 'null'
description: Number of days the listing was advertised before it was delisted
examples:
- 23
description:
type:
- string
- 'null'
description: Verbiage displayed on a listing that describes the listed property
examples:
- This stunning apartment is located in the heart of Baulkham Hills
firstSeenDate:
type:
- string
- 'null'
description: Date that the listing was published to realestate.com.au</br>Format `YYYY-MM-DD`
examples:
- '2022-12-23'
format: date
listingType:
enum:
- sale
- rent
description: Refer to [Listing Types](https://developer.proptrack.com.au/docs/apis/guide#listing-type)
type: string
listingPrice:
type:
- integer
- 'null'
description: 'Price that represents the advertised listing value. When the listing
type is ''rent, then returned value is ''per week''.</br>
**Note: This value is not permitted for display**'
examples:
- 998000
priceDescription:
type:
- string
- 'null'
description: 'Price displayed on the listing</br>
Note: This value may not always describe the price, but a description such as "Price
on request"'
example: Offers from $1M
status:
enum:
- current
- sold
- notSold
- leased
- notLeased
description: "Listing status. \n* When listing type is `sale`, then `status` can be\
\ `current`, `sold`, `notSold`\n* When listing type is `rent` then `status` can\
\ be `current`, `leased`, `notLeased`\nRefer to [Listing Statuses](https://developer.proptrack.com.au/docs/apis/guide#listing-status)"
examples:
- current
type: string
leaseDate:
type:
- string
- 'null'
x-stoplight:
id: owfor17au8ibg
description: "Agent advised lease date</br>\r\nFormat `YYYY-MM-DD`"
example: '2024-02-20'
format: date
saleDate:
type:
- string
- 'null'
description: Agent advised sale date</br>Format `YYYY-MM-DD`
examples:
- '2023-02-19'
format: date
example: '2024-02-20'
saleValue:
type:
- integer
- 'null'
description: "Agent advised sale value</br>\r\nIf `\"saleValueSuppressed\": true`,\
\ then this field will return as `undefined`"
examples:
- 1030000
saleValueSuppressed:
type: boolean
description: Flags if the `saleValue` field has been suppressed
source:
enum:
- REA
description: Where the listing data has been sourced from
examples:
- REA
type: string
videoUrl:
type:
- string
- 'null'
description: Link to video that was uploaded to the listing
examples:
- https://www.youtube.com/embed/j4clLwXYYXA
images:
type: array
description: Refer to [Constructing an Image URL](https://developer.proptrack.com.au/docs/apis/faqs#how-do-i-construct-an-image-url)
items:
type: object
properties:
id:
type:
- string
- 'null'
description: The identifier associated with the image
examples:
- d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4.jpg
extension:
enum:
- jpg
- gif
- png
- pcx
- svg
- webp
- ppm
- tiff
- bmp
description: File extension type
examples:
- jpg
type: string
type:
enum:
- image
- floorplan
description: Image type
examples:
- image
type: string
orderIndex:
type:
- integer
- 'null'
description: The order in which images are displayed on a listing. I.e. orderIndex
`0` for an `image` type represents the cover image
examples:
- 0
date:
type:
- string
- 'null'
description: Date that the image was uploaded</br>Format `YYYY-MM-DD`
examples:
- '2022-12-23'
format: date
sha:
type:
- string
- 'null'
description: Secure hashing algorithm
examples:
- d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4
attachments:
type: array
items:
type: object
properties:
url:
type:
- string
- 'null'
description: Web address for attachment
examples:
- https://insights.proptrack.com/documents/ba1666e6d06417d8fcdc2d4f2b622396a64d2ada61326e84b21682052af40ad8/statement.pdf
type:
enum:
- statement_of_information
description: Attachment type
examples:
- statement_of_information
type: string
date:
type:
- string
- 'null'
description: Date that the attachment was uploaded</br>Format `YYYY-MM-DD`
examples:
- '2022-12-23'
energyEfficiencyRating:
type:
- number
- 'null'
x-stoplight:
id: d0pb8mzgjmp52
format: float
example: 6
description: Energy Efficiency Rating for the listing. If no rating has been provided,
this will be null
readOnly: true
agents:
type:
- array
- 'null'
x-stoplight:
id: yzxn0a8newdbo
description: "Information regarding the agent(s) associated with a listing<br>\r\n\
<span style=\"color:#F47853\">Additional authorisation is required for access to\
\ this data point. Please refer to your account manager for more information.</span>"
items:
x-stoplight:
id: qfr7xx4ynm3cf
type: object
properties:
name:
type: string
x-stoplight:
id: 5iu9dw82c1f47
description: The full name of the agent linked to a listing
example: Joe Bloggs
agentId:
type: string
x-stoplight:
id: duf05lx4kdaww
description: "The ID of the agent linked to a listing.\r\nEach REA customer/account\
\ is assigned a unique 6 character identity code"
example: '817222'
agencies:
type:
- array
- 'null'
x-stoplight:
id: ftdqnapqigs9c
description: "Information regarding the agency(s) associated with a listing<br>\r\n\
<span style=\"color:#F47853\">Additional authorisation is required for access to\
\ this data point. Please refe
# --- truncated at 32 KB (222 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/rea-group/refs/heads/main/openapi/rea-group-listings-openapi.yml