/housing/properties/search

POST /api/housing/properties/search

Price: 5 credits

Search Housing.com property listings by city and optional locality across buy, rent, commercial, PG/co-living and plots channels. Returns listing cards with configuration, area, price, locality, geo coordinates, possession, RERA status, amenities, images and dealer.

How to use it

Search Housing.com property listings within a city. Requires city (slug, e.g. 'mumbai', 'bengaluru', 'new-delhi') and count. Optional: channel (buy/rent/commercial/paying_guest/plots), locality (gid from locations/autocomplete, e.g. 'powai-gid', narrows results to that locality). Each result has id, url, result_type (resale/rent/project), title, subtitle, project_name, property_type, bedroom_count/bathroom_count/balcony_count/parking_count, built_up_area/carpet_area/area_unit, furnishing, facing, age, possession_status, property_tags (transaction/construction status, possession/RERA badges), posted_at/updated_at, price/price_text/price_per_sqft/brokerage/emi/currency, city/locality/sublocality/address, latitude/longitude, is_rera_verified, tags, highlights, amenities, image/images/image_count, dealer. The feed mixes individual listings (result_type 'resale'/'rent') and new-launch project cards (result_type 'project'); use housing/properties or housing/projects with a returned id for full details.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• city string required — City slug to search in, e.g. 'mumbai', 'bengaluru', 'pune', 'new-delhi' (minLength: 1)
• channel string — Listing channel: buy / rent / commercial / pg / plots (default: "buy"; one of: "buy", "rent", "commercial", "paying_guest", "plots")
• locality string nullable — Optional locality gid to narrow the search, e.g. 'powai-gid' (from locations/autocomplete)
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "HousingSearchProperty")
• id string required
• url string required
• result_type string nullable
• subtitle string nullable
• project_name string nullable
• property_type string nullable
• bedroom_count integer nullable
• bathroom_count integer nullable
• balcony_count integer nullable
• parking_count integer nullable
• built_up_area number nullable
• carpet_area number nullable
• area_unit string nullable
• furnishing string nullable
• facing string nullable
• age string nullable
• possession_status string nullable
• property_tags array (default: [])
• is_under_construction boolean nullable
• posted_at string nullable
• updated_at string nullable
• price number nullable
• price_text string nullable
• price_per_sqft string nullable
• brokerage number nullable
• emi string nullable
• currency string nullable
• city string nullable
• locality string nullable
• sublocality string nullable
• address string nullable
• latitude number nullable
• longitude number nullable
• is_rera_verified boolean nullable
• tags array (default: [])
• highlights array (default: [])
• amenities array (default: [])
• image string nullable
• images array (default: [])
• image_count integer nullable
• dealer object nullable
  • @type string (default: "HousingSearchSeller")
  • name string nullable
  • firm_name string nullable
  • type string nullable
  • designation string nullable
  • profile_url string nullable
  • customers_served 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 — The entity was not found, or a precondition failed 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.