Property24 search results · Property24 API

GET https://api.api.sh/property24/v1/search

1 credit / call real estate try it in the playground →

Each result has id, link, title, description, price and price text, location, address, excerpt, bedrooms, bathrooms, parking, floor and erf size, agency, agent and photos. Pass next_page back as page; null on the last page.

Every response includes credits_used: the credits this call cost.

Parameters

name	type	description
`url`	string	A property24.com search link (for-sale or to-rent, with any filters). Either `url` or `location` is required. Example: `https://www.property24.com/for-sale/cape-town/western-cape/432`
`location`	string	Instead of `url`: the area part of a property24.com search link, e.g. `cape-town/western-cape/432` (city) or `sea-point/cape-town/western-cape/11021` (suburb). Example: `cape-town/western-cape/432`
`transaction`	for-sale \| to-rent	`for-sale` (default with `location`) or `to-rent`; with `url` it switches the link's own type.
`property_type`	house \| apartment \| townhouse \| vacant_land \| farm \| commercial \| industrial	Only this property type.
`price_min`	integer	Minimum price in rand (monthly rent for to-rent).
`price_max`	integer	Maximum price in rand (monthly rent for to-rent).
`bedrooms`	integer	At least this many bedrooms (1-5).
`bathrooms`	integer	At least this many bathrooms (1-5).
`parking`	integer	At least this many parking spaces (1-5).
`furnished`	boolean	`true`: furnished only; `false`: unfurnished only (rentals).
`on_show`	boolean	`true`: only properties on show.
`auction`	boolean	`true`: only auctions.
`repossessed`	boolean
`retirement`	boolean	`true`: only retirement properties.
`sort`	newest \| price_low \| price_high \| size \| type	Order of the listings (default: the site's own).
`page`	integer	Page number, starting at 1. Pass `next_page` back as `page`; it is null on the last page. Example: `1`

Every endpoint also takes fresh, raw, fields (see lean responses and caching).

Example

curl "https://api.api.sh/property24/v1/search?url=https%3A%2F%2Fwww.property24.com%2Ffor-sale%2Fcape-town%2Fwestern-cape%2F432" \
  -H "x-api-key: $APISH_KEY"

import os, requests

res = requests.get(
    "https://api.api.sh/property24/v1/search",
    params={"url": "https://www.property24.com/for-sale/cape-town/western-cape/432"},
    headers={"x-api-key": os.environ["APISH_KEY"]},
    timeout=120,
)
res.raise_for_status()
data = res.json()

const url = new URL("https://api.api.sh/property24/v1/search");
url.searchParams.set("url", "https://www.property24.com/for-sale/cape-town/western-cape/432");

const res = await fetch(url, { headers: { "x-api-key": process.env.APISH_KEY } });
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const data = await res.json();

Response

A JSON object with the fields described above, plus raw (the source's own data), cached, fetched_at and credits_used. Errors return {"success": false, "error": "…"} with the HTTP status (see errors). A lookup that ran but found nothing (404) costs the price above; refused calls and errors on our side are free (what's charged).

The fastest way to see the full response is the playground: it runs this endpoint with your account and shows the exact JSON.