"
operationId: "namesSales"
produces:
- "application/json"
parameters:
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "given_name"
in: "query"
required: false
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "match_method"
in: "query"
required: false
type: "string"
default: "startswith"
enum:
- "startswith"
- "exact"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "postcode"
in: "query"
required: false
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "property_id"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "state"
in: "query"
required: false
type: "string"
enum:
- "QLD"
- "NSW"
- "VIC"
- "WA"
- "NT"
- "ACT"
- "SA"
- "TAS"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "suburb_id"
in: "query"
required: false
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "surname"
in: "query"
required: false
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/NameSearchResults"
headers: {}
/postcodes/{postcode}/listings:
get:
tags:
- "postcodes"
description: ""
operationId: "listings"
produces:
- "application/json"
parameters:
- name: "postcode"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "date_end"
in: "query"
required: false
type: "string"
default: "now"
format: "date-time"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "date_start"
in: "query"
required: false
type: "string"
default: "today-90d"
format: "date-time"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "historic"
in: "query"
required: false
type: "boolean"
default: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "matchlevel_max"
in: "query"
required: false
type: "string"
enum:
- "suburb"
- "street"
- "property"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "matchlevel_min"
in: "query"
required: false
type: "string"
enum:
- "suburb"
- "street"
- "property"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_price"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_price"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "price_gt"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "price_lt"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "sort"
in: "query"
description: "can pass sort multiple times, use - to indicate descending"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
format: "-?\\w+"
enum:
- "date"
- "-date"
- "price"
- "-price"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Listings"
headers: {}
/postcodes/{postcode}/properties:
get:
tags:
- "postcodes"
description: ""
operationId: "properties"
produces:
- "application/json"
parameters:
- name: "postcode"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Properties"
headers: {}
/postcodes/{postcode}/rentals:
get:
tags:
- "postcodes"
description: ""
operationId: "rentals"
produces:
- "application/json"
parameters:
- name: "postcode"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "date_end"
in: "query"
required: false
type: "string"
default: "now"
format: "date-time"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "date_start"
in: "query"
required: false
type: "string"
default: "today-90d"
format: "date-time"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "historic"
in: "query"
required: false
type: "boolean"
default: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "matchlevel_max"
in: "query"
required: false
type: "string"
enum:
- "suburb"
- "street"
- "property"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "matchlevel_min"
in: "query"
required: false
type: "string"
enum:
- "suburb"
- "street"
- "property"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_price"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_price"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "price_gt"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "price_lt"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "sort"
in: "query"
description: "can pass sort multiple times, use - to indicate descending"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
format: "-?\\w+"
enum:
- "date"
- "-date"
- "price"
- "-price"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Listings"
headers: {}
/postcodes/{postcode}/sales:
get:
tags:
- "postcodes"
description: ""
operationId: "sales"
produces:
- "application/json"
parameters:
- name: "postcode"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "date_end"
in: "query"
required: false
type: "string"
default: "now"
format: "date-time"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "date_start"
in: "query"
required: false
type: "string"
default: "today-6m"
format: "date-time"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "matchlevel_max"
in: "query"
required: false
type: "string"
enum:
- "suburb"
- "street"
- "property"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "matchlevel_min"
in: "query"
required: false
type: "string"
enum:
- "suburb"
- "street"
- "property"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_price"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_price"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "price_gt"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "price_lt"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "sort"
in: "query"
description: "can pass sort multiple times, use - to indicate descending"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
format: "-?\\w+"
enum:
- "date"
- "-date"
- "price"
- "-price"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Sales"
headers: {}
/properties/{propertyId}:
get:
tags:
- "properties"
description: ""
operationId: "property"
produces:
- "application/json"
parameters:
- name: "propertyId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Property"
headers: {}
/properties/{propertyId}/autocma/rental/pdf:
get:
tags:
- "properties"
description: ""
operationId: "rentalCmaPDF"
produces:
- "application/pdf"
parameters:
- name: "propertyId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "attach"
in: "query"
required: false
type: "boolean"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "comparable_rentals"
in: "query"
required: false
type: "boolean"
default: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "cover_letter"
in: "query"
required: false
type: "boolean"
default: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "cover_page"
in: "query"
required: false
type: "boolean"
default: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "demographics"
in: "query"
required: false
type: "boolean"
default: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "maps"
in: "query"
required: false
type: "boolean"
default: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "property_report"
in: "query"
required: false
type: "boolean"
default: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "radius"
in: "query"
required: false
type: "integer"
default: 500
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "stats"
in: "query"
required: false
type: "boolean"
default: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "summary"
in: "query"
required: false
type: "boolean"
default: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
default:
description: "successful operation"
/properties/{propertyId}/autocma/sale/pdf:
get:
tags:
- "properties"
description: ""
operationId: "saleCmaPDF"
produces:
- "application/pdf"
parameters:
- name: "propertyId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "attach"
in: "query"
required: false
type: "boolean"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "comparable_listings"
in: "query"
required: false
type: "boolean"
default: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "comparable_rentals"
in: "query"
required: false
type: "boolean"
default: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "comparable_sales"
in: "query"
required: false
type: "boolean"
default: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "cover_letter"
in: "query"
required: false
type: "boolean"
default: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "cover_page"
in: "query"
required: false
type: "boolean"
default: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "demographics"
in: "query"
required: false
type: "boolean"
default: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "maps"
in: "query"
required: false
type: "boolean"
default: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "property_report"
in: "query"
required: false
type: "boolean"
default: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "radius"
in: "query"
required: false
type: "integer"
default: 500
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "stats"
in: "query"
required: false
type: "boolean"
default: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "summary"
in: "query"
required: false
type: "boolean"
default: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
default:
description: "successful operation"
/properties/{propertyId}/avm:
get:
tags:
- "properties"
description: ""
operationId: "propertyAvm"
produces:
- "application/json"
parameters:
- name: "propertyId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/AVM"
headers: {}
/properties/{propertyId}/avm/pdf:
get:
tags:
- "properties"
description: ""
operationId: "propertyAvmReport"
produces:
- "application/pdf"
parameters:
- name: "propertyId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "attach"
in: "query"
required: false
type: "boolean"
default: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
default:
description: "successful operation"
/properties/{propertyId}/eventsubscription:
get:
tags:
- "properties"
description: ""
operationId: "eventsSubscription"
produces:
- "application/json"
parameters:
- name: "propertyId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/PropertyEventSubscription"
headers: {}
deprecated: true
post:
tags:
- "properties"
summary: ""
description: "Subscribe to property event alerts (currently only available through\
\ email notifications) for this property.
Note: This endpoint is NOT\
\ additive
i.e. Multiple calls to this endpoint on the same property\
\ will keep overwriting the subscription with the eventTypes passed in the\
\ latest request.
Example :
- Subscribe to property X\
\ for 'ForSale' event
- Subscribe to property X for 'ForRent' event
- After\
\ these 2 calls X is only subscribed for 'ForRent'
"
operationId: "eventsSubscribe"
consumes:
- "application/json"
produces:
- "application/json"
- "application/json"
parameters:
- name: "propertyId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- in: "body"
name: "body"
description: "The available eventTypes are ForSale, ForRent\
\ and Sold. They are case sensitive."
required: false
schema:
$ref: "#/definitions/EventSubcriptionParameters"
responses:
default:
description: "successful operation"
deprecated: true
delete:
tags:
- "properties"
description: ""
operationId: "eventsUnSubscribe"
produces:
- "application/json"
parameters:
- name: "propertyId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
default:
description: "successful operation"
deprecated: true
/properties/{propertyId}/extended:
get:
tags:
- "properties"
description: ""
operationId: "propertyExtended"
produces:
- "application/json"
parameters:
- name: "propertyId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/ExtendedProperty"
headers: {}
/properties/{propertyId}/images:
get:
tags:
- "properties"
description: ""
operationId: "images"
produces:
- "application/json"
parameters:
- name: "propertyId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "listingId"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "max"
in: "query"
required: false
type: "integer"
format: "int32"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Images"
headers: {}
/properties/{propertyId}/images/floorplans:
get:
tags:
- "properties"
description: ""
operationId: "imagesFloorplan"
produces:
- "application/json"
parameters:
- name: "propertyId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Images"
headers: {}
/properties/{propertyId}/images/main:
get:
tags:
- "properties"
description: ""
operationId: "imagesMain"
produces:
- "application/json"
parameters:
- name: "propertyId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Image"
headers: {}
/properties/{propertyId}/images/streetview:
post:
tags:
- "properties"
summary: "Captures property street view and save as property main image"
description: "Captures Googgle StreetView image by longitude/latitude and sets\
\ the image as the property main image.
Note:
Response headers\
\ return when operation returns\
\ 201
"
operationId: "streetView"
consumes:
- "application/json"
produces:
- "application/json"
- "application/json"
parameters:
- name: "propertyId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- in: "body"
name: "body"
required: false
schema:
$ref: "#/definitions/StreetViewParameters"
responses:
default:
description: "successful operation"
/properties/{propertyId}/map:
get:
tags:
- "properties"
description: ""
operationId: "map"
produces:
- "image/jpeg"
parameters:
- name: "propertyId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "aerial"
in: "query"
required: false
type: "boolean"
default: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area"
in: "query"
required: false
type: "boolean"
default: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "boundary"
in: "query"
required: false
type: "boolean"
default: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "dimensions"
in: "query"
required: false
type: "boolean"
default: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "easements"
in: "query"
required: false
type: "boolean"
default: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "height"
in: "query"
required: false
type: "integer"
default: 96
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "legend"
in: "query"
required: false
type: "boolean"
default: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "property_boundary"
in: "query"
required: false
type: "boolean"
default: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "shading"
in: "query"
required: false
type: "boolean"
default: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "title"
in: "query"
required: false
type: "boolean"
default: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "width"
in: "query"
required: false
type: "integer"
default: 128
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "zoom"
in: "query"
required: false
type: "string"
default: "medium"
enum:
- "close"
- "medium"
- "far"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
default:
description: "successful operation"
/properties/{propertyId}/pdf:
get:
tags:
- "properties"
description: ""
operationId: "propertyReport"
produces:
- "application/pdf"
parameters:
- name: "propertyId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "attach"
in: "query"
required: false
type: "boolean"
default: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
default:
description: "successful operation"
/properties/{propertyId}/radial/developmentapplications:
get:
tags:
- "properties"
description: ""
operationId: "radialPlanningAlerts"
produces:
- "application/json"
parameters:
- name: "propertyId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "limit"
in: "query"
required: false
type: "integer"
default: 10
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "radius"
in: "query"
required: false
type: "integer"
default: 2000
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/DevelopmentApplications"
headers: {}
/properties/{propertyId}/radial/listings:
get:
tags:
- "properties"
description: ""
operationId: "radialListings"
produces:
- "application/json"
parameters:
- name: "propertyId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "date_end"
in: "query"
required: false
type: "string"
default: "now"
format: "date-time"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "date_start"
in: "query"
required: false
type: "string"
default: "today-90d"
format: "date-time"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "historic"
in: "query"
required: false
type: "boolean"
default: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "matchlevel_max"
in: "query"
required: false
type: "string"
enum:
- "suburb"
- "street"
- "property"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "matchlevel_min"
in: "query"
required: false
type: "string"
enum:
- "suburb"
- "street"
- "property"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_price"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_price"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "price_gt"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "price_lt"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "radius"
in: "query"
required: false
type: "number"
default: 500.0
format: "double"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "sort"
in: "query"
description: "can pass sort multiple times, use - to indicate descending"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
format: "-?\\w+"
enum:
- "distance"
- "-distance"
- "date"
- "-date"
- "price"
- "-price"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Listings"
headers: {}
/properties/{propertyId}/radial/properties:
get:
tags:
- "properties"
description: ""
operationId: "radialProperties"
produces:
- "application/json"
parameters:
- name: "propertyId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "radius"
in: "query"
required: false
type: "number"
default: 500.0
format: "double"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "sort"
in: "query"
description: "can pass sort multiple times, use - to indicate descending"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
format: "-?\\w+"
enum:
- "distance"
- "-distance"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Properties"
headers: {}
/properties/{propertyId}/radial/rentals:
get:
tags:
- "properties"
description: ""
operationId: "radialRentals"
produces:
- "application/json"
parameters:
- name: "propertyId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "date_end"
in: "query"
required: false
type: "string"
default: "now"
format: "date-time"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "date_start"
in: "query"
required: false
type: "string"
default: "today-90d"
format: "date-time"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "historic"
in: "query"
required: false
type: "boolean"
default: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "matchlevel_max"
in: "query"
required: false
type: "string"
enum:
- "suburb"
- "street"
- "property"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "matchlevel_min"
in: "query"
required: false
type: "string"
enum:
- "suburb"
- "street"
- "property"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_price"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_price"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "price_gt"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "price_lt"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "radius"
in: "query"
required: false
type: "number"
default: 500.0
format: "double"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "sort"
in: "query"
description: "can pass sort multiple times, use - to indicate descending"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
format: "-?\\w+"
enum:
- "distance"
- "-distance"
- "date"
- "-date"
- "price"
- "-price"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Listings"
headers: {}
/properties/{propertyId}/radial/sales:
get:
tags:
- "properties"
description: ""
operationId: "radialSales"
produces:
- "application/json"
parameters:
- name: "propertyId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "date_end"
in: "query"
required: false
type: "string"
default: "now"
format: "date-time"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "date_start"
in: "query"
required: false
type: "string"
default: "today-1y"
format: "date-time"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "matchlevel_max"
in: "query"
required: false
type: "string"
enum:
- "suburb"
- "street"
- "property"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "matchlevel_min"
in: "query"
required: false
type: "string"
enum:
- "suburb"
- "street"
- "property"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_price"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_price"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "price_gt"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "price_lt"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "radius"
in: "query"
required: false
type: "number"
default: 500.0
format: "double"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "sort"
in: "query"
description: "can pass sort multiple times, use - to indicate descending"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
format: "-?\\w+"
enum:
- "distance"
- "-distance"
- "date"
- "-date"
- "price"
- "-price"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Sales"
headers: {}
/properties/{propertyId}/schools:
get:
tags:
- "properties"
description: ""
operationId: "propertySchools"
produces:
- "application/json"
parameters:
- name: "propertyId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Schools"
headers: {}
/properties/{propertyId}/streetview:
get:
tags:
- "properties"
description: ""
operationId: "streetview"
produces:
- "application/json"
parameters:
- name: "propertyId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "height"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "width"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
default:
description: "successful operation"
/references/states/act/divisions/{division}/properties:
get:
tags:
- "references"
description: ""
operationId: "divisionProperties"
produces:
- "application/json"
parameters:
- name: "division"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/PropertyIdentifiers"
headers: {}
/references/states/act/divisions/{division}/sections/{section}/lots/{lot}/properties:
get:
tags:
- "references"
description: ""
operationId: "properties"
produces:
- "application/json"
parameters:
- name: "division"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "lot"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "section"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/PropertyIdentifiers"
headers: {}
/references/states/act/divisions/{division}/sections/{section}/properties:
get:
tags:
- "references"
description: ""
operationId: "properties"
produces:
- "application/json"
parameters:
- name: "division"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "section"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/PropertyIdentifiers"
headers: {}
/references/states/act/divisions/{planNumber}/lots/{lot}/properties:
get:
tags:
- "references"
description: ""
operationId: "properties"
produces:
- "application/json"
parameters:
- name: "lot"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "planNumber"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/PropertyIdentifiers"
headers: {}
/references/states/nsw/plans/{planType}/{planNumber}/lots/{lot}/properties:
get:
tags:
- "references"
description: ""
operationId: "properties"
produces:
- "application/json"
parameters:
- name: "lot"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "planNumber"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "planType"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/PropertyIdentifiers"
headers: {}
/references/states/nsw/plans/{planType}/{planNumber}/properties:
get:
tags:
- "references"
description: ""
operationId: "planProperties"
produces:
- "application/json"
parameters:
- name: "planNumber"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "planType"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/PropertyIdentifiers"
headers: {}
/references/states/nsw/plans/{planType}/{planNumber}/sections/{section}/lots/{lot}/properties:
get:
tags:
- "references"
description: ""
operationId: "properties"
produces:
- "application/json"
parameters:
- name: "lot"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "planNumber"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "planType"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "section"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/PropertyIdentifiers"
headers: {}
/references/states/nsw/plans/{planType}/{planNumber}/sections/{section}/properties:
get:
tags:
- "references"
description: ""
operationId: "properties"
produces:
- "application/json"
parameters:
- name: "planNumber"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "planType"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "section"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/PropertyIdentifiers"
headers: {}
/references/states/nt/plans/{planNumber}/lots/{lot}/properties:
get:
tags:
- "references"
description: ""
operationId: "properties"
produces:
- "application/json"
parameters:
- name: "lot"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "planNumber"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/PropertyIdentifiers"
headers: {}
/references/states/nt/plans/{planNumber}/properties:
get:
tags:
- "references"
description: ""
operationId: "planProperties"
produces:
- "application/json"
parameters:
- name: "planNumber"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/PropertyIdentifiers"
headers: {}
/references/states/qld/plans/{planType}/{planNumber}/lots/{lot}/properties:
get:
tags:
- "references"
description: ""
operationId: "properties"
produces:
- "application/json"
parameters:
- name: "lot"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "planNumber"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "planType"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/PropertyIdentifiers"
headers: {}
/references/states/qld/plans/{planType}/{planNumber}/properties:
get:
tags:
- "references"
description: ""
operationId: "planProperties"
produces:
- "application/json"
parameters:
- name: "planNumber"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "planType"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/PropertyIdentifiers"
headers: {}
/references/states/qld/titles/{propertyId}:
get:
tags:
- "references"
description: ""
operationId: "propertyTitle"
produces:
- "application/json"
parameters:
- name: "propertyId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/PropertyTitle"
headers: {}
/references/states/sa/plans/{planType}/{planNumber}/lots/{lot}/properties:
get:
tags:
- "references"
description: ""
operationId: "properties"
produces:
- "application/json"
parameters:
- name: "lot"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "planNumber"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "planType"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/PropertyIdentifiers"
headers: {}
/references/states/sa/plans/{planType}/{planNumber}/properties:
get:
tags:
- "references"
description: ""
operationId: "planProperties"
produces:
- "application/json"
parameters:
- name: "planNumber"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "planType"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/PropertyIdentifiers"
headers: {}
/references/states/tas/plans/{planNumber}/lots/{lot}/properties:
get:
tags:
- "references"
description: ""
operationId: "properties"
produces:
- "application/json"
parameters:
- name: "lot"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "planNumber"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/PropertyIdentifiers"
headers: {}
/references/states/tas/plans/{planNumber}/properties:
get:
tags:
- "references"
description: ""
operationId: "planProperties"
produces:
- "application/json"
parameters:
- name: "planNumber"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/PropertyIdentifiers"
headers: {}
/references/states/vic/plans/{planType}/{planNumber}/lots/{lot}/properties:
get:
tags:
- "references"
description: ""
operationId: "properties"
produces:
- "application/json"
parameters:
- name: "lot"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "planNumber"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "planType"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/PropertyIdentifiers"
headers: {}
/references/states/vic/plans/{planType}/{planNumber}/properties:
get:
tags:
- "references"
description: ""
operationId: "planProperties"
produces:
- "application/json"
parameters:
- name: "planNumber"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "planType"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/PropertyIdentifiers"
headers: {}
/references/states/vic/plans/{planType}/{planNumber}/sections/{section}/lots/{lot}/properties:
get:
tags:
- "references"
description: ""
operationId: "properties"
produces:
- "application/json"
parameters:
- name: "lot"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "planNumber"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "planType"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "section"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/PropertyIdentifiers"
headers: {}
/references/states/vic/plans/{planType}/{planNumber}/sections/{section}/properties:
get:
tags:
- "references"
description: ""
operationId: "properties"
produces:
- "application/json"
parameters:
- name: "planNumber"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "planType"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "section"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/PropertyIdentifiers"
headers: {}
/references/states/vic/volumes/{volume}/folios/{folio}/properties:
get:
tags:
- "references"
description: ""
operationId: "volumeFolioProperties"
produces:
- "application/json"
parameters:
- name: "folio"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "volume"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/PropertyIdentifiers"
headers: {}
/references/states/wa/plans/{planType}/{planNumber}/lots/{lot}/properties:
get:
tags:
- "references"
description: ""
operationId: "properties"
produces:
- "application/json"
parameters:
- name: "lot"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "planNumber"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "planType"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/PropertyIdentifiers"
headers: {}
/references/states/wa/plans/{planType}/{planNumber}/properties:
get:
tags:
- "references"
description: ""
operationId: "planProperties"
produces:
- "application/json"
parameters:
- name: "planNumber"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "planType"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/PropertyIdentifiers"
headers: {}
/references/states/wa/volumes/{volume}/folios/{folio}/properties:
get:
tags:
- "references"
description: ""
operationId: "volumeFolioProperties"
produces:
- "application/json"
parameters:
- name: "folio"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "volume"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/PropertyIdentifiers"
headers: {}
/rentals/{rentalId}:
get:
tags:
- "rentals"
description: ""
operationId: "rental"
produces:
- "application/json"
parameters:
- name: "rentalId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/ExtendedListing"
headers: {}
/sales/{saleId}:
get:
tags:
- "sales"
description: ""
operationId: "sale"
produces:
- "application/json"
parameters:
- name: "saleId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/ExtendedSale"
headers: {}
/spatial/listings:
get:
tags:
- "spatial"
description: ""
operationId: "listings"
produces:
- "application/json"
parameters:
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "date_end"
in: "query"
required: false
type: "string"
default: "now"
format: "date-time"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "date_start"
in: "query"
required: false
type: "string"
default: "today-90d"
format: "date-time"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "historic"
in: "query"
required: false
type: "boolean"
default: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "matchlevel_max"
in: "query"
required: false
type: "string"
enum:
- "suburb"
- "street"
- "property"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "matchlevel_min"
in: "query"
required: false
type: "string"
enum:
- "suburb"
- "street"
- "property"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_price"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_price"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "price_gt"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "price_lt"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "sort"
in: "query"
description: "can pass sort multiple times, use - to indicate descending"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
format: "-?\\w+"
enum:
- "date"
- "-date"
- "price"
- "-price"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "wkt"
in: "query"
required: false
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Listings"
headers: {}
/spatial/properties:
get:
tags:
- "spatial"
description: ""
operationId: "properties"
produces:
- "application/json"
parameters:
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "wkt"
in: "query"
required: false
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Properties"
headers: {}
/spatial/rentals:
get:
tags:
- "spatial"
description: ""
operationId: "rentals"
produces:
- "application/json"
parameters:
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "date_end"
in: "query"
required: false
type: "string"
default: "now"
format: "date-time"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "date_start"
in: "query"
required: false
type: "string"
default: "today-90d"
format: "date-time"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "historic"
in: "query"
required: false
type: "boolean"
default: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "matchlevel_max"
in: "query"
required: false
type: "string"
enum:
- "suburb"
- "street"
- "property"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "matchlevel_min"
in: "query"
required: false
type: "string"
enum:
- "suburb"
- "street"
- "property"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_price"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_price"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "price_gt"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "price_lt"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "sort"
in: "query"
description: "can pass sort multiple times, use - to indicate descending"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
format: "-?\\w+"
enum:
- "date"
- "-date"
- "price"
- "-price"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "wkt"
in: "query"
required: false
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Listings"
headers: {}
/spatial/sales:
get:
tags:
- "spatial"
description: ""
operationId: "sales"
produces:
- "application/json"
parameters:
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "date_end"
in: "query"
required: false
type: "string"
default: "now"
format: "date-time"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "date_start"
in: "query"
required: false
type: "string"
default: "today-1y"
format: "date-time"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "matchlevel_max"
in: "query"
required: false
type: "string"
enum:
- "suburb"
- "street"
- "property"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "matchlevel_min"
in: "query"
required: false
type: "string"
enum:
- "suburb"
- "street"
- "property"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_price"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_price"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "price_gt"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "price_lt"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "sort"
in: "query"
description: "can pass sort multiple times, use - to indicate descending"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
format: "-?\\w+"
enum:
- "date"
- "-date"
- "price"
- "-price"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "wkt"
in: "query"
required: false
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Sales"
headers: {}
/sso:
get:
tags:
- "sso"
description: ""
operationId: "home"
produces:
- "application/json"
parameters: []
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/SSOLink"
headers: {}
/sso/properties/{propertyId}:
get:
tags:
- "sso"
description: ""
operationId: "property"
produces:
- "application/json"
parameters:
- name: "propertyId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/SSOLink"
headers: {}
/sso/properties/{propertyId}/appraisals/rentalcma:
get:
tags:
- "sso"
description: ""
operationId: "appraisalsRentalCma"
produces:
- "application/json"
parameters:
- name: "propertyId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/SSOLink"
headers: {}
/sso/properties/{propertyId}/appraisals/salecma:
get:
tags:
- "sso"
description: ""
operationId: "appraisalsSaleCma"
produces:
- "application/json"
parameters:
- name: "propertyId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/SSOLink"
headers: {}
/sso/properties/{propertyId}/appraisals/soi:
get:
tags:
- "sso"
description: ""
operationId: "appraisalsSoi"
produces:
- "application/json"
parameters:
- name: "propertyId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/SSOLink"
headers: {}
/sso/properties/{propertyId}/cma:
get:
tags:
- "sso"
description: ""
operationId: "cma"
produces:
- "application/json"
parameters:
- name: "propertyId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/SSOLink"
headers: {}
deprecated: true
/sso/properties/{propertyId}/pricefinder:
get:
tags:
- "sso"
description: ""
operationId: "propertyPricefinder"
produces:
- "application/json"
parameters:
- name: "propertyId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/SSOLink"
headers: {}
/sso/properties/{propertyId}/radial/sales:
get:
tags:
- "sso"
description: ""
operationId: "radialSales"
produces:
- "application/json"
parameters:
- name: "propertyId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/SSOLink"
headers: {}
/sso/properties/{propertyId}/titles:
get:
tags:
- "sso"
description: ""
operationId: "titles"
produces:
- "application/json"
parameters:
- name: "propertyId"
in: "path"
required: true
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/SSOLink"
headers: {}
/streets/{streetId}/listings:
get:
tags:
- "streets"
description: ""
operationId: "streetListings"
produces:
- "application/json"
parameters:
- name: "streetId"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "date_end"
in: "query"
required: false
type: "string"
default: "now"
format: "date-time"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "date_start"
in: "query"
required: false
type: "string"
default: "today-1y"
format: "date-time"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "historic"
in: "query"
required: false
type: "boolean"
default: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "matchlevel_max"
in: "query"
required: false
type: "string"
enum:
- "suburb"
- "street"
- "property"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "matchlevel_min"
in: "query"
required: false
type: "string"
enum:
- "suburb"
- "street"
- "property"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_price"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_price"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "price_gt"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "price_lt"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "sort"
in: "query"
description: "can pass sort multiple times, use - to indicate descending"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
format: "-?\\w+"
enum:
- "date"
- "-date"
- "price"
- "-price"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "street_number_from"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "street_number_to"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Listings"
headers: {}
/streets/{streetId}/properties:
get:
tags:
- "streets"
description: ""
operationId: "streetProperties"
produces:
- "application/json"
parameters:
- name: "streetId"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "street_number_from"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "street_number_to"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Properties"
headers: {}
/streets/{streetId}/rentals:
get:
tags:
- "streets"
description: ""
operationId: "streetRentals"
produces:
- "application/json"
parameters:
- name: "streetId"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "date_end"
in: "query"
required: false
type: "string"
default: "now"
format: "date-time"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "date_start"
in: "query"
required: false
type: "string"
default: "today-1y"
format: "date-time"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "historic"
in: "query"
required: false
type: "boolean"
default: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "matchlevel_max"
in: "query"
required: false
type: "string"
enum:
- "suburb"
- "street"
- "property"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "matchlevel_min"
in: "query"
required: false
type: "string"
enum:
- "suburb"
- "street"
- "property"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_price"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_price"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "price_gt"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "price_lt"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "sort"
in: "query"
description: "can pass sort multiple times, use - to indicate descending"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
format: "-?\\w+"
enum:
- "date"
- "-date"
- "price"
- "-price"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "street_number_from"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "street_number_to"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Listings"
headers: {}
/streets/{streetId}/sales:
get:
tags:
- "streets"
description: ""
operationId: "streetSales"
produces:
- "application/json"
parameters:
- name: "streetId"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "date_end"
in: "query"
required: false
type: "string"
default: "now"
format: "date-time"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "date_start"
in: "query"
required: false
type: "string"
default: "today-10y"
format: "date-time"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "matchlevel_max"
in: "query"
required: false
type: "string"
enum:
- "suburb"
- "street"
- "property"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "matchlevel_min"
in: "query"
required: false
type: "string"
enum:
- "suburb"
- "street"
- "property"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_price"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_price"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "price_gt"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "price_lt"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "sort"
in: "query"
description: "can pass sort multiple times, use - to indicate descending"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
format: "-?\\w+"
enum:
- "date"
- "-date"
- "price"
- "-price"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "street_number_from"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "street_number_to"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Sales"
headers: {}
/stubs/{language}:
get:
tags:
- "stubs"
summary: "Generates a client library"
description: "Accepts a language and returns a set of stubs. Pricefinder is\
\ unable to provide support for this endpoint, it is provided as a convenience.\
\ There is no guarantee of backwards compatibility for this method."
operationId: "generateStub"
produces:
- "application/zip"
- "application/zip"
parameters:
- name: "language"
in: "path"
description: "The target language for the client library"
required: true
type: "string"
enum:
- "android"
- "async-scala"
- "bash"
- "cwiki"
- "csharp"
- "cpprest"
- "dart"
- "elixir"
- "flash"
- "go"
- "groovy"
- "java"
- "jaxrs-cxf-client"
- "javascript"
- "javascript-closure-angular"
- "jmeter"
- "objc"
- "perl"
- "php"
- "python"
- "qt5cpp"
- "ruby"
- "scala"
- "dynamic-html"
- "html"
- "html2"
- "swagger"
- "swagger-yaml"
- "swift"
- "swift3"
- "tizen"
- "typescript-angular2"
- "typescript-angular"
- "typescript-node"
- "typescript-fetch"
- "akka-scala"
- "CsharpDotNet2"
- "clojure"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
default:
description: "successful operation"
/suburbs/{suburbId}:
get:
tags:
- "suburbs"
description: "Get the basic suburb information"
operationId: "suburb"
produces:
- "application/json"
parameters:
- name: "suburbId"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Suburb"
headers: {}
/suburbs/{suburbId}/demographics:
get:
tags:
- "suburbs"
description: ""
operationId: "demographics"
produces:
- "application/json"
parameters:
- name: "suburbId"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Demographics"
headers: {}
/suburbs/{suburbId}/flyover:
get:
tags:
- "suburbs"
description: "Generate a 'flyover' of the suburb. A flyover is a summary of\
\ the recent sales and rental activity."
operationId: "flyover"
produces:
- "application/json"
parameters:
- name: "suburbId"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/SuburbFlyover"
headers: {}
/suburbs/{suburbId}/flyover/pdf:
get:
tags:
- "suburbs"
description: "A suburb flyover in a pdf report"
operationId: "flyoverReport"
produces:
- "application/pdf"
parameters:
- name: "suburbId"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "attach"
in: "query"
required: false
type: "boolean"
default: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "property_type"
in: "query"
required: false
type: "string"
default: "House"
enum:
- "house"
- "unit"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
default:
description: "successful operation"
/suburbs/{suburbId}/listings:
get:
tags:
- "suburbs"
description: ""
operationId: "listings"
produces:
- "application/json"
parameters:
- name: "suburbId"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "date_end"
in: "query"
required: false
type: "string"
default: "now"
format: "date-time"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "date_start"
in: "query"
required: false
type: "string"
default: "today-90d"
format: "date-time"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "historic"
in: "query"
required: false
type: "boolean"
default: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "matchlevel_max"
in: "query"
required: false
type: "string"
enum:
- "suburb"
- "street"
- "property"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "matchlevel_min"
in: "query"
required: false
type: "string"
enum:
- "suburb"
- "street"
- "property"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_price"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_price"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "price_gt"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "price_lt"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "sort"
in: "query"
description: "can pass sort multiple times, use - to indicate descending"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
format: "-?\\w+"
enum:
- "date"
- "-date"
- "price"
- "-price"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Listings"
headers: {}
/suburbs/{suburbId}/properties:
get:
tags:
- "suburbs"
description: ""
operationId: "properties"
produces:
- "application/json"
parameters:
- name: "suburbId"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Properties"
headers: {}
/suburbs/{suburbId}/rentals:
get:
tags:
- "suburbs"
description: ""
operationId: "rentals"
produces:
- "application/json"
parameters:
- name: "suburbId"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "date_end"
in: "query"
required: false
type: "string"
default: "now"
format: "date-time"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "date_start"
in: "query"
required: false
type: "string"
default: "today-90d"
format: "date-time"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "historic"
in: "query"
required: false
type: "boolean"
default: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "matchlevel_max"
in: "query"
required: false
type: "string"
enum:
- "suburb"
- "street"
- "property"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "matchlevel_min"
in: "query"
required: false
type: "string"
enum:
- "suburb"
- "street"
- "property"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_price"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_price"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "price_gt"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "price_lt"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "sort"
in: "query"
description: "can pass sort multiple times, use - to indicate descending"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
format: "-?\\w+"
enum:
- "date"
- "-date"
- "price"
- "-price"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Listings"
headers: {}
/suburbs/{suburbId}/sales:
get:
tags:
- "suburbs"
description: ""
operationId: "sales"
produces:
- "application/json"
parameters:
- name: "suburbId"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "area_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "area_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "baths_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "beds_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_gt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "car_parks_lt"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "date_end"
in: "query"
required: false
type: "string"
default: "now"
format: "date-time"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "date_start"
in: "query"
required: false
type: "string"
default: "today-6m"
format: "date-time"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "limit"
in: "query"
required: false
type: "integer"
default: 100
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "matchlevel_max"
in: "query"
required: false
type: "string"
enum:
- "suburb"
- "street"
- "property"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "matchlevel_min"
in: "query"
required: false
type: "string"
enum:
- "suburb"
- "street"
- "property"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "max_price"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_area"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_baths"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_beds"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_car_parks"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "min_price"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "price_gt"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "price_lt"
in: "query"
required: false
type: "number"
format: "double"
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
- name: "property_type"
in: "query"
required: false
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "sort"
in: "query"
description: "can pass sort multiple times, use - to indicate descending"
required: false
type: "array"
items:
type: "string"
collectionFormat: "multi"
format: "-?\\w+"
enum:
- "date"
- "-date"
- "price"
- "-price"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Sales"
headers: {}
/suburbs/{suburbId}/stats/peaksellingperiods/{propertyType}:
get:
tags:
- "suburbs"
description: ""
operationId: "peakSellingPeriods"
produces:
- "application/json"
parameters:
- name: "propertyType"
in: "path"
required: true
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "suburbId"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "aggregation_period"
in: "query"
required: false
type: "string"
default: "year"
enum:
- "quarter"
- "halfyear"
- "year"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "month_end"
in: "query"
required: false
type: "string"
default: "december"
enum:
- "march"
- "june"
- "september"
- "december"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "number_of_years"
in: "query"
required: false
type: "integer"
default: 15
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "year_end"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/PeakSellingPeriods"
headers: {}
/suburbs/{suburbId}/stats/pricesegmentation/sales/{propertyType}:
get:
tags:
- "suburbs"
description: ""
operationId: "priceSegmentSales"
produces:
- "application/json"
parameters:
- name: "propertyType"
in: "path"
required: true
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "suburbId"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/PriceRangeSegments"
headers: {}
deprecated: true
/suburbs/{suburbId}/stats/timeseries/pricesegmentation/sales/{propertyType}:
get:
tags:
- "suburbs"
description: ""
operationId: "priceSegmentSales2"
produces:
- "application/json"
parameters:
- name: "propertyType"
in: "path"
required: true
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "suburbId"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "aggregation_period"
in: "query"
required: false
type: "string"
default: "year"
enum:
- "quarter"
- "halfyear"
- "year"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "month_end"
in: "query"
required: false
type: "string"
default: "december"
enum:
- "march"
- "june"
- "september"
- "december"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "number_of_years"
in: "query"
required: false
type: "integer"
default: 15
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "year_end"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/PriceRangeSegments2"
headers: {}
/suburbs/{suburbId}/stats/timeseries/rentals/{propertyType}:
get:
tags:
- "suburbs"
description: ""
operationId: "timeSeriesRentals"
produces:
- "application/json"
parameters:
- name: "propertyType"
in: "path"
required: true
type: "string"
enum:
- "house"
- "unit"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "suburbId"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "aggregation_period"
in: "query"
required: false
type: "string"
default: "quarter"
enum:
- "quarter"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "number_of_years"
in: "query"
required: false
type: "integer"
default: 15
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "year_end"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/RentalsTimeSeries2"
headers: {}
/suburbs/{suburbId}/stats/timeseries/sales/{propertyType}:
get:
tags:
- "suburbs"
description: ""
operationId: "timeSeriesSales"
produces:
- "application/json"
parameters:
- name: "propertyType"
in: "path"
required: true
type: "string"
enum:
- "house"
- "unit"
- "vacant"
- "commercial"
- "industrial"
- "land"
- "rural"
- "retail"
- "office"
- "other"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "suburbId"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "aggregation_period"
in: "query"
required: false
type: "string"
default: "year"
enum:
- "quarter"
- "halfyear"
- "year"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "month_end"
in: "query"
required: false
type: "string"
default: "december"
enum:
- "march"
- "june"
- "september"
- "december"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "number_of_years"
in: "query"
required: false
type: "integer"
default: 15
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "year_end"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "year_from"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: true
- name: "year_to"
in: "query"
required: false
type: "integer"
format: "int64"
pds:
hidden: false
extra: false
enumerate: false
deprecated: true
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/SalesTimeSeries"
headers: {}
/suburbs/{suburbId}/streets:
get:
tags:
- "suburbs"
description: ""
operationId: "streets"
produces:
- "application/json"
parameters:
- name: "suburbId"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Streets"
headers: {}
/suburbs/{suburbId}/summary:
get:
tags:
- "suburbs"
description: "Rolling year sales statistics summary (median etc.) for the current\
\ year;"
operationId: "summary"
produces:
- "application/json"
parameters:
- name: "suburbId"
in: "path"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/SuburbSummary"
headers: {}
/suggest:
get:
tags:
- "suggest"
description: ""
operationId: "suggest"
produces:
- "application/json"
parameters:
- name: "q"
in: "query"
description: "Address search query"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "currentState"
in: "query"
required: false
type: "string"
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
- name: "match_ids"
in: "query"
required: false
type: "boolean"
default: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/SuggestMatches"
headers: {}
/suggest/lonlat:
get:
tags:
- "suggest"
description: ""
operationId: "suggestLonLat"
produces:
- "application/json"
parameters:
- name: "q"
in: "query"
description: "Address search query in 'lon,lat,state' format e.g. (138.61838031759,-34.964546728687,SA)"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/SuggestLonLatResultPropertyByLonLat"
headers: {}
/suggest/properties:
get:
tags:
- "suggest"
description: "See suggestions"
operationId: "suggestProperties"
produces:
- "application/json"
parameters:
- name: "q"
in: "query"
description: "Address search query"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "match_ids"
in: "query"
required: false
type: "boolean"
default: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/SuggestMatches"
headers: {}
/suggest/streets:
get:
tags:
- "suggest"
description: "See suggestions"
operationId: "suggestStreets"
produces:
- "application/json"
parameters:
- name: "q"
in: "query"
description: "Address search query"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "match_ids"
in: "query"
required: false
type: "boolean"
default: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/SuggestMatches"
headers: {}
/suggest/suburbs:
get:
tags:
- "suggest"
description: "See suggestions"
operationId: "suggestSuburbs"
produces:
- "application/json"
parameters:
- name: "q"
in: "query"
description: "Address search query"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
- name: "match_ids"
in: "query"
required: false
type: "boolean"
default: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/SuggestMatches"
headers: {}
/suggest/typeahead:
get:
tags:
- "suggest"
description: ""
operationId: "suggestTypeahead"
produces:
- "application/json"
parameters:
- name: "q"
in: "query"
description: "Address search query"
required: true
type: "string"
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/TypeAheadSuggestions"
headers: {}
/oauth2/token:
post:
tags:
- "oauth2"
description: "Retrieve an oauth2 acces_token for use with Pricefinder API.\
\ A basic auth header is supported as an alternative to the form parameters\
\ for username and password.
After retrieving the token, it must be\
\ either added as an authorization header(eg Authorization: Bearer <token>)\
\ or appended to the query (eg ?access_token=<token>).
The api\
\ supports three 'flows' for retrieving a token; client_credentials, refresh_token\
\ and authorization_code
client_credentials
The client credentials\
\ flow requires the api user to pass their user name and password to retrieve\
\ the token.
code_authorization
The code authorization flow\
\ is used to authenticate on behalf of a another user.
To acquire authorization\
\ from a third party, direct that user to /v1/auth/authorize.html?client_id=<username>&state=<random_number>&redirect_uri=<callback_in_your_app>.\
\ Https is required.
The client_id is your username.
The state is a\
\ random string used to verify that the authorization request was generated\
\ by your webapp.
The redirect_uri is the callback uri after the third\
\ party has accepted or declined the authorization request.
eg https://api.pricefinder.com.au/v1/auth/authorize.html?client_id=username&state=123&redirect_uri=https%3A%2F%2Fyour.web.app%2Fsomepage
The\
\ third party will authenticate and authorize access to the api on their behalf.\
\ If the user allows access, the third party is redirected to your.web.app/somepage?state=<state>&code=<authorization_code>
eg https://your.web.app/somepage?state=123&code=9efc4ad1cca0bae6255ffd6db6cc85
(If\
\ the user declines, a callback is made with query parameter error=access_denied)
The\
\ api user can then retrieve an access token using this code from /v1/oauth2/token,\
\ using the 'authorization_code' grant type.
eg
curl -X POST --header \"Content-Type: application/x-www-form-urlencoded\"\
\ --header \"Accept: application/json\" -d \"grant_type=authorization_code&client_id=username&client_secret=password&code=9efc4ad1cca0bae6255ffd6db6cc85&redirect_uri=https%3A%2F%2Fyour.web.app%2Fsomepage\"\
\ \"https://api.pricefinder.com.au/v1/oauth2/token\"This will\
\ return an access token, as well as a refresh token, which can be used to\
\ acquire access tokens in the future without requiring the third party to\
\ reauthorize.
refresh_token
A refresh token can be used to\
\ acquire a new access token without requiring the third party to re authorize\
\ the user. This method consumes the refesh token and returns a new access\
\ token and a new refresh token.
Required Parameters:
- client_credentials\
\ => client_id, client_secret
- refresh_token => client_id, client_secret,\
\ refresh_token
- authorization_code => client_id, client_secret, redirect_uri,\
\ code
Simple OAuth2 Demonstration / test
Callback Example
"
operationId: "getToken"
consumes:
- "application/x-www-form-urlencoded"
produces:
- "application/json"
parameters:
- name: "grant_type"
in: "formData"
description: "OAuth 2 token grant flow type"
required: true
type: "string"
default: "client_credentials"
format: "string"
enum:
- "client_credentials"
- "refresh_token"
- "authorization_code"
- name: "client_id"
in: "formData"
description: "username"
required: true
type: "string"
format: "string"
- name: "client_secret"
in: "formData"
description: "password"
required: true
type: "string"
format: "password"
- name: "refresh_token"
in: "formData"
description: "Refresh token"
required: false
type: "string"
format: "string"
- name: "code"
in: "formData"
description: "code provided through callback"
required: false
type: "string"
format: "string"
- name: "redirect_uri"
in: "formData"
description: "URI that was used to generate code"
required: false
type: "string"
format: "string"
responses:
"200":
description: "Token created"
schema:
$ref: "#/definitions/ClientAccessToken"
headers: {}
"401":
description: "Invalid username/password"
headers: {}
"400":
description: "Bad Request"
headers: {}
security: []
definitions:
EventSubcriptionParameters:
type: "object"
properties:
eventTypes:
type: "array"
items:
type: "string"
enum:
- "ForRent"
- "ForSale"
- "SoldVerified"
- "Sold"
PropertyEventSubscription:
type: "object"
properties:
propertyId:
type: "integer"
format: "int64"
subscriptionDate:
type: "string"
format: "date-time"
eventTypes:
type: "array"
items:
$ref: "#/definitions/PropertyEventType"
PropertyEventType:
type: "object"
properties:
display:
type: "string"
key:
type: "string"
Error:
type: "object"
properties:
error:
type: "string"
Message:
type: "object"
properties:
code:
type: "integer"
format: "int64"
text:
type: "string"
Point:
type: "object"
properties:
lat:
type: "number"
format: "double"
lon:
type: "number"
format: "double"
PropertyIdentifier:
type: "object"
properties:
id:
type: "integer"
format: "int64"
matchlevel:
type: "string"
enum:
- "suburb"
- "street"
- "property"
location:
$ref: "#/definitions/Point"
parent:
type: "boolean"
_self:
type: "string"
PropertyIdentifiers:
type: "object"
properties:
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
properties:
type: "array"
items:
$ref: "#/definitions/PropertyIdentifier"
PropertyTitle:
type: "object"
properties:
propertyId:
type: "integer"
format: "int64"
titles:
type: "array"
items:
$ref: "#/definitions/Title"
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
Title:
type: "object"
SSOLink:
type: "object"
properties:
link:
type: "string"
School:
type: "object"
properties:
name:
type: "string"
type:
type: "string"
educationLevel:
type: "string"
lowYear:
type: "string"
highYear:
type: "string"
gender:
type: "string"
government:
type: "boolean"
primary:
type: "boolean"
secondary:
type: "boolean"
location:
$ref: "#/definitions/Point"
Schools:
type: "object"
properties:
schools:
type: "array"
items:
$ref: "#/definitions/School"
Pov:
type: "object"
properties:
zoom:
type: "number"
format: "double"
pitch:
type: "number"
format: "double"
heading:
type: "number"
format: "double"
StreetViewParameters:
type: "object"
properties:
lonlat:
$ref: "#/definitions/Point"
pov:
$ref: "#/definitions/Pov"
Address:
type: "object"
properties:
street:
type: "string"
unit:
type: "string"
level:
type: "string"
lot:
type: "string"
streetNumber:
type: "string"
streetAddress:
type: "string"
locality:
type: "string"
streetLocation:
type: "string"
state:
type: "string"
postcode:
type: "string"
countryCode:
type: "string"
streetName:
type: "string"
streetSuffix:
type: "string"
streetType:
type: "string"
lga:
type: "string"
Agency:
type: "object"
properties:
id:
type: "integer"
format: "int64"
name:
type: "string"
phoneNumber:
type: "string"
AgencyIdentifier:
type: "object"
properties:
id:
type: "integer"
format: "int64"
Agent:
type: "object"
properties:
name:
type: "string"
phoneNumber:
type: "string"
agency:
$ref: "#/definitions/AgencyIdentifier"
ExtendedPropertyFeatures:
type: "object"
properties:
bedrooms:
type: "integer"
format: "int64"
bathrooms:
type: "integer"
format: "int64"
carParks:
type: "integer"
format: "int64"
rumpusRoom:
type: "boolean"
airConditioning:
type: "boolean"
doubleStorey:
type: "boolean"
highSet:
type: "boolean"
multiLevel:
type: "boolean"
splitLevel:
type: "boolean"
brickTile:
type: "boolean"
contemporary:
type: "boolean"
postWar:
type: "boolean"
queenslander:
type: "boolean"
ensuite:
type: "boolean"
study:
type: "boolean"
verandah:
type: "boolean"
builtIn:
type: "boolean"
modernKitchen:
type: "boolean"
pool:
type: "boolean"
scenicViews:
type: "boolean"
waterFrontage:
type: "boolean"
closeSchools:
type: "boolean"
closeTransport:
type: "boolean"
lowSet:
type: "boolean"
colonial:
type: "boolean"
entertainmentArea:
type: "boolean"
sleepout:
type: "boolean"
boreWater:
type: "boolean"
dams:
type: "boolean"
fullyFenced:
type: "boolean"
otherFeatures:
type: "string"
sheds:
type: "boolean"
balcony:
type: "boolean"
mainRooms:
type: "integer"
format: "int64"
style:
type: "string"
buildYear:
type: "integer"
format: "int64"
buildType:
type: "string"
storeys:
type: "integer"
format: "int64"
roofStyle:
type: "string"
nathersRating:
type: "number"
format: "double"
ImageIdentifier:
type: "object"
properties:
id:
type: "integer"
format: "int64"
_self:
type: "string"
LandDetails:
type: "object"
properties:
propertyArea:
type: "number"
format: "double"
buildingArea:
type: "number"
format: "double"
volumeFolio:
type: "string"
Listing:
type: "object"
properties:
id:
type: "integer"
format: "int64"
rental:
type: "boolean"
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
agents:
type: "array"
items:
$ref: "#/definitions/Agent"
agencies:
type: "array"
items:
$ref: "#/definitions/Agency"
price:
$ref: "#/definitions/SensitivePrice"
listingHistory:
$ref: "#/definitions/ListingListingHistory"
startDate:
$ref: "#/definitions/SensitiveDate"
image:
$ref: "#/definitions/ImageIdentifier"
property:
$ref: "#/definitions/PropertyIdentifier"
street:
$ref: "#/definitions/StreetIdentifier"
suburb:
$ref: "#/definitions/SuburbIdentifier"
location:
$ref: "#/definitions/Point"
propertyLegalDescription:
type: "string"
propertyType:
type: "string"
type:
type: "string"
status:
$ref: "#/definitions/ListingStatus"
endDate:
$ref: "#/definitions/SensitiveDate"
lastModified:
$ref: "#/definitions/SensitiveDate"
propertyFeatures:
$ref: "#/definitions/ExtendedPropertyFeatures"
address:
$ref: "#/definitions/Address"
originalListingAddress:
$ref: "#/definitions/Address"
landDetails:
$ref: "#/definitions/LandDetails"
extra:
$ref: "#/definitions/SearchExtra"
_self:
type: "string"
ListingListingHistory:
type: "object"
properties:
originalPrice:
$ref: "#/definitions/SensitivePrice"
originalPricePercentChange:
$ref: "#/definitions/SensitiveChange"
daysOnMarket:
type: "integer"
format: "int64"
lowAskPrice:
type: "integer"
format: "int64"
highAskPrice:
type: "integer"
format: "int64"
ListingStatus:
type: "object"
properties:
historic:
type: "boolean"
underOffer:
type: "boolean"
listingStatus:
type: "string"
Listings:
type: "object"
properties:
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
listings:
type: "array"
items:
$ref: "#/definitions/Listing"
SearchExtra:
type: "object"
properties:
distance:
type: "number"
format: "double"
nameMatchType:
type: "string"
matchedName:
type: "string"
SensitiveChange:
type: "object"
properties:
display:
type: "string"
value:
type: "number"
format: "double"
rawValue:
type: "number"
format: "double"
SensitiveDate:
type: "object"
properties:
display:
type: "string"
value:
type: "string"
format: "date-time"
rawValue:
type: "string"
format: "date-time"
SensitivePrice:
type: "object"
properties:
display:
type: "string"
value:
type: "number"
format: "double"
rawValue:
type: "number"
format: "double"
withheld:
type: "boolean"
StreetIdentifier:
type: "object"
properties:
id:
type: "string"
SuburbIdentifier:
type: "object"
properties:
id:
type: "string"
_self:
type: "string"
AbstractIdentifier:
type: "object"
properties:
id:
type: "object"
_self:
type: "string"
ListingIdentifier:
type: "object"
properties:
id:
type: "integer"
format: "int64"
rental:
type: "boolean"
_self:
type: "string"
MarketStatus:
type: "object"
properties:
status:
type: "string"
recentlySold:
type: "boolean"
recentlyForSale:
type: "boolean"
recentlyForRent:
type: "boolean"
forSale:
type: "boolean"
forRent:
type: "boolean"
likelyToList:
type: "boolean"
lastMarketEvent:
$ref: "#/definitions/MarketStatusEventObject"
MarketStatusEvent:
type: "object"
properties:
type:
type: "string"
event:
$ref: "#/definitions/AbstractIdentifier"
MarketStatusEventObject:
type: "object"
properties:
type:
type: "string"
event:
type: "object"
OwnershipSummary:
type: "object"
properties:
names:
type: "string"
ownerOccupied:
type: "boolean"
ownerAddress:
type: "string"
Phone:
type: "object"
properties:
surname:
type: "string"
initials:
type: "string"
address:
$ref: "#/definitions/Address"
number:
type: "string"
doNotCall:
type: "boolean"
doNotCallWashDate:
type: "string"
format: "date-time"
Properties:
type: "object"
properties:
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
properties:
type: "array"
items:
$ref: "#/definitions/Property"
Property:
type: "object"
properties:
id:
type: "integer"
format: "int64"
matchlevel:
type: "string"
enum:
- "suburb"
- "street"
- "property"
location:
$ref: "#/definitions/Point"
parent:
type: "boolean"
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
address:
$ref: "#/definitions/Address"
features:
$ref: "#/definitions/ExtendedPropertyFeatures"
alternativeAddresses:
type: "array"
items:
$ref: "#/definitions/Address"
landDetails:
$ref: "#/definitions/LandDetails"
image:
$ref: "#/definitions/ImageIdentifier"
map:
$ref: "#/definitions/PropertyMapIdentifier"
street:
$ref: "#/definitions/StreetIdentifier"
suburb:
$ref: "#/definitions/SuburbIdentifier"
type:
type: "string"
rpd:
type: "string"
marketStatus:
$ref: "#/definitions/MarketStatus"
lastModified:
type: "string"
format: "date-time"
owners:
$ref: "#/definitions/OwnershipSummary"
ownership:
$ref: "#/definitions/OwnershipSummary"
lastSale:
$ref: "#/definitions/Sale"
recentListing:
$ref: "#/definitions/Listing"
recentRental:
$ref: "#/definitions/Listing"
extra:
$ref: "#/definitions/SearchExtra"
phoneNumbers:
type: "array"
items:
$ref: "#/definitions/Phone"
_self:
type: "string"
PropertyMapIdentifier:
type: "object"
properties:
id:
type: "integer"
format: "int64"
_self:
type: "string"
Sale:
type: "object"
properties:
id:
type: "integer"
format: "int64"
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
price:
$ref: "#/definitions/SensitivePrice"
listingHistory:
$ref: "#/definitions/SaleListingHistory"
saleDate:
$ref: "#/definitions/SensitiveDate"
settlementDate:
$ref: "#/definitions/SensitiveDate"
contractDate:
$ref: "#/definitions/SensitiveDate"
image:
$ref: "#/definitions/ImageIdentifier"
property:
$ref: "#/definitions/PropertyIdentifier"
street:
$ref: "#/definitions/StreetIdentifier"
suburb:
$ref: "#/definitions/SuburbIdentifier"
propertyType:
type: "string"
saleType:
type: "string"
agency:
$ref: "#/definitions/Agency"
agent:
$ref: "#/definitions/Agent"
location:
$ref: "#/definitions/Point"
metadata:
$ref: "#/definitions/SaleMetadata"
address:
$ref: "#/definitions/Address"
alternativeAddresses:
type: "array"
items:
$ref: "#/definitions/Address"
propertyFeatures:
$ref: "#/definitions/ExtendedPropertyFeatures"
landDetails:
$ref: "#/definitions/LandDetails"
rpd:
type: "string"
dealingNumber:
type: "string"
streetDisplay:
type: "string"
lowAskPrice:
type: "integer"
format: "int64"
highAskPrice:
type: "integer"
format: "int64"
extra:
$ref: "#/definitions/SearchExtra"
saleParticipants:
$ref: "#/definitions/SaleParticipantsSummary"
_self:
type: "string"
SaleListingHistory:
type: "object"
properties:
originalListingId:
$ref: "#/definitions/ListingIdentifier"
originalPrice:
$ref: "#/definitions/SensitivePrice"
originalPricePercentChange:
$ref: "#/definitions/SensitiveChange"
lastListingId:
$ref: "#/definitions/ListingIdentifier"
lastPrice:
$ref: "#/definitions/SensitivePrice"
lastPricePercentChange:
$ref: "#/definitions/SensitiveChange"
daysToSell:
type: "integer"
format: "int64"
SaleMetadata:
type: "object"
properties:
governmentSale:
type: "boolean"
pending:
type: "boolean"
SaleParticipantsSummary:
type: "object"
properties:
vendorsSummary:
type: "string"
purchasersSummary:
type: "string"
Image:
type: "object"
properties:
id:
type: "integer"
format: "int64"
date:
type: "string"
format: "date-time"
mainImage:
type: "boolean"
priority:
type: "integer"
format: "int32"
floorplan:
type: "boolean"
_self:
type: "string"
Images:
type: "object"
properties:
images:
type: "array"
items:
$ref: "#/definitions/Image"
DevelopmentApplication:
type: "object"
properties:
address:
$ref: "#/definitions/Address"
description:
type: "string"
infoUrl:
type: "string"
commentUrl:
type: "string"
location:
$ref: "#/definitions/Point"
dateReceived:
type: "string"
format: "date-time"
planningAuthority:
$ref: "#/definitions/PlanningAuthority"
councilReference:
type: "string"
DevelopmentApplications:
type: "object"
properties:
disclaimer:
type: "string"
note:
type: "string"
applications:
type: "array"
items:
$ref: "#/definitions/DevelopmentApplication"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
PlanningAuthority:
type: "object"
properties:
name:
type: "string"
ExtendedAddress:
type: "object"
properties:
street:
type: "string"
unit:
type: "string"
level:
type: "string"
lot:
type: "string"
streetNumber:
type: "string"
streetAddress:
type: "string"
locality:
type: "string"
streetLocation:
type: "string"
state:
type: "string"
postcode:
type: "string"
countryCode:
type: "string"
streetName:
type: "string"
streetSuffix:
type: "string"
streetType:
type: "string"
ruralAddress:
type: "string"
unitType:
type: "string"
unitNumber:
type: "string"
unitNumberInt:
type: "integer"
format: "int64"
unitNumberPrefix:
type: "string"
unitNumberSuffix:
type: "string"
levelType:
type: "string"
levelNumber:
type: "string"
levelNumberInt:
type: "integer"
format: "int64"
levelNumberPrefix:
type: "string"
levelNumberSuffix:
type: "string"
lotType:
type: "string"
lotNumber:
type: "string"
lotNumberInt:
type: "integer"
format: "int64"
lotNumberPrefix:
type: "string"
lotNumberSuffix:
type: "string"
numberFirst:
type: "string"
numberFirstInt:
type: "integer"
format: "int64"
numberFirstPrefix:
type: "string"
numberFirstSuffix:
type: "string"
numberLast:
type: "string"
numberLastInt:
type: "integer"
format: "int64"
numberLastPrefix:
type: "string"
numberLastSuffix:
type: "string"
localityType:
type: "string"
localityName:
type: "string"
careOfAddress:
type: "string"
other:
type: "string"
lga:
type: "string"
ExtendedLandDetails:
type: "object"
properties:
propertyArea:
type: "number"
format: "double"
buildingArea:
type: "number"
format: "double"
volumeFolio:
type: "string"
frontage:
type: "number"
format: "double"
parcels:
type: "array"
items:
$ref: "#/definitions/Parcel"
primaryLandUse:
$ref: "#/definitions/LandUse"
secondaryLandUse:
$ref: "#/definitions/LandUse"
ExtendedProperty:
type: "object"
properties:
id:
type: "integer"
format: "int64"
matchlevel:
type: "string"
enum:
- "suburb"
- "street"
- "property"
location:
$ref: "#/definitions/Point"
parent:
type: "boolean"
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
address:
$ref: "#/definitions/ExtendedAddress"
features:
$ref: "#/definitions/ExtendedPropertyFeatures"
alternativeAddresses:
type: "array"
items:
$ref: "#/definitions/ExtendedAddress"
landDetails:
$ref: "#/definitions/ExtendedLandDetails"
image:
$ref: "#/definitions/ImageIdentifier"
map:
$ref: "#/definitions/PropertyMapIdentifier"
street:
$ref: "#/definitions/StreetIdentifier"
suburb:
$ref: "#/definitions/SuburbIdentifier"
type:
type: "string"
rpd:
type: "string"
marketStatus:
$ref: "#/definitions/MarketStatus"
lastModified:
type: "string"
format: "date-time"
valuationDetails:
$ref: "#/definitions/ValuationDetails"
saleHistory:
$ref: "#/definitions/SaleHistory"
listingHistory:
$ref: "#/definitions/PropertyListingHistory"
rentalHistory:
$ref: "#/definitions/PropertyListingHistory"
ownership:
$ref: "#/definitions/Ownership"
phoneNumbers:
type: "array"
items:
$ref: "#/definitions/Phone"
tools:
$ref: "#/definitions/Tools"
tenureType:
type: "string"
_self:
type: "string"
LPI:
type: "object"
properties:
lot:
type: "string"
plan:
type: "string"
section:
type: "string"
part:
type: "string"
LandUse:
type: "object"
properties:
code:
type: "string"
display:
type: "string"
Owner:
type: "object"
properties:
firstName:
type: "string"
surname:
type: "string"
address:
$ref: "#/definitions/Address"
type:
type: "string"
Ownership:
type: "object"
properties:
names:
type: "string"
ownerOccupied:
type: "boolean"
ownerAddress:
type: "string"
owners:
type: "array"
items:
$ref: "#/definitions/Owner"
Parcel:
type: "object"
properties:
area:
type: "number"
format: "double"
zoning:
$ref: "#/definitions/Zoning"
lpi:
$ref: "#/definitions/LPI"
titles:
type: "array"
items:
$ref: "#/definitions/Title"
PropertyListingHistory:
type: "object"
properties:
listings:
type: "array"
items:
$ref: "#/definitions/Listing"
SaleHistory:
type: "object"
properties:
sales:
type: "array"
items:
$ref: "#/definitions/Sale"
SmartMaps:
type: "object"
Tools:
type: "object"
properties:
smartMaps:
$ref: "#/definitions/SmartMaps"
Valuation:
type: "object"
properties:
date:
type: "string"
format: "date-time"
effectiveDate:
type: "string"
format: "date-time"
method:
type: "string"
amount:
type: "number"
format: "double"
adjustedSiteValue:
type: "number"
format: "double"
ValuationDetails:
type: "object"
properties:
valuations:
type: "array"
items:
$ref: "#/definitions/Valuation"
Zoning:
type: "object"
properties:
description:
type: "string"
code:
type: "string"
AVM:
type: "object"
properties:
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
rentalYield:
type: "number"
format: "double"
rentalAVM:
$ref: "#/definitions/RentalAVM"
salesAVM:
$ref: "#/definitions/SalesAVM"
RentalAVM:
type: "object"
properties:
date:
type: "string"
format: "date-time"
pricePerWeek:
type: "number"
format: "double"
confidence:
type: "string"
enum:
- "RecentlySold"
- "VeryHigh"
- "High"
- "Medium"
- "Low"
- "VeryLow"
- "DoNotUse"
SalesAVM:
type: "object"
properties:
date:
type: "string"
format: "date-time"
price:
type: "number"
format: "double"
priceRangeMaximum:
type: "number"
format: "double"
priceRangeMinimum:
type: "number"
format: "double"
confidence:
type: "string"
enum:
- "RecentlySold"
- "VeryHigh"
- "High"
- "Medium"
- "Low"
- "VeryLow"
- "DoNotUse"
Sales:
type: "object"
properties:
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
sales:
type: "array"
items:
$ref: "#/definitions/Sale"
CensusTopic:
type: "object"
properties:
topic:
type: "string"
title:
type: "string"
total:
type: "integer"
format: "int64"
year:
type: "integer"
format: "int64"
data:
type: "array"
items:
$ref: "#/definitions/CensusValue"
CensusValue:
type: "object"
properties:
category:
type: "string"
count:
type: "integer"
format: "int64"
Demographics:
type: "object"
properties:
censusTopics:
type: "array"
items:
$ref: "#/definitions/CensusTopic"
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
Streets:
type: "object"
properties:
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
streets:
type: "array"
items:
$ref: "#/definitions/StreetIdentifier"
Suburb:
type: "object"
properties:
id:
type: "string"
suburbName:
type: "string"
postcode:
type: "integer"
format: "int64"
state:
type: "string"
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
_self:
type: "string"
Number:
type: "object"
PeakSellingPeriods:
type: "object"
properties:
calculated:
type: "string"
format: "date-time"
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
period:
$ref: "#/definitions/TimeSeriesPeriod"
values:
type: "array"
items:
$ref: "#/definitions/StatisticDouble"
PriceRangeSegment:
type: "object"
properties:
begin:
type: "number"
format: "double"
end:
type: "number"
format: "double"
label:
type: "string"
salesByMonth:
$ref: "#/definitions/YearByMonthStatisticsLong"
PriceRangeSegments:
type: "object"
properties:
calculated:
type: "string"
format: "date-time"
segments:
type: "array"
items:
$ref: "#/definitions/PriceRangeSegment"
period:
$ref: "#/definitions/TimeSeriesPeriod"
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
RentalTimeseriesValue:
type: "object"
properties:
count:
type: "integer"
format: "int64"
median:
type: "number"
format: "double"
high:
type: "number"
format: "double"
low:
type: "number"
format: "double"
RentalsTimeSeries:
type: "object"
properties:
period:
$ref: "#/definitions/TimeSeriesPeriod"
values:
type: "array"
items:
$ref: "#/definitions/RentalTimeseriesValue"
calculated:
type: "string"
format: "date-time"
description:
type: "string"
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
SalesTimeSeries:
type: "object"
properties:
period:
$ref: "#/definitions/TimeSeriesPeriod"
values:
type: "array"
items:
$ref: "#/definitions/SalesTimeSeriesValue"
calculated:
type: "string"
format: "date-time"
description:
type: "string"
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
SalesTimeSeriesValue:
type: "object"
properties:
count:
type: "integer"
format: "int64"
median:
type: "number"
format: "double"
high:
type: "number"
format: "double"
low:
type: "number"
format: "double"
mean:
type: "number"
format: "double"
total:
type: "number"
format: "double"
firstQuartile:
type: "number"
format: "double"
thirdQuartile:
type: "number"
format: "double"
iqRange:
type: "number"
format: "double"
medianGrowth:
type: "number"
format: "double"
Statistic:
type: "object"
properties:
label:
type: "string"
value:
$ref: "#/definitions/Number"
StatisticDouble:
type: "object"
properties:
label:
type: "string"
value:
type: "number"
format: "double"
StatisticLong:
type: "object"
properties:
label:
type: "string"
value:
type: "integer"
format: "int64"
StatisticNumber:
type: "object"
properties:
label:
type: "string"
value:
$ref: "#/definitions/Number"
StatisticsPropertyTypeWrapper:
type: "object"
properties:
house:
$ref: "#/definitions/SuburbStatistics"
unit:
$ref: "#/definitions/SuburbStatistics"
StatisticsWrapper:
type: "object"
properties:
propertyType:
$ref: "#/definitions/StatisticsPropertyTypeWrapper"
SuburbFlyover:
type: "object"
properties:
suburb:
$ref: "#/definitions/Suburb"
statistics:
$ref: "#/definitions/StatisticsWrapper"
demographics:
$ref: "#/definitions/Demographics"
recentSales:
$ref: "#/definitions/Sales"
recentRentals:
$ref: "#/definitions/Listings"
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
SuburbRentalsByBedroomStatistics:
type: "object"
properties:
one:
$ref: "#/definitions/SuburbRentalsTimeseriesWrapper"
two:
$ref: "#/definitions/SuburbRentalsTimeseriesWrapper"
three:
$ref: "#/definitions/SuburbRentalsTimeseriesWrapper"
threePlus:
$ref: "#/definitions/SuburbRentalsTimeseriesWrapper"
fourPlus:
$ref: "#/definitions/SuburbRentalsTimeseriesWrapper"
SuburbRentalsByBedroomStatisticsWrapper:
type: "object"
properties:
beds:
$ref: "#/definitions/SuburbRentalsByBedroomStatistics"
SuburbRentalsTimeseriesWrapper:
type: "object"
properties:
calendarQuarterly:
$ref: "#/definitions/RentalsTimeSeries"
SuburbSalesTimeseriesWrapper:
type: "object"
properties:
rolling12Month:
$ref: "#/definitions/SalesTimeSeries"
calendar12Month:
$ref: "#/definitions/SalesTimeSeries"
SuburbSalesWrapper:
type: "object"
properties:
timeseries:
$ref: "#/definitions/SuburbSalesTimeseriesWrapper"
priceRangeSegments:
$ref: "#/definitions/PriceRangeSegments"
peakSellingPeriods:
$ref: "#/definitions/PeakSellingPeriods"
SuburbStatistics:
type: "object"
properties:
statisticsSummary:
$ref: "#/definitions/SuburbStatisticsSummary"
sales:
$ref: "#/definitions/SuburbSalesWrapper"
rentals:
$ref: "#/definitions/SuburbRentalsByBedroomStatisticsWrapper"
SuburbStatisticsSummary:
type: "object"
properties:
calculated:
type: "string"
format: "date-time"
medianSalePrice:
type: "number"
format: "double"
medianRentalPrice:
type: "number"
format: "double"
suburbGrowth:
type: "number"
format: "double"
saleCount:
type: "integer"
format: "int64"
rentalCount:
type: "integer"
format: "int64"
suburbRentalYield:
type: "number"
format: "double"
TimeSeriesPeriod:
type: "object"
properties:
year:
type: "integer"
format: "int64"
month:
type: "integer"
format: "int64"
interval:
type: "integer"
format: "int64"
count:
type: "integer"
format: "int64"
YearByMonthStatistics:
type: "object"
properties:
calculated:
type: "string"
format: "date-time"
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
period:
$ref: "#/definitions/TimeSeriesPeriod"
values:
type: "array"
items:
$ref: "#/definitions/StatisticNumber"
YearByMonthStatisticsLong:
type: "object"
properties:
calculated:
type: "string"
format: "date-time"
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
period:
$ref: "#/definitions/TimeSeriesPeriod"
values:
type: "array"
items:
$ref: "#/definitions/StatisticLong"
PriceRangeSegment2:
type: "object"
properties:
begin:
type: "number"
format: "double"
end:
type: "number"
format: "double"
label:
type: "string"
count:
type: "integer"
format: "int64"
PriceRangeSegments2:
type: "object"
properties:
period:
$ref: "#/definitions/TimeSeriesPeriod"
values:
type: "array"
items:
type: "array"
items:
$ref: "#/definitions/PriceRangeSegment2"
calculated:
type: "string"
format: "date-time"
description:
type: "string"
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
RentalTimeSeriesValueGroup:
type: "object"
properties:
all:
$ref: "#/definitions/RentalTimeseriesValue"
"1":
$ref: "#/definitions/RentalTimeseriesValue"
"2":
$ref: "#/definitions/RentalTimeseriesValue"
"3":
$ref: "#/definitions/RentalTimeseriesValue"
"4+":
$ref: "#/definitions/RentalTimeseriesValue"
RentalsTimeSeries2:
type: "object"
properties:
period:
$ref: "#/definitions/TimeSeriesPeriod"
values:
type: "array"
items:
$ref: "#/definitions/RentalTimeSeriesValueGroup"
calculated:
type: "string"
format: "date-time"
description:
type: "string"
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
SuburbSummary:
type: "object"
properties:
suburb:
$ref: "#/definitions/Suburb"
house:
$ref: "#/definitions/SuburbStatisticsSummary"
unit:
$ref: "#/definitions/SuburbStatisticsSummary"
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
ExtendedSale:
type: "object"
properties:
id:
type: "integer"
format: "int64"
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
price:
$ref: "#/definitions/SensitivePrice"
listingHistory:
$ref: "#/definitions/SaleListingHistory"
saleDate:
$ref: "#/definitions/SensitiveDate"
settlementDate:
$ref: "#/definitions/SensitiveDate"
contractDate:
$ref: "#/definitions/SensitiveDate"
image:
$ref: "#/definitions/ImageIdentifier"
property:
$ref: "#/definitions/PropertyIdentifier"
street:
$ref: "#/definitions/StreetIdentifier"
suburb:
$ref: "#/definitions/SuburbIdentifier"
propertyType:
type: "string"
saleType:
type: "string"
agency:
$ref: "#/definitions/Agency"
agent:
$ref: "#/definitions/Agent"
location:
$ref: "#/definitions/Point"
metadata:
$ref: "#/definitions/SaleMetadata"
address:
$ref: "#/definitions/ExtendedAddress"
alternativeAddresses:
type: "array"
items:
$ref: "#/definitions/ExtendedAddress"
propertyFeatures:
$ref: "#/definitions/ExtendedPropertyFeatures"
landDetails:
$ref: "#/definitions/LandDetails"
rpd:
type: "string"
dealingNumber:
type: "string"
streetDisplay:
type: "string"
lowAskPrice:
type: "integer"
format: "int64"
highAskPrice:
type: "integer"
format: "int64"
saleParticipants:
$ref: "#/definitions/SaleParticipants"
saleMethod:
type: "string"
_self:
type: "string"
Purchaser:
type: "object"
properties:
firstName:
type: "string"
surname:
type: "string"
address:
$ref: "#/definitions/Address"
SaleParticipants:
type: "object"
properties:
vendorsSummary:
type: "string"
purchasersSummary:
type: "string"
vendors:
type: "array"
items:
$ref: "#/definitions/Vendor"
purchasers:
type: "array"
items:
$ref: "#/definitions/Purchaser"
Vendor:
type: "object"
properties:
firstName:
type: "string"
surname:
type: "string"
address:
$ref: "#/definitions/Address"
ExtendedListing:
type: "object"
properties:
id:
type: "integer"
format: "int64"
rental:
type: "boolean"
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
agents:
type: "array"
items:
$ref: "#/definitions/Agent"
agencies:
type: "array"
items:
$ref: "#/definitions/Agency"
price:
$ref: "#/definitions/SensitivePrice"
listingHistory:
$ref: "#/definitions/ListingListingHistory"
startDate:
$ref: "#/definitions/SensitiveDate"
image:
$ref: "#/definitions/ImageIdentifier"
property:
$ref: "#/definitions/PropertyIdentifier"
street:
$ref: "#/definitions/StreetIdentifier"
suburb:
$ref: "#/definitions/SuburbIdentifier"
location:
$ref: "#/definitions/Point"
propertyLegalDescription:
type: "string"
propertyType:
type: "string"
type:
type: "string"
status:
$ref: "#/definitions/ListingStatus"
endDate:
$ref: "#/definitions/SensitiveDate"
lastModified:
$ref: "#/definitions/SensitiveDate"
propertyFeatures:
$ref: "#/definitions/ExtendedPropertyFeatures"
address:
$ref: "#/definitions/ExtendedAddress"
originalListingAddress:
$ref: "#/definitions/ExtendedAddress"
landDetails:
$ref: "#/definitions/LandDetails"
portalUrl:
type: "string"
ListingStatus:
type: "string"
_self:
type: "string"
NameSearchResults:
type: "object"
properties:
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
sales:
type: "array"
items:
$ref: "#/definitions/Sale"
properties:
type: "array"
items:
$ref: "#/definitions/Property"
SuggestMatch:
type: "object"
properties:
property:
$ref: "#/definitions/PropertyIdentifier"
street:
$ref: "#/definitions/StreetIdentifier"
suburb:
$ref: "#/definitions/SuburbIdentifier"
type:
type: "string"
enum:
- "property"
- "street"
- "suburb"
- "typeahead"
display:
type: "string"
legalDescription:
type: "string"
address:
$ref: "#/definitions/Address"
alternativeAddresses:
type: "array"
items:
$ref: "#/definitions/Address"
SuggestMatches:
type: "object"
properties:
matches:
type: "array"
items:
$ref: "#/definitions/SuggestMatch"
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
LonLat:
type: "object"
properties:
lon:
type: "number"
format: "double"
lat:
type: "number"
format: "double"
LonLatElevation:
type: "object"
properties:
lonLat:
$ref: "#/definitions/LonLat"
elevation:
type: "number"
format: "double"
MainImage:
type: "object"
properties:
imageId:
type: "integer"
format: "int64"
imageScheme:
type: "string"
PropertyByLonLat:
type: "object"
properties:
propertyId:
type: "integer"
format: "int64"
legalDescription:
type: "string"
srcPropertyId:
type: "string"
srcAddressId:
type: "string"
zonings:
type: "string"
saleId:
type: "integer"
format: "int64"
source:
type: "string"
matchLevel:
type: "integer"
format: "int32"
centerPoint:
$ref: "#/definitions/LonLatElevation"
boundingBox:
$ref: "#/definitions/Rectangle"
streetLocation:
$ref: "#/definitions/StreetLocation"
buildingName:
type: "string"
streetDisplay:
type: "string"
altStreetDisplay:
type: "string"
propertyArea:
type: "number"
format: "double"
buildingArea:
type: "number"
format: "double"
saleAmount:
type: "number"
format: "double"
displayPrice:
type: "string"
saleDate:
type: "string"
governmentSale:
type: "boolean"
saleType:
type: "string"
marketStatus:
type: "string"
landUses:
type: "string"
beds:
type: "integer"
format: "int32"
baths:
type: "integer"
format: "int32"
cars:
type: "integer"
format: "int32"
mainImage:
$ref: "#/definitions/MainImage"
owners:
type: "string"
state:
type: "string"
propertyType:
type: "string"
Rectangle:
type: "object"
properties:
min:
$ref: "#/definitions/LonLat"
max:
$ref: "#/definitions/LonLat"
StreetLocation:
type: "object"
properties:
streetId:
type: "string"
fullCompleteAddress:
type: "string"
fullStreetName:
type: "string"
streetName:
type: "string"
streetAddress:
type: "string"
postcode:
type: "string"
localityId:
type: "string"
localityName:
type: "string"
lgaId:
type: "string"
lgaName:
type: "string"
state:
type: "string"
SuggestLonLatResult:
type: "object"
properties:
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
matchesCount:
type: "integer"
format: "int64"
latLon:
$ref: "#/definitions/Point"
matches:
type: "array"
items:
type: "object"
SuggestLonLatResultPropertyByLonLat:
type: "object"
properties:
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
matchesCount:
type: "integer"
format: "int64"
latLon:
$ref: "#/definitions/Point"
matches:
type: "array"
items:
$ref: "#/definitions/PropertyByLonLat"
TypeAheadSuggestion:
type: "object"
properties:
legacyPropertyId:
type: "integer"
format: "int32"
unitNumber:
type: "string"
streetNumber:
type: "string"
streetName:
type: "string"
streetType:
type: "string"
streetTypeLong:
type: "string"
suburb:
type: "string"
postcode:
type: "string"
state:
type: "string"
id:
type: "string"
urlSlug:
type: "string"
pdsId:
type: "integer"
format: "int64"
address:
type: "string"
relativeScore:
type: "integer"
format: "int32"
score:
type: "number"
format: "double"
additionalProperties:
type: "object"
additionalProperties:
type: "object"
TypeAheadSuggestions:
type: "object"
properties:
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
suggestions:
type: "array"
items:
$ref: "#/definitions/TypeAheadSuggestion"
EventParameters:
type: "object"
properties:
cmaId:
type: "integer"
format: "int64"
eventType:
type: "string"
eventDetails:
type: "object"
AppraisalAgentView:
type: "object"
properties:
id:
type: "integer"
format: "int64"
firstName:
type: "string"
lastName:
type: "string"
officeName:
type: "string"
email:
type: "string"
phone:
type: "string"
agentPhoto:
type: "string"
AppraisalCoverLetterView:
type: "object"
properties:
includeCoverLetter:
type: "boolean"
preparedFor:
type: "string"
agentsComments:
type: "string"
preparedBy:
type: "string"
AppraisalCoverPageView:
type: "object"
properties:
includeCoverPage:
type: "boolean"
coverPageImage:
type: "string"
AppraisalListingIdentifier:
type: "object"
properties:
id:
type: "integer"
format: "int64"
_self:
type: "string"
AppraisalMarketInsightsView:
type: "object"
properties:
includeMarketInsights:
type: "boolean"
AppraisalOfficeBrandingView:
type: "object"
properties:
backgroundMain:
type: "string"
backgroundSecondary:
type: "string"
textMain:
type: "string"
textSecondary:
type: "string"
headerColour:
type: "string"
AppraisalOfficeView:
type: "object"
properties:
id:
type: "integer"
format: "int64"
name:
type: "string"
officeName:
type: "string"
logo:
type: "string"
phoneNumber:
type: "string"
mobileNumber:
type: "string"
email:
type: "string"
branding:
$ref: "#/definitions/AppraisalOfficeBrandingView"
AppraisalPropertyBasicView:
type: "object"
properties:
includePropertyReport:
type: "boolean"
displayOwnerName:
type: "boolean"
displaySaleDetails:
type: "boolean"
_self:
type: "string"
propertyId:
type: "integer"
format: "int64"
AppraisalRentalIdentifier:
type: "object"
properties:
id:
type: "integer"
format: "int64"
_self:
type: "string"
AppraisalRentalsTimeSeriesBasicView:
type: "object"
properties:
includeTimeSeries:
type: "boolean"
identifier:
$ref: "#/definitions/SuburbIdentifier"
stats:
type: "object"
additionalProperties:
type: "string"
AppraisalSalesBasicView:
type: "object"
properties:
included:
type: "boolean"
refs:
type: "array"
items:
$ref: "#/definitions/AppraisalSalesBasicViewRef"
AppraisalSalesBasicViewRef:
type: "object"
properties:
ref:
$ref: "#/definitions/SaleIdentifier"
AppraisalSalesCMABasicOptions:
type: "object"
properties:
coverPage:
$ref: "#/definitions/AppraisalCoverPageView"
coverLetter:
$ref: "#/definitions/AppraisalCoverLetterView"
marketInsights:
$ref: "#/definitions/AppraisalMarketInsightsView"
maps:
$ref: "#/definitions/AppraisalsMapView"
estimate:
$ref: "#/definitions/AppraisalsEstimateView"
propertyReport:
$ref: "#/definitions/AppraisalPropertyBasicView"
schools:
$ref: "#/definitions/AppraisalsSchoolsBasicView"
suburbProfile:
$ref: "#/definitions/AppraisalsSuburbProfileBasicView"
salesStatistics:
$ref: "#/definitions/AppraisalsSalesTimeSeriesBasicView"
rentalStatistics:
$ref: "#/definitions/AppraisalRentalsTimeSeriesBasicView"
rentals:
$ref: "#/definitions/AppraisalsRentalsBasicView"
sales:
$ref: "#/definitions/AppraisalSalesBasicView"
listings:
$ref: "#/definitions/AppraisalsListingBasicView"
AppraisalsEstimateView:
type: "object"
properties:
includeSaleEstimate:
type: "boolean"
minSalePriceEstimate:
type: "number"
format: "double"
maxSalePriceEstimate:
type: "number"
format: "double"
includeRentEstimate:
type: "boolean"
minRentPriceEstimate:
type: "number"
format: "double"
maxRentPriceEstimate:
type: "number"
format: "double"
AppraisalsListingBasicView:
type: "object"
properties:
included:
type: "boolean"
refs:
type: "array"
items:
$ref: "#/definitions/AppraisalsListingBasicViewRef"
AppraisalsListingBasicViewRef:
type: "object"
properties:
ref:
$ref: "#/definitions/AppraisalListingIdentifier"
AppraisalsMapView:
type: "object"
properties:
includeComparablesMap:
type: "boolean"
AppraisalsRentalsBasicView:
type: "object"
properties:
included:
type: "boolean"
refs:
type: "array"
items:
$ref: "#/definitions/AppraisalsRentalsBasicViewRef"
AppraisalsRentalsBasicViewRef:
type: "object"
properties:
ref:
$ref: "#/definitions/AppraisalRentalIdentifier"
AppraisalsSalesTimeSeriesBasicView:
type: "object"
properties:
includeTimeSeries:
type: "boolean"
identifier:
$ref: "#/definitions/SuburbIdentifier"
stats:
type: "object"
additionalProperties:
type: "string"
AppraisalsSchoolsBasicView:
type: "object"
properties:
includeSchools:
type: "boolean"
_self:
type: "string"
propertyId:
type: "integer"
format: "int64"
AppraisalsSuburbProfileBasicView:
type: "object"
properties:
includeDemographics:
type: "boolean"
_self:
type: "string"
suburbId:
type: "string"
SaleIdentifier:
type: "object"
properties:
id:
type: "integer"
format: "int64"
_self:
type: "string"
SalesCMACommon:
type: "object"
properties:
id:
type: "integer"
format: "int64"
office:
$ref: "#/definitions/AppraisalOfficeView"
agent:
$ref: "#/definitions/AppraisalAgentView"
label:
type: "string"
generated:
type: "string"
format: "date-time"
modified:
type: "string"
format: "date-time"
active:
type: "boolean"
propertyId:
type: "integer"
format: "int64"
title:
type: "string"
type:
type: "string"
owners:
type: "string"
displayAddress:
type: "string"
propertyPhoto:
type: "string"
propertyMap:
type: "string"
reportStyleId:
type: "integer"
format: "int64"
shareId:
type: "string"
format: "uuid"
options:
$ref: "#/definitions/AppraisalSalesCMABasicOptions"
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
AppraisalSOICMABasicOptions:
type: "object"
properties:
coverPage:
$ref: "#/definitions/AppraisalCoverPageView"
estimate:
$ref: "#/definitions/AppraisalsEstimateView"
propertyReport:
$ref: "#/definitions/AppraisalPropertyBasicView"
salesStatistics:
$ref: "#/definitions/AppraisalsSalesTimeSeriesBasicView"
sales:
$ref: "#/definitions/AppraisalSalesBasicView"
SOICommon:
type: "object"
properties:
id:
type: "integer"
format: "int64"
office:
$ref: "#/definitions/AppraisalOfficeView"
agent:
$ref: "#/definitions/AppraisalAgentView"
label:
type: "string"
generated:
type: "string"
format: "date-time"
modified:
type: "string"
format: "date-time"
active:
type: "boolean"
propertyId:
type: "integer"
format: "int64"
title:
type: "string"
type:
type: "string"
owners:
type: "string"
displayAddress:
type: "string"
propertyPhoto:
type: "string"
propertyMap:
type: "string"
reportStyleId:
type: "integer"
format: "int64"
shareId:
type: "string"
format: "uuid"
options:
$ref: "#/definitions/AppraisalSOICMABasicOptions"
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
AppraisalPropertyView:
type: "object"
properties:
includePropertyReport:
type: "boolean"
displayOwnerName:
type: "boolean"
displaySaleDetails:
type: "boolean"
property:
$ref: "#/definitions/ExtendedProperty"
AppraisalRentalsCMAOptions:
type: "object"
properties:
coverPage:
$ref: "#/definitions/AppraisalCoverPageView"
coverLetter:
$ref: "#/definitions/AppraisalCoverLetterView"
marketInsights:
$ref: "#/definitions/AppraisalMarketInsightsView"
maps:
$ref: "#/definitions/AppraisalsMapView"
estimate:
$ref: "#/definitions/AppraisalsEstimateView"
propertyReport:
$ref: "#/definitions/AppraisalPropertyView"
schools:
$ref: "#/definitions/AppraisalsSchoolsView"
suburbProfile:
$ref: "#/definitions/AppraisalsSuburbProfileView"
rentalStatistics:
$ref: "#/definitions/AppraisalRentalsTimeSeriesView"
rentals:
$ref: "#/definitions/AppraisalsRentalsView"
AppraisalRentalsTimeSeriesView:
type: "object"
properties:
includeTimeSeries:
type: "boolean"
timeSeries:
type: "object"
additionalProperties:
$ref: "#/definitions/RentalsTimeSeries2"
AppraisalsRentalsView:
type: "object"
properties:
included:
type: "boolean"
items:
type: "array"
items:
$ref: "#/definitions/AppraisalsRentalsViewDetail"
AppraisalsRentalsViewDetail:
type: "object"
properties:
item:
$ref: "#/definitions/Listing"
AppraisalsSchoolsView:
type: "object"
properties:
includeSchools:
type: "boolean"
schools:
type: "array"
items:
$ref: "#/definitions/School"
AppraisalsSuburbProfileView:
type: "object"
properties:
includeDemographics:
type: "boolean"
demographics:
$ref: "#/definitions/Demographics"
RentalCMADetailed:
type: "object"
properties:
id:
type: "integer"
format: "int64"
office:
$ref: "#/definitions/AppraisalOfficeView"
agent:
$ref: "#/definitions/AppraisalAgentView"
label:
type: "string"
generated:
type: "string"
format: "date-time"
modified:
type: "string"
format: "date-time"
active:
type: "boolean"
propertyId:
type: "integer"
format: "int64"
title:
type: "string"
type:
type: "string"
owners:
type: "string"
displayAddress:
type: "string"
propertyPhoto:
type: "string"
propertyMap:
type: "string"
reportStyleId:
type: "integer"
format: "int64"
shareId:
type: "string"
format: "uuid"
options:
$ref: "#/definitions/AppraisalRentalsCMAOptions"
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
AppraisalSalesCMAOptions:
type: "object"
properties:
coverPage:
$ref: "#/definitions/AppraisalCoverPageView"
coverLetter:
$ref: "#/definitions/AppraisalCoverLetterView"
marketInsights:
$ref: "#/definitions/AppraisalMarketInsightsView"
maps:
$ref: "#/definitions/AppraisalsMapView"
estimate:
$ref: "#/definitions/AppraisalsEstimateView"
propertyReport:
$ref: "#/definitions/AppraisalPropertyView"
schools:
$ref: "#/definitions/AppraisalsSchoolsView"
suburbProfile:
$ref: "#/definitions/AppraisalsSuburbProfileView"
salesStatistics:
$ref: "#/definitions/AppraisalsSalesTimeSeriesView"
rentalStatistics:
$ref: "#/definitions/AppraisalRentalsTimeSeriesView"
rentals:
$ref: "#/definitions/AppraisalsRentalsView"
sales:
$ref: "#/definitions/AppraisalSalesView"
listings:
$ref: "#/definitions/AppraisalsListingsView"
AppraisalSalesView:
type: "object"
properties:
included:
type: "boolean"
items:
type: "array"
items:
$ref: "#/definitions/AppraisalSalesViewDetail"
AppraisalSalesViewDetail:
type: "object"
properties:
item:
$ref: "#/definitions/Sale"
AppraisalsListingsView:
type: "object"
properties:
included:
type: "boolean"
items:
type: "array"
items:
$ref: "#/definitions/AppraisalsListingsViewDetail"
AppraisalsListingsViewDetail:
type: "object"
properties:
item:
$ref: "#/definitions/Listing"
AppraisalsSalesTimeSeriesView:
type: "object"
properties:
includeTimeSeries:
type: "boolean"
timeSeries:
$ref: "#/definitions/SalesTimeSeries"
includePeakSellingPeriods:
type: "boolean"
peakSellingPeriods:
type: "array"
items:
$ref: "#/definitions/PeakSellingPeriods"
includePriceSegmentation:
type: "boolean"
priceSegmentation:
type: "array"
items:
$ref: "#/definitions/PriceRangeSegments2"
SalesCMADetailed:
type: "object"
properties:
id:
type: "integer"
format: "int64"
office:
$ref: "#/definitions/AppraisalOfficeView"
agent:
$ref: "#/definitions/AppraisalAgentView"
label:
type: "string"
generated:
type: "string"
format: "date-time"
modified:
type: "string"
format: "date-time"
active:
type: "boolean"
propertyId:
type: "integer"
format: "int64"
title:
type: "string"
type:
type: "string"
owners:
type: "string"
displayAddress:
type: "string"
propertyPhoto:
type: "string"
propertyMap:
type: "string"
reportStyleId:
type: "integer"
format: "int64"
shareId:
type: "string"
format: "uuid"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
options:
$ref: "#/definitions/AppraisalSalesCMAOptions"
disclaimer:
type: "string"
AppraisalSOICMAOptions:
type: "object"
properties:
coverPage:
$ref: "#/definitions/AppraisalCoverPageView"
coverLetter:
$ref: "#/definitions/AppraisalCoverLetterView"
marketInsights:
$ref: "#/definitions/AppraisalMarketInsightsView"
maps:
$ref: "#/definitions/AppraisalsMapView"
estimate:
$ref: "#/definitions/AppraisalsEstimateView"
propertyReport:
$ref: "#/definitions/AppraisalPropertyView"
salesStatistics:
$ref: "#/definitions/AppraisalsSalesTimeSeriesView"
sales:
$ref: "#/definitions/AppraisalSalesView"
SOIDetailed:
type: "object"
properties:
id:
type: "integer"
format: "int64"
office:
$ref: "#/definitions/AppraisalOfficeView"
agent:
$ref: "#/definitions/AppraisalAgentView"
label:
type: "string"
generated:
type: "string"
format: "date-time"
modified:
type: "string"
format: "date-time"
active:
type: "boolean"
propertyId:
type: "integer"
format: "int64"
title:
type: "string"
type:
type: "string"
owners:
type: "string"
displayAddress:
type: "string"
propertyPhoto:
type: "string"
propertyMap:
type: "string"
reportStyleId:
type: "integer"
format: "int64"
shareId:
type: "string"
format: "uuid"
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
options:
$ref: "#/definitions/AppraisalSOICMAOptions"
AppraisalRentalsCMABasicOptions:
type: "object"
properties:
coverPage:
$ref: "#/definitions/AppraisalCoverPageView"
coverLetter:
$ref: "#/definitions/AppraisalCoverLetterView"
marketInsights:
$ref: "#/definitions/AppraisalMarketInsightsView"
maps:
$ref: "#/definitions/AppraisalsMapView"
estimate:
$ref: "#/definitions/AppraisalsEstimateView"
propertyReport:
$ref: "#/definitions/AppraisalPropertyBasicView"
schools:
$ref: "#/definitions/AppraisalsSchoolsBasicView"
suburbProfile:
$ref: "#/definitions/AppraisalsSuburbProfileBasicView"
rentalStatistics:
$ref: "#/definitions/AppraisalRentalsTimeSeriesBasicView"
rentals:
$ref: "#/definitions/AppraisalsRentalsBasicView"
RentalCMACommon:
type: "object"
properties:
id:
type: "integer"
format: "int64"
office:
$ref: "#/definitions/AppraisalOfficeView"
agent:
$ref: "#/definitions/AppraisalAgentView"
label:
type: "string"
generated:
type: "string"
format: "date-time"
modified:
type: "string"
format: "date-time"
active:
type: "boolean"
propertyId:
type: "integer"
format: "int64"
title:
type: "string"
type:
type: "string"
owners:
type: "string"
displayAddress:
type: "string"
propertyPhoto:
type: "string"
propertyMap:
type: "string"
reportStyleId:
type: "integer"
format: "int64"
shareId:
type: "string"
format: "uuid"
options:
$ref: "#/definitions/AppraisalRentalsCMABasicOptions"
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
AppraisalSimpleView:
type: "object"
properties:
id:
type: "integer"
format: "int64"
userId:
type: "integer"
format: "int64"
agentId:
type: "integer"
format: "int64"
label:
type: "string"
generated:
type: "string"
format: "date-time"
modified:
type: "string"
format: "date-time"
active:
type: "boolean"
propertyId:
type: "integer"
format: "int64"
title:
type: "string"
type:
type: "string"
owners:
type: "string"
shareId:
type: "string"
format: "uuid"
Appraisals:
type: "object"
properties:
appraisals:
type: "array"
items:
$ref: "#/definitions/AppraisalSimpleView"
totalCount:
type: "integer"
format: "int64"
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
AppraisalInsightsSampleView:
type: "object"
properties:
userId:
type: "integer"
format: "int64"
agentId:
type: "integer"
format: "int64"
shareId:
type: "string"
format: "uuid"
active:
type: "boolean"
lastViewDate:
type: "string"
format: "date-time"
totalNumberOfShares:
type: "integer"
format: "int64"
totalNumberOfSessionViews:
type: "object"
additionalProperties:
type: "integer"
format: "int32"
AppraisalInsightsView:
type: "object"
properties:
insights:
type: "array"
items:
$ref: "#/definitions/AppraisalInsightsSampleView"
disclaimer:
type: "string"
messages:
type: "array"
items:
$ref: "#/definitions/Message"
ClassLoader:
type: "object"
properties:
parent:
$ref: "#/definitions/ClassLoader"
Enumeration:
type: "object"
EnumerationServlet:
type: "object"
EnumerationString:
type: "object"
FilterRegistration:
type: "object"
properties:
servletNameMappings:
type: "array"
items:
type: "string"
urlPatternMappings:
type: "array"
items:
type: "string"
initParameters:
type: "object"
additionalProperties:
type: "string"
name:
type: "string"
className:
type: "string"
JspConfigDescriptor:
type: "object"
properties:
jspPropertyGroups:
type: "array"
items:
$ref: "#/definitions/JspPropertyGroupDescriptor"
taglibs:
type: "array"
items:
$ref: "#/definitions/TaglibDescriptor"
JspPropertyGroupDescriptor:
type: "object"
properties:
urlPatterns:
type: "array"
items:
type: "string"
elIgnored:
type: "string"
pageEncoding:
type: "string"
scriptingInvalid:
type: "string"
isXml:
type: "string"
includePreludes:
type: "array"
items:
type: "string"
includeCodas:
type: "array"
items:
type: "string"
defaultContentType:
type: "string"
errorOnUndeclaredNamespace:
type: "string"
deferredSyntaxAllowedAsLiteral:
type: "string"
trimDirectiveWhitespaces:
type: "string"
buffer:
type: "string"
ServletContext:
type: "object"
properties:
initParameterNames:
$ref: "#/definitions/EnumerationString"
servletContextName:
type: "string"
servletRegistrations:
type: "object"
additionalProperties:
$ref: "#/definitions/ServletRegistration"
filterRegistrations:
type: "object"
additionalProperties:
$ref: "#/definitions/FilterRegistration"
sessionCookieConfig:
$ref: "#/definitions/SessionCookieConfig"
defaultSessionTrackingModes:
type: "array"
uniqueItems: true
items:
type: "string"
enum:
- "COOKIE"
- "URL"
- "SSL"
majorVersion:
type: "integer"
format: "int32"
minorVersion:
type: "integer"
format: "int32"
attributeNames:
$ref: "#/definitions/EnumerationString"
effectiveMajorVersion:
type: "integer"
format: "int32"
effectiveMinorVersion:
type: "integer"
format: "int32"
jspConfigDescriptor:
$ref: "#/definitions/JspConfigDescriptor"
servlets:
$ref: "#/definitions/EnumerationServlet"
servletNames:
$ref: "#/definitions/EnumerationString"
serverInfo:
type: "string"
contextPath:
type: "string"
effectiveSessionTrackingModes:
type: "array"
uniqueItems: true
items:
type: "string"
enum:
- "COOKIE"
- "URL"
- "SSL"
classLoader:
$ref: "#/definitions/ClassLoader"
ServletRegistration:
type: "object"
properties:
runAsRole:
type: "string"
mappings:
type: "array"
items:
type: "string"
initParameters:
type: "object"
additionalProperties:
type: "string"
name:
type: "string"
className:
type: "string"
SessionCookieConfig:
type: "object"
properties:
httpOnly:
type: "boolean"
maxAge:
type: "integer"
format: "int32"
comment:
type: "string"
domain:
type: "string"
path:
type: "string"
secure:
type: "boolean"
name:
type: "string"
TaglibDescriptor:
type: "object"
properties:
taglibLocation:
type: "string"
taglibURI:
type: "string"
ServletConfig:
type: "object"
properties:
initParameterNames:
$ref: "#/definitions/EnumerationString"
servletContext:
$ref: "#/definitions/ServletContext"
servletName:
type: "string"
Feature:
type: "object"
properties:
feature:
type: "string"
hasAccess:
type: "boolean"
UserFeatures:
type: "object"
properties:
userId:
type: "integer"
format: "int64"
features:
type: "array"
items:
$ref: "#/definitions/Feature"
ClientAccessToken:
type: "object"
properties:
access_token:
type: "string"
token_type:
type: "string"
expires_in:
type: "string"
refresh_token:
type: "string"