Sign inGet a free API keyDashboard
Menu

APIs / Real estate / Square Yards

1 credit per call6 endpoints26 datapoints

Square Yards API

Square Yards API for Indian property to buy or rent, listings, agents, localities, cities and filters as JSON. 1 credit per successful call.

Get a free API keyRun it below
Square Yards
GET/v1/square-yards/search?city=Mumbai&category=buy&bedrooms=2&min_price=10000000&max_price=20000000&sort=price_asc
{
  "success": true,
  "data": {
    "items": [
      {
        "id": 8992103,
        "url": "https://www.squareyards.com/resale-2-bhk-pooja-room-servant-room-study-room-750-sq-ft-apartment-in-maitri-chs/8992103",
        "title": "2 BHK + Pooja Room,Servant Room,Study Room Apartment For Sale in Maitri CHS",
        "listing_type": "sale",
        "project_name": "Maitri CHS",
        "price": 10000000,
        "price_display": "₹ 1 Cr",
        "currency": "INR",
        "unit_type": "2 BHK",
        "bedrooms": 2,
        "bathrooms": 2,
        "area": 750,
        "area_unit": "sqft",
        "property_type": "Apartment",
        "facing": "East",
        "floor": "101th of 13 Floors",
        "parking": "1 Open Parking",
        "city": "Mumbai",
        "locality": "Ghatkopar West",
        "locality_id": 65227,
        "latitude": 19.096718,
        "longitude": 72.913845,
        "image": "https://img.squareyards.com/secondaryPortal/IN_638890390774772441-2507251117571757.jpg",
        "images": [
          "https://img.squareyards.com/secondaryPortal/IN_638890390774772441-2507251117571757.jpg",
          "https://img.squareyards.com/secondaryPortal/IN_638890390783570583-2507251117581758.jpg",
          "https://img.squareyards.com/secondaryPortal/IN_638890390776689121-2507251117571757.jpg"
        ],
        "highlights": [
          "Breakthrough Price",
          "Reputed Builder",
          "Gated Society"
        ],
        "agent": {
          "id": 561806,
          "name": "UMESH G BHAT",
          "type": "CP",
          "experience_years": 5,
          "premium": false,
          "location": "Thane",
          "slug": "umesh-bhat"
        }
      },
      {
        "id": 9133513,
        "url": "https://www.squareyards.com/resale-2-bhk-490-sq-ft-apartment-in-dgs-sheetal-sahyog/9133513",
        "title": "2 BHK Apartment For Sale in DGS Sheetal Sahyog",
        "listing_type": "sale",
        "project_name": "DGS Sheetal Sahyog",
        "price": 10000000,
        "price_display": "₹ 1 Cr",
        "currency": "INR",
        "unit_type": "2 BHK",
        "bedrooms": 2,
        "bathrooms": 2,
        "area": 490,
        "area_unit": "sqft",
        "property_type": "Apartment",
        "status": "Under Construction",
        "possession_status": "Under Construction",
        "furnishing": "Unfurnished",
        "facing": "East",
        "floor": "20th of 40 Floors",
        "city": "Mumbai",
        "locality": "Malad East",
        "locality_id": 65169,
        "latitude": 19.185951,
        "longitude": 72.8633,
        "image": "https://img.squareyards.com/secondaryPortal/IN_638924389002578735-0209250741404140.jpg",
        "images": [
          "https://img.squareyards.com/secondaryPortal/IN_638924389002578735-0209250741404140.jpg",
          "https://img.squareyards.com/secondaryPortal/IN_638924389006938044-0209250741404140.jpg",
          "https://img.squareyards.com/secondaryPortal/IN_638924388994610388-0209250741394139.jpg"
        ],
        "highlights": [
          "Vastu compliant",
          "Safe & Secure Locality",
          "Affordable"
        ],
        "agent": {
          "id": 477234,
          "name": "MANOJKUMAR JADHAV",
          "type": "CP",
          "rating": 5,
          "experience_years": 5,
          "premium": false,
          "location": "Mumbai",
          "image": "https://img.squareyards.com/connect/profilepic/919152735508638537264841442680.jpg",
          "slug": "manoj-jadhav"
        }
      },
      {
        "id": 9155465,
        "url": "https://www.squareyards.com/resale-2-bhk-635-sq-ft-apartment-in-jay-anand-chs/9155465",
        "title": "2 BHK Apartment For Sale in Jay Anand CHS",
        "listing_type": "sale",
        "project_name": "Jay Anand CHS",
        "price": 10000000,
        "price_display": "₹ 1 Cr",
        "currency": "INR",
        "unit_type": "2 BHK",
        "bedrooms": 2,
        "bathrooms": 2,
        "area": 635,
        "area_unit": "sqft",
        "property_type": "Apartment",
        "status": "Ready To Move",
        "possession_status": "Ready To Move",
        "furnishing": "Unfurnished",
        "parking": "1 Covered + 1 Open",
        "city": "Mumbai",
        "locality": "Chunabhatti",
        "locality_id": 863,
        "latitude": 19.051476,
        "longitude": 72.872055,
        "image": "https://img.squareyards.com/secondaryPortal/IN_638928931034156428-0809250151435143.jpg",
        "highlights": [
          "Near City Center",
          "Breakthrough Price",
          "Vastu compliant"
        ],
        "agent": {
          "id": 599783,
          "name": "kawleen singh",
          "type": "CP",
          "premium": false,
          "location": "Mumbai",
          "slug": "kawleen-singh"
        }
      }
    ],
    "page": 1,
    "per_page": 25,
    "total": 8056,
    "has_more": true
  },
  "meta": {
    "endpoint_family": "search",
    "request_id": "req_4b3daa27a9aa427f9b75923b99fd8237",
    "credits_charged": 1,
    "credits_remaining": 1809
  }
}
200 OKJSONX-Credits-Used: 1
Recorded from our API and shortened.

