realestate.com.au Search

GET

/v2/realestatecomau/search

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

Autorización

ApiKeyAuth

headerx-api-key<token>

Your API key. Include it in the x-api-key header for every request.

Parámetros de consulta

query*string

Place or a realestate.com.au results URL.

Example:

Sydney, NSW

Sydney, NSW

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?string

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?number

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.

Default"1"

return_page_source?boolean

Optional. Default false.

false returns the parsed JSON described below. true returns {"result": ""} and omits results, pagination, and listing fields.

Default"false"

Cuerpo de la respuesta

Successful response

application/json

response

results?array<>

pagination?

Example Request

curl -X GET 'https://api.piloterr.com/v2/realestatecomau/search?query=string'

Example Request

curl -X GET 'https://api.piloterr.com/v2/realestatecomau/search?query=string'

Example ResponseSchema

{
  "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
  }
}

{  "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  }}

AutorizaciónCopiar enlace del ancla

Parámetros de consultaCopiar enlace del ancla

Cuerpo de la respuestaCopiar enlace del ancla

Autorización

Parámetros de consulta

Cuerpo de la respuesta