/propertyguru/projects

POST /api/propertyguru/projects

Price: 20 credits

Get PropertyGuru development project details by slug-id or project URL: name, project type, developer, tenure, price per sqft range, completion year, number of floors, total units, description, address, postcode, district, facilities and images.

How to use it

Fetch a single PropertyGuru development project by slug-id (e.g. marina-one-residences-21458) or project URL. Set region ('sg'/'my'). Returns one item with id, url, name, project_type, developer, tenure, psf_text (price per sqft range), completion_year, floor_count, total_units, description, address, postcode, district_code, facilities and images (with image as the cover).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• region string — PropertyGuru regional marketplace (sg = Singapore, my = Malaysia). (default: "sg"; one of: "sg", "my")
• project string required — PropertyGuru project slug-id or project page URL (examples: "marina-one-residences-21458", "https://www.propertyguru.com.sg/project/marina-one-residences-21458"; minLength: 1)

Response

• @type string (default: "PropertyGuruProject")
• id string required
• url string required
• name string nullable
• project_type string nullable
• developer string nullable
• tenure string nullable
• psf_text string nullable
• completion_year integer nullable
• floor_count integer nullable
• total_units integer nullable
• description string nullable
• address string nullable
• postcode string nullable
• district_code string nullable
• facilities array (default: [])
• images array (default: [])
• image string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Project not found (well-formed but nonexistent slug-id, or page has no project) Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.