DOdomain
SalesResults

Get weekly results details

Changed on
get/v1/salesResults/{city}/listings

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_salesresults_read

Path parameters

citystring required

City. Supported cities are: Sydney, Melbourne, Brisbane, Adelaide, Canberra

Response

Success. Retrieves listing events collection for last Saturday

unitNumberstring nullable
streetNumberstring nullable
streetNamestring nullable
streetTypestring nullable
suburbstring nullable
postcodestring nullable
statestring nullable
geoLocationobject nullable
propertyTypestring nullable
bedroomsnumber nullable
bathroomsnumber nullable
carspacesnumber nullable
pricenumber nullable
resultstring nullable
agentstring nullable
agencyNamestring nullable
agencyProfilePageUrlstring nullable
idnumber nullable
agencyIdnumber nullable
propertyDetailsUrlstring nullable

Changes

  • 7130302fb268Revision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the / response's property type changed from integer to number, and format from int32 to no format for status

    • breaking

      the / response's property type changed from integer to number, and format from int32 to no format for status

    • breaking

      the / response's property type changed from integer to number, and format from int32 to no format for status

    • breaking

      the / response's property format changed from float to no format for status

    • breaking

      the / response's property type changed from integer to number, and format from int32 to no format for status

    • breaking

      the / response's property type changed from integer to number, and format from int32 to no format for status

    • breaking

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

    • breaking

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

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status