v1
latestOpenAPI 3.0.42026-08-04108409993.8 KBProducts
Get updated pricing information for a hypothetical listing
post/v1/products/ratefornewsocialboost
Request body
agencyIdinteger required
Id of the agency for whom rates are to be calculated.
agentFirstNamestring required
The first name of the primary agent associated with the listing.
agentLastNamestring required
The last name of the primary agent associated with the listing
agentEmailstring required
The email of the primary agent associated with the listing.
suburbstring required
Suburb for which rates are to be calculated.
postcodestring required
Postcode for which rates are to be calculated.
statestring required
State for which rates are to be calculated
propertyType'Unknown' | 'AcreageSemiRural' | 'ApartmentUnitFlat' | 'Aquaculture' | 'BlockOfUnits' | 'Carspace' | 'DairyFarming' | 'DevelopmentSite' | 'Duplex' | 'Farm' | 'FishingForestry' | 'NewHomeDesigns' | 'House' | 'NewHouseLand' | 'IrrigationServices' | 'NewLand' | 'Livestock' | 'NewApartments' | 'Penthouse' | 'Retirement' | 'RetirementVillage' | 'Rural' | 'SemiDetached' | 'SpecialistFarm' | 'Studio' | 'Terrace' | 'Townhouse' | 'VacantLand' | 'Villa' | 'Cropping' | 'Viticulture' | 'MixedFarming' | 'Grazing' | 'Horticulture' | 'Equine' | 'Farmlet' | 'Orchard' | 'RuralLifestyle' required
The property type of the listing e.g. House
isRuralboolean required
Whether to return the normal or rural rates
listingType'Sale' | 'Rent' | 'None' required
Type of the listing whether sale or rent
pricenumber double required
The value of the listing
channel'Residential' | 'Commercial' | 'Business' required
The intended channel of the listing.
bookingStartDatestring date-time nullable
Date at which the booking will start. Defaults to today. Allows for returning future contracts/price changes.
Response
Pricing information for the given listing details
reason'BasedOnContract' | 'NoContractFound' | 'NoRateFound' | 'PropertyTypeExcluded' nullable
Gets or Sets Reason