openapi: 3.2.0
info:
version: v2
title: Listings Listing by listingId API
description: "- **[Listings/{listingId}](https://developer.proptrack.com.au/docs/apis/listings%2Foperations%2Fget-a-api-v-2-listing): GET /api/v2/listings/{listingId}**Retrieves current and historic listings for a given listing\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**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**Retrieves current and historic listings for a specified suburb name and postcode\n\n\n
\n
\n
\n
\n
\n \n
\n
\n Getting Started\n
\n
\n Start your journey\n
\n
\n
\n
\n
\n \n
\n
\n API References\n
\n
\n Explore our knowledge base\n
\n
\n
\n
\n
\n \n
\n
\n Useful Docs\n
\n
\n Helpful resources\n
\n
\n
\n
\n
\n \n
\n
\n Get in Touch\n
\n
\n Connect with us\n
\n
\n
\n
\n
\n
"
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
tags:
- name: Listing by listingId
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 HeaderRefer 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: '
> #### 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.
Other Features Include:
- 2 Spacious bedrooms with build in wardrobes, main with ensuite;
- Open plan kitchen with gas cooking, oven and dishwasher;
- Two tiny and bright bathrooms;
- Combined dinning and lounge area throughout to the balcony;
- With internal laundry and dryer;
- With security intercom, secured access and car space.
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)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 listingsRefer 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.auFormat `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''.
**Note: This value is not permitted for display**'
examples:
- 998000
priceDescription:
type:
- string
- 'null'
description: 'Price displayed on the listing
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
Format `YYYY-MM-DD`'
example: '2024-02-20'
format: date
saleDate:
type:
- string
- 'null'
description: Agent advised sale dateFormat `YYYY-MM-DD`
examples:
- '2023-02-19'
format: date
example: '2024-02-20'
saleValue:
type:
- integer
- 'null'
description: 'Agent advised sale value
If `"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 uploadedFormat `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 uploadedFormat `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
Additional authorisation is required for access to this data point. Please refer to your account manager for more information.'
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.
Each 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
Additional authorisation is required for access to this data point. Please refer to your account manager for more information.'
items:
x-stoplight:
id: brhfwa7bxwtpa
type: object
properties:
name:
type:
- string
- 'null'
x-stoplight:
id: 9sler4qtrttuv
description: The name of the agency linked to the listing
example: Estate Agent Name
agencyId:
type: string
x-stoplight:
id: k0b5rb0th5rdr
description: The ID of the agency linked to a listing. Each REA customer/account is assigned a unique 6 character identity code
example: AXXYYY
examples:
Sale Listing Currently on the Market:
value:
listingId: '7654321'
propertyId: 1234567
attributes:
bedrooms: 4
bathrooms: 2
carSpaces: 2
floorArea: 260
landArea: 600
propertyType: house
propertySubType: house
yearBuilt: 1998
features:
- airConditioning
auctionDateTime: '2023-02-19T12:00:00+10:00'
auctionDate: '2023-02-19'
auctionTime: 01:00:00 pm
description: This stunning apartment is located in the heart of Baulkham Hills
firstSeenDate: '2022-12-23'
listingType: sale
status: current
source: REA
videoUrl: https://www.youtube.com/embed/j4clLwXYYXA
images:
- id: e200f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4.jpg
extension: jpg
type: image
orderIndex: 0
date: '2022-12-23'
sha: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4
- id: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4.jpg
extension: jpg
type: image
orderIndex: 1
date: '2022-12-23'
sha: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4
- id: d300f1a395373a8622bb0fa1b2ec64542951d5d363defc75d18a479b06d800c4.jpg
extension: jpg
type: image
orderIndex: 2
date: '2022-12-23'
sha: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4
attachments:
- url: https://insights.proptrack.com/documents/ba1666e6d06417d8fcdc2d4f2b622396a64d2ada61326e84b21682052af40ad8/statement.pdf
type: statement_of_information
date: '2022-12-23'
energyEfficiencyRating: 2
Sold at Auction:
value:
listingId: '7654321'
propertyId: 1234567
attributes:
bedrooms: 4
bathrooms: 2
carSpaces: 2
floorArea: 260
landArea: 600
propertyType: house
propertySubType: house
yearBuilt: 1998
features:
- airConditioning
auctionDateTime: '2023-02-19T12:00:00+10:00'
auctionDate: '2023-02-19'
auctionTime: 12:00:00 pm
auctionResult: soldAtAuction
daysOnSite: 7
description: This stunning apartment is located in the heart of Baulkham Hills
firstSeenDate: '2023-02-12'
listingType: sale
listingPrice: 998000
priceDescription: Offers over $950K
status: sold
saleDate: '2023-02-19'
saleValue: 1030000
saleValueSuppressed: false
source: REA
videoUrl: https://www.youtube.com/embed/j4clLwXYYXA
images:
- id: e800f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4.jpg
extension: jpg
type: image
orderIndex: 0
date: '2022-12-23'
sha: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4
- id: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4.jpg
extension: jpg
type: image
orderIndex: 1
date: '2022-12-23'
sha: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4
- id: fd30f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4.jpg
extension: jpg
type: image
orderIndex: 2
date: '2022-12-23'
sha: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4
attachments:
- url: https://insights.proptrack.com/documents/ba1666e6d06417d8fcdc2d4f2b622396a64d2ada61326e84b21682052af40ad8/statement.pdf
type: statement_of_information
date: '2022-12-23'
Rent Listing Currently on the Market:
value:
listingId: '7654321'
propertyId: 1234567
attributes:
bedrooms: 4
bathrooms: 2
carSpaces: 2
floorArea: 260
landArea: 600
propertyType: house
propertySubType: house
yearBuilt: 1998
features:
- airConditioning
description: This stunning apartment is located in the heart of Baulkham Hills
firstSeenDate: '2022-12-23'
listingType: rent
listingPrice: 400
priceDescription: $400 per week
status: current
source: REA
videoUrl: https://www.youtube.com/embed/j4clLwXYYXA
images:
- id: e800f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4.jpg
extension: jpg
type: image
orderIndex: 0
date: '2022-12-23'
sha: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4
- id: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4.jpg
extension: jpg
type: image
orderIndex: 1
date: '2022-12-23'
sha: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4
- id: fd30f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4.jpg
extension: jpg
type: image
orderIndex: 2
date: '2022-12-23'
sha: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4
attachments:
- url: https://insights.proptrack.com/documents/ba1666e6d06417d8fcdc2d4f2b622396a64d2ada61326e84b21682052af40ad8/statement.pdf
type: statement_of_information
date: '2022-12-23'
energyEfficiencyRating: 2
Leased Rent Listing:
value:
listingId: '7654321'
propertyId: 1234567
attributes:
bedrooms: 4
bathrooms: 2
carSpaces: 2
floorArea: 260
landArea: 600
propertyType: house
propertySubType: house
yearBuilt: 1998
features:
- airConditioning
description: This stunning apartment is located in the heart of Baulkham Hills
firstSeenDate: '2022-12-23'
listingType: rent
listingPrice: 400
priceDescription: $400 per week
status: leased
source: REA
videoUrl: https://www.youtube.com/embed/j4clLwXYYXA
images:
- id: e800f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4.jpg
extension: jpg
type: image
orderIndex: 0
date: '2022-12-23'
sha: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4
- id: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4.jpg
extension: jpg
type: image
orderIndex: 1
date: '2022-12-23'
sha: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4
- id: fd30f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4.jpg
extension: jpg
type: image
orderIndex: 2
date: '2022-12-23'
sha: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4
attachments:
- url: https://insights.proptrack.com/documents/ba1666e6d06417d8fcdc2d4f2b622396a64d2ada61326e84b21682052af40ad8/statement.pdf
type: statement_of_information
date: '2022-12-23'
energyEfficiencyRating: 2
Listing with Agent/Agency Details:
value:
listingId: '7654321'
propertyId: 1234567
address:
fullAddress: 1/67 Louisa Rd, Birchgrove, NSW 2041
location:
latitude: -34.05438
longitude: 151.6941
attributes:
bedrooms: 4
bathrooms: 2
carSpaces: 2
floorArea: 260
landArea: 600
propertyType: house
propertySubType: apartment
yearBuilt: 1998
features:
- airConditioning
auctionDateTime: '2023-02-19T12:00:00+10:00'
auctionDate: '2023-02-19'
auctionTime: 12:00:00 pm
auctionResult: passedIn
daysOnSite: 23
description: This stunning apartment is located in the heart of Baulkham Hills
firstSeenDate: '2022-12-23'
listingType: sale
listingPrice: 998000
priceDescription: Offers from $1M
status: current
leaseDate: '2024-02-20'
saleDate: '2024-02-20'
saleValue: 1030000
saleValueSuppressed: true
source: REA
videoUrl: https://www.youtube.com/embed/j4clLwXYYXA
images:
- id: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4.jpg
extension: jpg
type: image
orderIndex: 0
date: '2022-12-23'
sha: d300f1a395373a8622bb0fa1b2ec53d42951d5d363defc75d18a479b06d800c4
attachments:
- url: https://insights.proptrack.com/documents/ba1666e6d06417d8fcdc2d4f2b622396a64d2ada61326e84b21682052af40ad8/statement.pdf
type: statement_of_information
date: '2022-12-23'
energyEfficiencyRating: 6
agents:
- name: Joe Bloggs
agentId: '817222'
agencies:
- name: Estate Agency Name
agencyId: AXXYYY
headers:
Content-Type:
schema:
enum:
- application/json
type: string
description: Media type of the resource
X-Transaction-Id:
schema:
type: string
example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9
description: Should be quoted as a reference for any support request/unexpected error
'400':
description: '
> #### Bad Request (400)
Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#listingslistingid) for information on error handling.'
content:
application/json:
schema:
type: object
x-examples:
example-1:
errors:
- code: 7006
description: Number of Results contains invalid characters - Please only include a numeric value
properties:
errors:
type: array
items:
type: object
properties:
code:
enum:
- 7006
- 7010
- 7011
description: Numeric value that defines the type of error that has occurred
type: integer
level:
enum:
- CRITICAL
description: 'Defines the severity of the errorNote: If level is `CRITICAL` then a successful response will not be returned'
x-deprecated: true
type: string
description:
type: string
description: Briefly describes the type of error that has occured
examples:
- An incorrect field type has been entered - Please ensure that all values are using the correct field type
parameters:
type: object
description: 'Lists the parameter/s which is causing the error, and the rule that was invoked
'
properties:
listingId:
type: string
examples:
- must be an integer
required:
- code
- description
examples:
Sample:
value:
errors:
- code: 7006
level: CRITICAL
description: Invalid characters have been included - Please only include allowed characters
parameters:
listingType: must only include alphabetical characters
status: must only include alphabetical characters
headers:
Content-Type:
schema:
type: string
enum:
- application/json
description: Media type of the resource
X-Transaction-Id:
schema:
type: string
example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9
description: Should be quoted as a reference for any support request/unexpected error
'401':
description: '
> #### Unauthorized (401)
Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#listingslistingid) for information on error handling.'
content:
application/json:
schema:
type: object
x-examples:
example-1:
errors:
- code: 9012
description: Authentication token validation has failed - Please ensure that a valid Token Authentication Request has been completed before trying again
properties:
errors:
type: array
items:
type: object
properties:
code:
enum:
- 9012
- 9016
description: Numeric value that defines the type of error that has occurred
type: integer
level:
enum:
- CRITICAL
description: 'Defines the severity of the errorNote: If level is `CRITICAL` then a successful response will not be returned'
x-deprecated: true
type: string
description:
type: string
description: Briefly describes the type of error that has occured
examples:
- Authentication token validation has failed - Please ensure that a valid token authentication request has been completed before trying again
required:
- code
- description
examples:
Sample:
value:
errors:
- code: 9012
level: CRITICAL
description: Authentication token validation has failed - Please ensure that a valid Token Authentication Request has been completed before trying again
headers:
Content-Type:
schema:
type: string
enum:
- application/json
description: Media type of the resource
X-Transaction-Id:
schema:
type: string
example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9
description: Should be quoted as a reference for any support request/unexpected error
'403':
description: '
> #### Forbidden (403)
Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#listingslistingid) for information on error handling.'
content:
application/json:
schema:
type: object
x-examples:
Example 1:
errors:
- code: 9003
description: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint
properties:
errors:
type: array
items:
type: object
properties:
code:
type: integer
description: Defines the type of error that has occurred
enum:
- 9003
description:
type: string
description: Overview of the error that has occurred
example: Access denied - Please contact our customer support team at support@proptrack.com for access to this endpoint
required:
- code
- description
headers:
Content-Type:
schema:
type: string
enum:
- application/json
description: Media type of the resource
X-Transaction-Id:
schema:
type: string
example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9
description: Should be quoted as a reference for any support request/unexpected error
'404':
description: '
> #### Not Found (404)
Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#listingslistingid) for information on error handling.'
content:
application/json:
schema:
type: object
x-examples:
example-1:
errors:
- code: 7002
description: Unknown id, the entered value does not match a record within our system - Please ensure that the correct value is added to this field
properties:
errors:
type: array
items:
type: object
properties:
code:
enum:
- 7002
description: Numeric value that defines the type of error that has occurred
type: integer
level:
enum:
- CRITICAL
description: 'Defines the severity of the errorNote: If level is `CRITICAL` then a successful response will not be returned'
x-deprecated: true
type: string
description:
type: string
description: Briefly describes the type of error that has occured
examples:
- Unknown id, the included value does not match a record within our system - Please ensure that the correct value is added to this field
required:
- code
- description
examples:
Sample:
value:
errors:
- code: 7002
level: CRITICAL
description: Unknown id, the included value does not match a record within our system - Please ensure that the correct value is added to this field
headers:
Content-Type:
schema:
type: string
enum:
- application/json
description: Media type of the resource
X-Transaction-Id:
schema:
type: string
example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9
description: Should be quoted as a reference for any support request/unexpected error
'429':
description: '
> #### Too Many Requests (429)
Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#listingslistingid) for information on error handling.'
content:
application/json:
schema:
type: object
properties:
errors:
type: array
items:
type: object
properties:
code:
enum:
- 9011
description: Numeric value that defines the type of error that has occurred
type: integer
level:
enum:
- CRITICAL
description: 'Defines the severity of the errorNote: If level is `CRITICAL` then a successful response will not be returned'
x-deprecated: true
type: string
description:
type: string
description: Briefly describes the type of error that has occured
examples:
- Rate limit has been exceeded - Please try again shortly
required:
- code
- description
headers:
Content-Type:
schema:
type: string
enum:
- application/json
description: Media type of the resource
X-Transaction-Id:
schema:
type: string
example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9
description: Should be quoted as a reference for any support request/unexpected error
'500':
description: '
> #### Internal Server Error (500)
Refer to [Status Codes & Error Handling](https://developer.proptrack.com.au/docs/apis/error-handling#listingslistingid) for information on error handling.'
headers:
Content-Type:
schema:
type: string
enum:
- application/json
description: Media type of the resource
X-Transaction-Id:
schema:
type: string
example: bxxe12cb-a6a8-4cad-9a8c-4f1d8abfa0d9
description: Should be quoted as a reference for any support request/unexpected error
servers:
- url: https://data.proptrack.com
tags:
- Listing by listingId