Piloterr Realestatecomau API
The Realestatecomau API from Piloterr — 1 operation(s) for realestatecomau.
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/piloterr-com:piloterr-com-realestatecomau-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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: Piloterr API Reference Realestatecomau API
description: Complete API reference documentation.
version: 1.0.0
servers:
- url: https://api.piloterr.com
description: API Server
tags:
- name: Realestatecomau
paths:
/v2/realestatecomau/search:
get:
summary: realestate.com.au Search
description: 'Search realestate.com.au buy, rent, or sold results. A place such as Sydney, NSW defaults to homes for sale. Each card has price, address, rooms, and a property URL.
**Credit cost:** 2 credits per call'
operationId: get-realestatecomau-search
security:
- ApiKeyAuth: []
parameters:
- name: query
in: query
required: true
description: "Place or a realestate.com.au results URL.\n\n**Example:**\n\n Sydney, NSW\n\n**JSON:** a place with the default channel buy sets results[].channel to buy and requests /buy/in-sydney,+nsw/list-1. A buy, rent, or sold results URL keeps its path. A property URL is rejected. Property lookup is not available."
schema:
type: string
description: "Place or a realestate.com.au results URL.\n\n**Example:**\n\n Sydney, NSW\n\n**JSON:** a place with the default channel buy sets results[].channel to buy and requests /buy/in-sydney,+nsw/list-1. A buy, rent, or sold results URL keeps its path. A property URL is rejected. Property lookup is not available."
- name: channel
in: query
required: false
description: 'buy, rent, or sold. Used when query is a place.
**Default:** buy. Empty also means buy.
**Aliases:** sale and for-sale mean buy. rental and lease mean rent.
**JSON:** sets results[].channel and the path (/buy/, /rent/, or /sold/). A results URL keeps its own path.'
schema:
type: string
description: 'buy, rent, or sold. Used when query is a place.
**Default:** buy. Empty also means buy.
**Aliases:** sale and for-sale mean buy. rental and lease mean rent.
**JSON:** sets results[].channel and the path (/buy/, /rent/, or /sold/). A results URL keeps its own path.'
- name: page
in: query
required: false
description: 'Page from 1.
**Default:** 1, which requests /list-1 and sets pagination.page to 1.
**JSON:** page 2 rewrites the path to /list-2. pagination.next is the next results URL, or null on the last page.'
schema:
type: number
default: '1'
description: 'Page from 1.
**Default:** 1, which requests /list-1 and sets pagination.page to 1.
**JSON:** page 2 rewrites the path to /list-2. pagination.next is the next results URL, or null on the last page.'
- name: return_page_source
in: query
required: false
description: 'Optional. Default false.
false returns the parsed JSON described below.
true returns {"result": "<page source>"} and omits results, pagination, and listing fields.'
schema:
type: boolean
description: 'Optional. Default false.
false returns the parsed JSON described below.
true returns {"result": "<page source>"} and omits results, pagination, and listing fields.'
default: false
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/is_async'
- $ref: '#/components/parameters/soft_fail'
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
results:
type: array
items:
type: object
properties:
id:
type: integer
url:
type: string
badge:
nullable: true
image:
type: string
price:
type: integer
state:
type: string
suburb:
type: string
address:
type: string
channel:
type: string
bedrooms:
type: integer
currency:
type: string
postcode:
type: string
bathrooms:
type: integer
price_max:
nullable: true
agent_name:
type: string
car_spaces:
type: integer
agency_name:
type: string
building_size:
type: integer
price_display:
type: string
property_type:
type: string
building_size_display:
type: string
pagination:
type: object
properties:
next:
type: string
page:
type: integer
per_page:
type: integer
total_pages:
type: integer
total_results:
type: integer
examples:
Sydney NSW homes for sale:
value:
results:
- id: 149690532
url: https://www.realestate.com.au/property-apartment-nsw-sydney-149690532
badge: null
image: https://i2.au.reastatic.net/800x600/0912e9a1bea76a94ba5a397b993767175e6714ec2a59081478ee67d3f622b4cb/image.jpg
price: 4000000
state: NSW
suburb: Sydney
address: Level 22/6 Watermans Quay, Sydney, NSW 2000
channel: buy
bedrooms: 2
currency: AUD
postcode: '2000'
bathrooms: 2
price_max: null
agent_name: Leanne Pan
car_spaces: 1
agency_name: Ray White Residential - Sydney CBD
building_size: 107
price_display: $4,000,000
property_type: Apartment
building_size_display: 107m²
pagination:
next: https://www.realestate.com.au/buy/in-sydney,+nsw/list-2
page: 1
per_page: 25
total_pages: 25
total_results: 604
'400':
description: Bad Request — missing or invalid parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Bad Request
'401':
description: Unauthorized — the API key is missing, invalid, inactive, or expired, or a rate limit was exceeded (`Rate limit exceeded…` message).
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
invalidKey:
value:
error: Invalid API Key
planRateLimit:
value:
error: 'Rate limit exceeded: You''ve exceeded the per second rate limit on your subscription'
keyQuota:
value:
error: 'Rate limit exceeded for the API key: quota monthly'
'402':
description: Payment Required — your subscription or credit balance is insufficient.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Payment required
'500':
description: Internal Server Error — something went wrong on our side.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Internal Error
tags:
- Realestatecomau
post:
summary: realestate.com.au Search
description: 'Search realestate.com.au buy, rent, or sold results. A place such as Sydney, NSW defaults to homes for sale. Each card has price, address, rooms, and a property URL.
**Credit cost:** 2 credits per call'
operationId: post-realestatecomau-search
security:
- ApiKeyAuth: []
parameters:
- $ref: '#/components/parameters/fields'
- $ref: '#/components/parameters/is_async'
- $ref: '#/components/parameters/soft_fail'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
query:
type: string
description: "Place or a realestate.com.au results URL.\n\n**Example:**\n\n Sydney, NSW\n\n**JSON:** a place with the default channel buy sets results[].channel to buy and requests /buy/in-sydney,+nsw/list-1. A buy, rent, or sold results URL keeps its path. A property URL is rejected. Property lookup is not available."
channel:
type: string
description: 'buy, rent, or sold. Used when query is a place.
**Default:** buy. Empty also means buy.
**Aliases:** sale and for-sale mean buy. rental and lease mean rent.
**JSON:** sets results[].channel and the path (/buy/, /rent/, or /sold/). A results URL keeps its own path.'
page:
type: number
default: '1'
description: 'Page from 1.
**Default:** 1, which requests /list-1 and sets pagination.page to 1.
**JSON:** page 2 rewrites the path to /list-2. pagination.next is the next results URL, or null on the last page.'
return_page_source:
type: boolean
description: 'Optional. Default false.
false returns the parsed JSON described below.
true returns {"result": "<page source>"} and omits results, pagination, and listing fields.'
default: false
required:
- query
responses:
'200':
description: Successful response
content:
application/json:
schema:
type: object
properties:
results:
type: array
items:
type: object
properties:
id:
type: integer
url:
type: string
badge:
nullable: true
image:
type: string
price:
type: integer
state:
type: string
suburb:
type: string
address:
type: string
channel:
type: string
bedrooms:
type: integer
currency:
type: string
postcode:
type: string
bathrooms:
type: integer
price_max:
nullable: true
agent_name:
type: string
car_spaces:
type: integer
agency_name:
type: string
building_size:
type: integer
price_display:
type: string
property_type:
type: string
building_size_display:
type: string
pagination:
type: object
properties:
next:
type: string
page:
type: integer
per_page:
type: integer
total_pages:
type: integer
total_results:
type: integer
examples:
Sydney NSW homes for sale:
value:
results:
- id: 149690532
url: https://www.realestate.com.au/property-apartment-nsw-sydney-149690532
badge: null
image: https://i2.au.reastatic.net/800x600/0912e9a1bea76a94ba5a397b993767175e6714ec2a59081478ee67d3f622b4cb/image.jpg
price: 4000000
state: NSW
suburb: Sydney
address: Level 22/6 Watermans Quay, Sydney, NSW 2000
channel: buy
bedrooms: 2
currency: AUD
postcode: '2000'
bathrooms: 2
price_max: null
agent_name: Leanne Pan
car_spaces: 1
agency_name: Ray White Residential - Sydney CBD
building_size: 107
price_display: $4,000,000
property_type: Apartment
building_size_display: 107m²
pagination:
next: https://www.realestate.com.au/buy/in-sydney,+nsw/list-2
page: 1
per_page: 25
total_pages: 25
total_results: 604
'400':
description: Bad Request — missing or invalid parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Bad Request
'401':
description: Unauthorized — the API key is missing, invalid, inactive, or expired, or a rate limit was exceeded (`Rate limit exceeded…` message).
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
invalidKey:
value:
error: Invalid API Key
planRateLimit:
value:
error: 'Rate limit exceeded: You''ve exceeded the per second rate limit on your subscription'
keyQuota:
value:
error: 'Rate limit exceeded for the API key: quota monthly'
'402':
description: Payment Required — your subscription or credit balance is insufficient.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Payment required
'500':
description: Internal Server Error — something went wrong on our side.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error: Internal Error
tags:
- Realestatecomau
components:
parameters:
fields:
name: fields
in: query
required: false
description: Comma-separated list of response fields to return, with dot notation for nested fields (e.g. `name,location.city`).
schema:
type: string
is_async:
name: is_async
in: query
required: false
description: 'Run the request as a background job: the API answers `202` with a `job_id` to poll on `GET /v1/jobs/{id}`.'
schema:
type: boolean
default: false
soft_fail:
name: soft_fail
in: query
required: false
description: Return HTTP 200 even when the request fails; the error is in the `error` field of the body.
schema:
type: boolean
default: false
schemas:
ErrorResponse:
type: object
required:
- error
properties:
error:
type: string
description: Human-readable error message.
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: Your API key. Include it in the x-api-key header for every request.