PropertyRadar

View Single Property in Portfolio - Detailed

Show market status and last listed information for a single property in a portfolio.

get/v1/propertyradar/portfolio/{PortfolioId}/properties/{PropertyId}

Request

Base URL
https://api.domain.com.au
Auth
- API key in header x-api-key
- or OAuth 2
  Authorization codehttps://auth.domain.com.au/v1/connect/authorize
  Client credentials
  Token URLhttps://auth.domain.com.au/v1/connect/token
  Scopesapi_propertyportfolio_read
TypeScript
https://skmtc.dev/domain/apis/domain-public-api/docs/v1/propertyradar/portfolio/:PortfolioId/properties/:PropertyId/get.ts
A function with typed inputs. Its response is checked against the schema.

PortfolioIdstring required

PropertyIdstring required

Property market status details

PropertyIdstring

MarketStatus'on-market' | 'off-market' | 'null' nullable

Whether the property is currently on the market. "null" = unknown

SaleRentFlag'sale' | 'rent' | 'null' nullable

if MarketStatus = "on-market", then whether the property is for sale or rent, otherwise "null"

LastListedDatestring date nullable

if MarketStatus = "on-market", then the date when the property was listed for sale or rent, otherwise "null"

{
  "PropertyId": "AB-2872-NY",
  "MarketStatus": "on-market",
  "SaleRentFlag": "sale",
  "LastListedDate": "2024-04-20"
}