/housing/projects

POST /api/housing/projects

Price: 1 credit

Get full Housing.com new-launch project details by id or project URL: name, builder, price range, configuration cards (BHK/area/price), possession status and date, launch date, RERA, facilities and amenities, geo coordinates, description and photo gallery.

How to use it

Fetch a single Housing.com new-launch (builder development) project by id (e.g. 254864) or a project URL. Returns one item with name, subtitle, project_type, description, configuration, possession_status/possession_date, launch_date, property_tags (construction status, possession/RERA badges), is_active, price_min/price_max/price_text/price_per_sqft/currency (INR), project_area, unit_count, size_range, area_unit, city/locality/sublocality/address, latitude/longitude, rera_id, is_rera_verified, builder (name, description, established_year, project_count, image, profile_url), configurations (label/bedrooms/property_type/price_range/area_range/area_unit), facilities (clubhouse), amenities, video_key, image, images (gallery), image_count. Projects are distinct from individual listings (use housing/properties for those).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• project string required — Housing.com project id or a project page URL containing it (examples: "254864", "https://housing.com/in/buy/projects/page/254864-godrej-urban-park-by-godrej-properties-ltd-in-powai"; minLength: 1)

Response

• @type string (default: "HousingProject")
• id string required
• url string required
• name string nullable
• subtitle string nullable
• project_type string nullable
• description string nullable
• configuration string nullable
• possession_status string nullable
• possession_date string nullable
• launch_date string nullable
• property_tags array (default: [])
• is_active boolean nullable
• price_min number nullable
• price_max number nullable
• price_text string nullable
• price_per_sqft string nullable
• currency string nullable
• project_area string nullable
• unit_count integer nullable
• size_range string nullable
• area_unit string nullable
• city string nullable
• locality string nullable
• sublocality string nullable
• address string nullable
• latitude number nullable
• longitude number nullable
• rera_id string nullable
• is_rera_verified boolean nullable
• builder object nullable
  • @type string (default: "HousingProjectBuilder")
  • name string nullable
  • description string nullable
  • established_year string nullable
  • project_count integer nullable
  • image string nullable
  • profile_url string nullable
• configurations array (default: [])
  • @type string (default: "HousingProjectConfiguration")
  • label string nullable
  • bedrooms string nullable
  • property_type string nullable
  • price_range string nullable
  • area_range string nullable
  • area_unit string nullable
• facilities array (default: [])
• amenities array (default: [])
• video_key string nullable
• image string nullable
• images array (default: [])
• image_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 — Project not found (well-formed but nonexistent 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.