DOdomain
Properties

Property ID

Changed on

A propertyId is a Domain specific ID of particular property, usually in the form of an alphanumeric code: RF-8884-AK.

get/v1/properties/{id}

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_properties_read
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Response

Success

onMarketTypesstring[] nullable
status'OffMarket' | 'OnMarket'
addressstring
addressIdinteger
bathroomsinteger nullable
bedroomsinteger nullable
carSpacesinteger nullable
ensuitesinteger nullable
createdstring nullable
featuresstring[] nullable
flatNumberstring nullable
idstring nullable
internalAreastring nullable
yearBuiltnumber nullable
isResidentialboolean nullable
lotNumberstring nullable
planNumberstring nullable
postcodestring nullable
propertyCategorystring nullable
propertyTypestring nullable
statestring nullable
storeysinteger nullable
streetAddressstring nullable
streetNamestring nullable
streetNumberstring nullable
streetTypestring nullable
streetTypeLongstring nullable
suburbstring nullable
suburbIdinteger nullable
updatedstring date-time nullable
urlSlugstring nullable
urlSlugShortstring nullable
zonestring nullable
areaSizeinteger nullable
canonicalUrlstring nullable

Changes

  • ec196b46e439Revision changes
    • breaking

      the response's property type changed from string to integer for status

    • breaking

      the response's property format changed from date to date-time for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

  • 839de6c29cc3Revision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status