Sample data

What one call returns

A recorded run of search: the fields and shapes you will get, shortened to 3 items.

#idintegerurlurltitlestringlisting_typestringproject_namestringpriceintegerprice_displaystringcurrencystringunit_typestringbedroomsintegerbathroomsintegerareaintegerarea_unitstringproperty_typestringfacingstringfloorstringparkingstringcitystringlocalitystringlocality_idintegerlatitudenumberlongitudenumberimageurlimagesstring[]highlightsstring[]agentobject
18992103https://www.squareyards.com/resale-2-bhk-pooja-room-servant-room-study-room-750-sq-ft-apartment-in-maitri-chs/89921032 BHK + Pooja Room,Servant Room,Study Room Apartment For Sale in Maitri CHSsaleMaitri CHS10000000₹ 1 CrINR2 BHK22750sqftApartmentEast101th of 13 Floors1 Open ParkingMumbaiGhatkopar West6522719.09671872.913845https://img.squareyards.com/secondaryPortal/IN_638890390774772441-2507251117571757.jpg[3 items][3 items]{7 fields}
29133513https://www.squareyards.com/resale-2-bhk-490-sq-ft-apartment-in-dgs-sheetal-sahyog/91335132 BHK Apartment For Sale in DGS Sheetal SahyogsaleDGS Sheetal Sahyog10000000₹ 1 CrINR2 BHK22490sqftApartmentEast20th of 40 Floors—MumbaiMalad East6516919.18595172.8633https://img.squareyards.com/secondaryPortal/IN_638924389002578735-0209250741404140.jpg[3 items][3 items]{9 fields}
39155465https://www.squareyards.com/resale-2-bhk-635-sq-ft-apartment-in-jay-anand-chs/91554652 BHK Apartment For Sale in Jay Anand CHSsaleJay Anand CHS10000000₹ 1 CrINR2 BHK22635sqftApartment——1 Covered + 1 OpenMumbaiChunabhatti86319.05147672.872055https://img.squareyards.com/secondaryPortal/IN_638928931034156428-0809250151435143.jpg—[3 items]{6 fields}

Recorded from our API · 3 items shown · 26 datapoints per itemGET /v1/square-yards/search?city=Mumbai&category=buy&bedrooms=2&min_price=10000000&max_price=20000000&sort=price_asc

26 datapoints

Identity

  • idinteger
  • titlestring
  • listing_typestring
  • project_namestring
  • unit_typestring
  • property_typestring
  • locality_idinteger

