Valuations

Find homes the valuation engine can estimate

Returns up to eight address suggestions from the engine's active build when the authenticated client has valuations.read: HDB blocks with their flat types, private developments with their district, and landed streets. External URL: /v1/valuations/subjects. Current Next.js implementation path: /api/platform/v1/valuations/subjects. This read-only route does not require Idempotency-Key. Each API key may make 60 requests a minute and 2,000 a day across both valuation routes; over either limit the route answers 429 rate_limit_exceeded with Retry-After.

get/valuations/subjects

Request

  • Base URL: https://platform-api.homejourney.sg/v1
  • URL: https://platform-api.homejourney.sg/v1/valuations/subjects
  • Auth: HTTP bearer

Query parameters

qstring required

An address, block and street, development name or 6-digit postal code.

scope'hdb' | 'all' | 'commercial_industrial'

hdb limits suggestions to HDB blocks; commercial_industrial lists commercial and industrial projects instead of homes.

Headers

X-Correlation-Idstring

Optional partner-provided correlation ID echoed into request evidence.

Response

Address suggestions with the attribution.

livemodeboolean required
request_idstring required

Changes

No recorded changes to this operation across all 1 revision of this API.