--- title: "Square Yards API: JSON data, 6 endpoints, 1 credit per call" description: "Square Yards API for Indian property to buy or rent, listings, agents, localities, cities and filters as JSON. 1 credit per successful call." url: https://perceptlayer.com/apis/square-yards --- [APIs](https://perceptlayer.com/apis) / [Real estate](https://perceptlayer.com/verticals/real-estate) / Square Yards 1 credit per call 6 endpoints 26 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 key](https://perceptlayer.com/signup) Run 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 OK JSON X-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. | # | id integer | url url | title string | listing\_type string | project\_name string | price integer | price\_display string | currency string | unit\_type string | bedrooms integer | bathrooms integer | area integer | area\_unit string | property\_type string | facing string | floor string | parking string | city string | locality string | locality\_id integer | latitude number | longitude number | image url | images string\[\] | highlights string\[\] | agent object | | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | --- | | 1 | 8992103 | https://www.squareyards.com/resale-2-bhk-pooja-room-servant-room-study-room-750-sq-ft-apartment-in-maitri-chs/8992103 | 2 BHK + Pooja Room,Servant Room,Study Room Apartment For Sale in Maitri CHS | sale | Maitri CHS | 10000000 | ₹ 1 Cr | INR | 2 BHK | 2 | 2 | 750 | sqft | Apartment | East | 101th of 13 Floors | 1 Open Parking | Mumbai | Ghatkopar West | 65227 | 19.096718 | 72.913845 | https://img.squareyards.com/secondaryPortal/IN\_638890390774772441-2507251117571757.jpg | \[3 items\] | \[3 items\] | {7 fields} | | 2 | 9133513 | https://www.squareyards.com/resale-2-bhk-490-sq-ft-apartment-in-dgs-sheetal-sahyog/9133513 | 2 BHK Apartment For Sale in DGS Sheetal Sahyog | sale | DGS Sheetal Sahyog | 10000000 | ₹ 1 Cr | INR | 2 BHK | 2 | 2 | 490 | sqft | Apartment | East | 20th of 40 Floors | — | Mumbai | Malad East | 65169 | 19.185951 | 72.8633 | https://img.squareyards.com/secondaryPortal/IN\_638924389002578735-0209250741404140.jpg | \[3 items\] | \[3 items\] | {9 fields} | | 3 | 9155465 | https://www.squareyards.com/resale-2-bhk-635-sq-ft-apartment-in-jay-anand-chs/9155465 | 2 BHK Apartment For Sale in Jay Anand CHS | sale | Jay Anand CHS | 10000000 | ₹ 1 Cr | INR | 2 BHK | 2 | 2 | 635 | sqft | Apartment | — | — | 1 Covered + 1 Open | Mumbai | Chunabhatti | 863 | 19.051476 | 72.872055 | https://img.squareyards.com/secondaryPortal/IN\_638928931034156428-0809250151435143.jpg | — | \[3 items\] | {6 fields} | Recorded from our API · 3 items shown · 26 datapoints per item GET /v1/square-yards/search?city=Mumbai&category=buy&bedrooms=2&min\_price=10000000&max\_price=20000000&sort=price\_asc 26 datapoints ### Identity - id integer - title string - listing\_type string - project\_name string - unit\_type string - property\_type string - locality\_id integer ### Contact - url url - agent object ### Location - area integer - area\_unit string - city string - latitude number - longitude number ### Reputation - image url - images string\[\] ### Price - price integer - price\_display string - currency string ### Other - bedrooms integer - bathrooms integer - facing string - floor string - parking string - locality string - highlights string\[\] Playground ## Run this API cURL shell ``` 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. | Endpoint | Required parameters | Cost | | --- | --- | --- | | [GET `/v1/square-yards/agent`](https://perceptlayer.com/apis/square-yards/agent) | `id` +1 optional | 1 credit | | [GET `/v1/square-yards/autocomplete`](https://perceptlayer.com/apis/square-yards/autocomplete) | `q` `city` +1 optional | 1 credit | | [GET `/v1/square-yards/cities`](https://perceptlayer.com/apis/square-yards/cities) | none +1 optional | 1 credit | | [GET `/v1/square-yards/filters`](https://perceptlayer.com/apis/square-yards/filters) | none +1 optional | 1 credit | | [GET `/v1/square-yards/listing`](https://perceptlayer.com/apis/square-yards/listing) | none +3 optional | 1 credit | | [GET `/v1/square-yards/search`](https://perceptlayer.com/apis/square-yards/search) | `city` +10 optional | 1 credit | Overview ## About the Square Yards API ## 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 estate JSON REST MCP ### More real estate APIs [28Hse](https://perceptlayer.com/apis/28hse) [4zida](https://perceptlayer.com/apis/4zida) [591](https://perceptlayer.com/apis/591-house) [99.co](https://perceptlayer.com/apis/99co) [99acres](https://perceptlayer.com/apis/99acres) [Adondevivir](https://perceptlayer.com/apis/adondevivir) [Apartment List](https://perceptlayer.com/apis/apartment-list) [Apartments.com](https://perceptlayer.com/apis/apartments-com) [Aqar](https://perceptlayer.com/apis/aqar) [Aqarmap](https://perceptlayer.com/apis/aqarmap) [Argenprop](https://perceptlayer.com/apis/argenprop) [athome](https://perceptlayer.com/apis/athome) 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 key](https://perceptlayer.com/signup) [Read the docs](https://docs.perceptlayer.com)