Skip to main content
POST
/
api
/
housing
/
properties
/
search
/housing/properties/search
curl --request POST \
  --url https://api.anysite.io/api/housing/properties/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "city": "<string>",
  "count": 2,
  "timeout": 300,
  "channel": "buy",
  "locality": "<string>"
}
'
[
  {
    "id": "<string>",
    "url": "<string>",
    "@type": "@housing_search_property",
    "result_type": "<string>",
    "title": "<string>",
    "subtitle": "<string>",
    "project_name": "<string>",
    "property_type": "<string>",
    "bedroom_count": 123,
    "bathroom_count": 123,
    "balcony_count": 123,
    "parking_count": 123,
    "built_up_area": 123,
    "carpet_area": 123,
    "area_unit": "<string>",
    "furnishing": "<string>",
    "facing": "<string>",
    "age": "<string>",
    "possession_status": "<string>",
    "property_tags": [],
    "is_under_construction": true,
    "posted_at": "<string>",
    "updated_at": "<string>",
    "price": 123,
    "price_text": "<string>",
    "price_per_sqft": "<string>",
    "brokerage": 123,
    "emi": "<string>",
    "currency": "<string>",
    "city": "<string>",
    "locality": "<string>",
    "sublocality": "<string>",
    "address": "<string>",
    "latitude": 123,
    "longitude": 123,
    "is_rera_verified": true,
    "tags": [],
    "highlights": [],
    "amenities": [],
    "image": "<string>",
    "images": [],
    "image_count": 123,
    "dealer": {
      "@type": "@housing_search_seller",
      "name": "<string>",
      "firm_name": "<string>",
      "type": "<string>",
      "designation": "<string>",
      "profile_url": "<string>",
      "customers_served": "<string>"
    }
  }
]

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
city
string
required

City slug to search in, e.g. 'mumbai', 'bengaluru', 'pune', 'new-delhi'

Minimum string length: 1
count
integer
required

Max number of results to return

Required range: x >= 1
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
channel
enum<string>
default:buy

Listing channel: buy / rent / commercial / pg / plots

Available options:
buy,
rent,
commercial,
paying_guest,
plots
locality
string | null

Optional locality gid to narrow the search, e.g. 'powai-gid' (from locations/autocomplete)

Response

Successful Response

id
string
required
url
string
required
@type
string
default:@housing_search_property
result_type
string | null
title
string | null
subtitle
string | null
project_name
string | null
property_type
string | null
bedroom_count
integer | null
bathroom_count
integer | null
balcony_count
integer | null
parking_count
integer | null
built_up_area
number | null
carpet_area
number | null
area_unit
string | null
furnishing
string | null
facing
string | null
age
string | null
possession_status
string | null
property_tags
string[]
is_under_construction
boolean | null
posted_at
string | null
updated_at
string | null
price
number | null
price_text
string | null
price_per_sqft
string | null
brokerage
number | null
emi
string | null
currency
string | null
city
string | null
locality
string | null
sublocality
string | null
address
string | null
latitude
number | null
longitude
number | null
is_rera_verified
boolean | null
tags
string[]
highlights
string[]
amenities
string[]
image
string | null
images
string[]
image_count
integer | null
dealer
HousingSearchSeller · object