Pricefinder Properties API
The properties API from Pricefinder — 20 operation(s) for properties.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/pricefinder-properties-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Pricefinder Properties API
version: 1.13.1
contact:
name: Pricefinder
license:
name: Terms and Conditions
url: https://www.domain.com.au/group/api-terms-and-conditions/
description: 'Operations tagged properties across 2 of this provider''s published API definitions: pricefinder-api-swagger.json, pricefinder-api-swagger.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /v1
tags:
- name: properties
paths:
/properties/{propertyId}:
get:
tags:
- properties
description: ''
operationId: property
parameters:
- name: propertyId
in: path
required: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: integer
format: int64
responses:
'200':
description: successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Property'
servers:
- url: /v1
/properties/{propertyId}/autocma/rental/pdf:
get:
tags:
- properties
description: ''
operationId: rentalCmaPDF
parameters:
- name: propertyId
in: path
required: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: attach
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
- name: comparable_rentals
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
default: true
- name: cover_letter
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
default: false
- name: cover_page
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
default: true
- name: demographics
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
default: true
- name: maps
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
default: true
- name: property_report
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
default: true
- name: radius
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: integer
format: int64
default: 500
- name: stats
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
default: true
- name: summary
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
default: false
responses:
default:
description: successful operation
servers:
- url: /v1
/properties/{propertyId}/autocma/sale/pdf:
get:
tags:
- properties
description: ''
operationId: saleCmaPDF
parameters:
- name: propertyId
in: path
required: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: attach
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
- name: comparable_listings
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
default: true
- name: comparable_rentals
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
default: true
- name: comparable_sales
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
default: true
- name: cover_letter
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
default: false
- name: cover_page
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
default: true
- name: demographics
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
default: true
- name: maps
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
default: true
- name: property_report
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
default: true
- name: radius
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: integer
format: int64
default: 500
- name: stats
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
default: true
- name: summary
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
default: false
responses:
default:
description: successful operation
servers:
- url: /v1
/properties/{propertyId}/avm:
get:
tags:
- properties
description: ''
operationId: propertyAvm
parameters:
- name: propertyId
in: path
required: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: integer
format: int64
responses:
'200':
description: successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AVM'
servers:
- url: /v1
/properties/{propertyId}/avm/pdf:
get:
tags:
- properties
description: ''
operationId: propertyAvmReport
parameters:
- name: propertyId
in: path
required: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: attach
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
default: true
responses:
default:
description: successful operation
servers:
- url: /v1
/properties/{propertyId}/eventsubscription:
get:
tags:
- properties
description: ''
operationId: eventsSubscription
parameters:
- name: propertyId
in: path
required: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: integer
format: int64
responses:
'200':
description: successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/PropertyEventSubscription'
deprecated: true
post:
tags:
- properties
summary: ''
description: 'Subscribe to property event alerts (currently only available through email notifications) for this property.<br><b>Note: This endpoint is NOT additive</b> <br>i.e. Multiple calls to this endpoint on the same property will keep overwriting the subscription with the eventTypes passed in the latest request.<br><b>Example :</b> <br> <ul><li>Subscribe to property X for ''ForSale'' event</li><li>Subscribe to property X for ''ForRent'' event</li><li>After these 2 calls X is only subscribed for ''ForRent''</li></ul>'
operationId: eventsSubscribe
parameters:
- name: propertyId
in: path
required: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: integer
format: int64
responses:
default:
description: successful operation
deprecated: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EventSubcriptionParameters'
description: The available eventTypes are <b>ForSale</b>, <b>ForRent</b> and <b>Sold</b>. They are case sensitive.
delete:
tags:
- properties
description: ''
operationId: eventsUnSubscribe
parameters:
- name: propertyId
in: path
required: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: integer
format: int64
responses:
default:
description: successful operation
deprecated: true
servers:
- url: /v1
/properties/{propertyId}/extended:
get:
tags:
- properties
description: ''
operationId: propertyExtended
parameters:
- name: propertyId
in: path
required: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: integer
format: int64
responses:
'200':
description: successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ExtendedProperty'
servers:
- url: /v1
/properties/{propertyId}/images:
get:
tags:
- properties
description: ''
operationId: images
parameters:
- name: propertyId
in: path
required: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: listingId
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: max
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: integer
format: int32
responses:
'200':
description: successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Images'
servers:
- url: /v1
/properties/{propertyId}/images/floorplans:
get:
tags:
- properties
description: ''
operationId: imagesFloorplan
parameters:
- name: propertyId
in: path
required: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: integer
format: int64
responses:
'200':
description: successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Images'
servers:
- url: /v1
/properties/{propertyId}/images/main:
get:
tags:
- properties
description: ''
operationId: imagesMain
parameters:
- name: propertyId
in: path
required: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: integer
format: int64
responses:
'200':
description: successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Image'
servers:
- url: /v1
/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.<br><b>Note:</b><br>Response headers return <ul><li>fsSchemeRes</li><li>fsImageId</li></ul> when operation returns <b>201</b><br>
operationId: streetView
parameters:
- name: propertyId
in: path
required: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: integer
format: int64
responses:
default:
description: successful operation
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/StreetViewParameters'
servers:
- url: /v1
/properties/{propertyId}/map:
get:
tags:
- properties
description: ''
operationId: map
parameters:
- name: propertyId
in: path
required: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: aerial
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
default: false
- name: area
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
default: false
- name: boundary
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
default: false
- name: dimensions
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
default: false
- name: easements
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
default: false
- name: height
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: integer
format: int64
default: 96
- name: legend
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
default: false
- name: property_boundary
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
default: true
- name: shading
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
default: false
- name: title
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
default: false
- name: width
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: integer
format: int64
default: 128
- name: zoom
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: string
enum:
- close
- medium
- far
default: medium
responses:
default:
description: successful operation
servers:
- url: /v1
/properties/{propertyId}/pdf:
get:
tags:
- properties
description: ''
operationId: propertyReport
parameters:
- name: propertyId
in: path
required: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: attach
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
default: true
responses:
default:
description: successful operation
servers:
- url: /v1
/properties/{propertyId}/radial/developmentapplications:
get:
tags:
- properties
description: ''
operationId: radialPlanningAlerts
parameters:
- name: propertyId
in: path
required: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: limit
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: integer
format: int64
default: 10
- name: radius
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: integer
format: int64
default: 2000
responses:
'200':
description: successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/DevelopmentApplications'
servers:
- url: /v1
/properties/{propertyId}/radial/listings:
get:
tags:
- properties
description: ''
operationId: radialListings
parameters:
- name: propertyId
in: path
required: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: area_gt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: area_lt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: baths_gt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: baths_lt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: beds_gt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: beds_lt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: car_parks_gt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: car_parks_lt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: date_end
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: string
format: date-time
default: now
- name: date_start
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: string
format: date-time
default: today-90d
- name: historic
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: boolean
default: false
- name: limit
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
default: 100
- name: matchlevel_max
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: string
enum:
- suburb
- street
- property
- name: matchlevel_min
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: string
enum:
- suburb
- street
- property
- name: max_area
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: max_baths
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: max_beds
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: max_car_parks
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: max_price
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: number
format: double
- name: min_area
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: min_baths
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: min_beds
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: min_car_parks
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: min_price
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: number
format: double
- name: price_gt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: number
format: double
- name: price_lt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: number
format: double
- name: property_type
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: string
enum:
- house
- unit
- vacant
- commercial
- industrial
- land
- rural
- retail
- office
- other
- name: radius
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: number
format: double
default: 500.0
- name: sort
in: query
description: can pass sort multiple times, use - to indicate descending
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
style: form
explode: true
schema:
type: array
format: -?\w+
items:
type: string
enum:
- distance
- -distance
- date
- -date
- price
- -price
responses:
'200':
description: successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Listings'
servers:
- url: /v1
/properties/{propertyId}/radial/properties:
get:
tags:
- properties
description: ''
operationId: radialProperties
parameters:
- name: propertyId
in: path
required: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: area_gt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: area_lt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: baths_gt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: baths_lt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: beds_gt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: beds_lt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: car_parks_gt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: car_parks_lt
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: true
schema:
type: integer
format: int64
- name: limit
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
default: 100
- name: max_area
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: max_baths
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: max_beds
in: query
required: false
pds:
hidden: false
extra: true
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- name: max_car_parks
in: query
required: false
pds:
hidden: false
extra: true
e
# --- truncated at 32 KB (78 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pricefinder/refs/heads/main/openapi/pricefinder-properties-api-openapi.yml