Contact

  • urlurl
  • agentobject

Location

  • areainteger
  • area_unitstring
  • citystring
  • latitudenumber
  • longitudenumber

Reputation

  • imageurl
  • imagesstring[]

Price

  • priceinteger
  • price_displaystring
  • currencystring

Other

  • bedroomsinteger
  • bathroomsinteger
  • facingstring
  • floorstring
  • parkingstring
  • localitystring
  • highlightsstring[]

Playground

Run this API

cURLshell
curl "https://api.perceptlayer.com/v1/square-yards/search?city=Mumbai&category=buy&bedrooms=2&min_price=10000000&max_price=20000000&sort=price_asc" \
  -H "X-API-Key: $API_KEY"

Square Yards · 6 endpoints

Endpoints

Every endpoint takes the same key. Open one for its parameters and an example request.

EndpointRequired parametersCost
GET/v1/square-yards/agent
id+1 optional
1 credit
GET/v1/square-yards/autocomplete
qcity+1 optional
1 credit
GET/v1/square-yards/cities
none+1 optional
1 credit
GET/v1/square-yards/filters
none+1 optional
1 credit
GET/v1/square-yards/listing
none+3 optional
1 credit
GET/v1/square-yards/search
city+10 optional
1 credit

Overview

What you can get

The Square Yards API returns Square Yards property data as JSON through 6 endpoints.

  • Search: search takes a city, with category (buy or rent), bedrooms, property_type, locality, min_price, max_price, min_area, max_area, sort (price_asc or price_desc) and page.
  • Listings: listing takes a url or an id, with category (buy or rent).
  • Agents: agent takes an id, with slug.
  • Places and filters: autocomplete takes a q and a city, with category (buy or rent); cities takes a q; filters takes a category (buy or rent).

The recorded search for 2-bedroom homes to buy in Mumbai between ₹1 crore and ₹2 crore, sorted by price_asc, returns a total of 8,056, with per_page (25) and has_more, and items, each with id, url, title, listing_type, project_name, price, price_display, currency, unit_type, bedrooms, bathrooms, area, area_unit, property_type, facing, floor, parking, city, locality, locality_id, latitude, longitude, images, highlights and agent.

How a call works

Search a city: GET /v1/square-yards/search?city=Mumbai&category=buy&bedrooms=2&min_price=10000000&max_price=20000000&sort=price_asc with your key in the X-API-Key header. Each item's url or id is what listing takes, its locality_id is what search takes as locality, and the id and slug inside its agent feed agent. Check has_more before asking for the next page. Every successful call costs 1 credit; failed calls cost nothing.

Real estateJSONRESTMCP

More real estate APIs

28Hse4zida59199.co99acresAdondevivirApartment ListApartments.comAqarAqarmapArgenpropathome

Use cases

Track asking prices by BHK in Mumbai and other Indian cities

Use the Square Yards API to track asking prices by BHK in Mumbai and other Indian cities

Compare prices across localities with `locality`

Use the Square Yards API to compare prices across localities with `locality`

Watch rentals with `category=rent`

Use the Square Yards API to watch rentals with `category=rent`

Find the agent behind a listing and their experience

Use the Square Yards API to find the agent behind a listing and their experience

FAQ

Questions

Do I need a Square Yards account?

No. You call this Square Yards API with your Perceptlayer key in the `X-API-Key` header, with no Square Yards login.

How much does the Square Yards API cost?

Each successful call costs one credit. New accounts get free credits to start, and credit packs bring the price down as you scale.

What format are responses in?

Every endpoint returns JSON, with no HTML parsing on your side.

What currency are prices in?

Indian rupees. `price` is a number, `currency` is INR, and `price_display` gives the site's label, such as "₹ 1 Cr".

Should I build a Square Yards scraper instead?

You can, but a Square Yards scraper is code you maintain: page changes break it, requests get blocked, and Square Yards's terms govern how you collect data. The Square Yards API gives you 6 endpoints of named JSON fields for 1 credit per successful call, and failed calls cost nothing. A scraper makes sense only for data these endpoints don't return, so check the response in the playground on this page first.

Try the Square Yards API with 100 free credits

No credit card. Failed calls are never billed.

Get a free API keyRead the docs