Listings

List public-safe listings

Returns public-safe listings. Sandbox credentials receive deterministic fixture listings; live credentials read active public-safe Homejourney and MLS-backed listings through the platform service layer. External URL: /v1/listings. Current Next.js implementation path: /api/platform/v1/listings. This read-only route does not require Idempotency-Key and never exposes source-agent contact metadata, private evidence URIs, or partner routing details.

get/listings

Request

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

Query parameters

limitinteger

Maximum number of listings to return.

cursorstring

Opaque pagination cursor from a previous response.

qstring

Public-safe text search across listing title, description, development, and district.

listing_type'For Sale' | 'For Rent'

Filter by sale or rent listing type.

property_typestring

Filter by public property type label.

districtstring

Filter by Singapore district label.

min_pricenumber

Minimum listing price.

max_pricenumber

Maximum listing price.

bedrooms_mininteger

Minimum bedroom count.

bedrooms_maxinteger

Maximum bedroom count.

subletting_type'whole_unit' | 'master_room' | 'common_room' | 'studio' | 'bed'

Filter rental listings by public subletting type.

available_fromstring date

Return listings available on or before this date.

lease_duration_monthsinteger

Maximum requested lease duration in months.

sort'newest' | 'price_asc' | 'price_desc' | 'relevance'

Sort listings by newest/default recency or price.

Headers

X-Correlation-Idstring

Optional partner-provided correlation ID echoed into request evidence.

Response

Public-safe listings.

livemodeboolean required
request_idstring required

Changes

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