Pricefinder Suburbs API
The suburbs API from Pricefinder — 15 operation(s) for suburbs.
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-suburbs-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
OpenAPI Specification
openapi: 3.2.0
info:
title: Pricefinder Suburbs 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 suburbs 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: suburbs
paths:
/suburbs/{suburbId}:
get:
tags:
- suburbs
description: Get the basic suburb information
operationId: suburb
parameters:
- name: suburbId
in: path
required: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: string
responses:
'200':
description: successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Suburb'
servers:
- url: /v1
/suburbs/{suburbId}/demographics:
get:
tags:
- suburbs
description: ''
operationId: demographics
parameters:
- name: suburbId
in: path
required: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: string
responses:
'200':
description: successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Demographics'
servers:
- url: /v1
/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
parameters:
- name: suburbId
in: path
required: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: string
responses:
'200':
description: successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/SuburbFlyover'
servers:
- url: /v1
/suburbs/{suburbId}/flyover/pdf:
get:
tags:
- suburbs
description: A suburb flyover in a pdf report
operationId: flyoverReport
parameters:
- name: suburbId
in: path
required: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: string
- name: attach
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: boolean
default: true
- name: property_type
in: query
required: false
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: string
enum:
- house
- unit
default: House
responses:
default:
description: successful operation
servers:
- url: /v1
/suburbs/{suburbId}/listings:
get:
tags:
- suburbs
description: ''
operationId: listings
parameters:
- name: suburbId
in: path
required: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: string
- 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: 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:
- date
- -date
- price
- -price
responses:
'200':
description: successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Listings'
servers:
- url: /v1
/suburbs/{suburbId}/properties:
get:
tags:
- suburbs
description: ''
operationId: properties
parameters:
- name: suburbId
in: path
required: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: string
- 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
enumerate: false
deprecated: false
schema:
type: integer
format: int64
- 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: 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
responses:
'200':
description: successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Properties'
servers:
- url: /v1
/suburbs/{suburbId}/rentals:
get:
tags:
- suburbs
description: ''
operationId: rentals
parameters:
- name: suburbId
in: path
required: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: string
- 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: 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:
- date
- -date
- price
- -price
responses:
'200':
description: successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Listings'
servers:
- url: /v1
/suburbs/{suburbId}/sales:
get:
tags:
- suburbs
description: ''
operationId: sales
parameters:
- name: suburbId
in: path
required: true
pds:
hidden: false
extra: false
enumerate: false
deprecated: false
schema:
type: string
- 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-6m
- 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: 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:
- date
- -date
- price
- -price
responses:
'200':
description: successful operation
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Sales'
servers:
- url: /v1
/suburbs/{suburbId}/stats/peaksellingperiods/{propertyType}:
get:
tags:
- suburbs
description: ''
operationId: peakSellingPeriods
parameters:
- name: propertyType
in: path
# --- truncated at 32 KB (68 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pricefinder/refs/heads/main/openapi/pricefinder-suburbs-api-openapi.yml