/propertyguru/agents

POST /api/propertyguru/agents

Price: 10 credits

Get a PropertyGuru property agent profile by id, slug-id or agent URL: name, CEA license, job title, agency and agency license, profile image, years of service, total transactions with breakdown by type and client role, rating and review count, and languages spoken.

How to use it

Fetch a single PropertyGuru agent profile by id (e.g. 226308), slug-id (thomas-sim-226308) or agent URL. Set region ('sg'/'my'). Returns one item with id, url, name, first_name, license (CEA), job_title, account_type, package_type, is_verified, agency, agency_license, agency_logo, image, description, years_of_service, transaction_count (last 3 years), rating and review_count, languages, seller/buyer/landlord/tenant client counts, and transaction_types (per type: count and condo/hdb/landed breakdown).

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")
• agent string required — PropertyGuru agent id, slug-id or agent page URL (examples: "226308", "thomas-sim-226308", "https://www.propertyguru.com.sg/agent/thomas-sim-226308"; minLength: 1)

Response

• @type string (default: "PropertyGuruAgent")
• id string required
• url string required
• name string nullable
• first_name string nullable
• license string nullable
• job_title string nullable
• account_type string nullable
• package_type string nullable
• is_verified boolean nullable
• agency string nullable
• agency_license string nullable
• agency_logo string nullable
• image string nullable
• description string nullable
• years_of_service integer nullable
• transaction_count integer nullable
• rating number nullable
• review_count integer nullable
• languages array (default: [])
• seller_client_count integer nullable
• buyer_client_count integer nullable
• landlord_client_count integer nullable
• tenant_client_count integer nullable
• transaction_types array (default: [])
  • @type string (default: "PropertyGuruAgentTransactionType")
  • type string required
  • count integer nullable
  • condo_count integer nullable
  • hdb_count integer nullable
  • landed_count integer 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 — Agent not found (well-formed but nonexistent id, or page has no agent) 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.