Skip to content
Scrappa Get API key
Square Yards API 1 credit/request

Square Yards Property Search API Documentation

GET https://scrappa.co/api/squareyards/v1/search?city=Mumbai&category=buy&bedrooms=2&min_price=10000000&max_price=20000000&sort=price_asc

Search property listings in one Indian city for sale or rent. Filter by bedrooms, property type, locality, price range and area range, sort by price and page through the results. Each item carries the price in rupees and as displayed, bedrooms, bathrooms, area, property type, status, furnishing, facing, floor, locality with its id, coordinates, photos, highlights and the agent. A page holds up to 25 listings, and some pages hold fewer because project cards, repeated listings and listings that break your filters are removed (per_page is an upper bound). Every returned item satisfies the filters you set. A valid search with no match is a successful response with an empty list. An unknown city, property type, bedroom value or sort is a 422 error.

Square Yards Property Search API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/squareyards/v1/search?city=Mumbai&category=buy&bedrooms=2&min_price=10000000&max_price=20000000&sort=price_asc
Auth header
x-api-key
Cost
1 credit/request
city = Mumbai
Response preview
200 OK
{
    "success": true,
    "data": {
        "items": [
            {
                "id": 9306882,
                "url": "https://www.squareyards.com/resale-2-bhk-650-sq-ft-apartment-in-ashford-royale/9306882",
                "title": "2 BHK Apartment For Sale in Ashford Royale",
                "listing_type": "sale",
                "project_name": "Ashford Royale",
                "price": 18200000,
                "price_display": "\u20b9 1.82 Cr",
                "currency": "INR",
                "price_period": null,
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

10 optional filters available.

city string Required

City id or city name from /cities. Example: Mumbai.

Example value Mumbai
category string Optional

buy for sale listings or rent for rentals. Defaults to buy.

Example value buy
bedrooms string Optional

Bedroom count such as 2, or an exact label from /filters such as 2 BHK, 1 RK or Studio.

Example value 2
property_type string Optional

Property type name or id from /filters, for example Apartment, Villa, Office Space or 9.

Example value example
locality integer Optional

Locality id from /autocomplete (the locality_id of a locality item), for example 65173 for Andheri West.

Example value 10
min_price integer Optional

Lowest price in rupees. For rent this is the monthly rent.

Example value 10000000
max_price integer Optional

Highest price in rupees. For rent this is the monthly rent.

Example value 20000000
min_area integer Optional

Smallest area in square feet.

Example value 10
max_area integer Optional

Largest area in square feet.

Example value 10
sort string Optional

price_asc or price_desc. Without it the site relevance order applies.

Example value price_asc
page integer Optional

One-based page number. Defaults to 1. A page past the last page returns an empty list.

Example value 1

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/squareyards/v1/search?city=Mumbai&category=buy&bedrooms=2&min_price=10000000&max_price=20000000&sort=price_asc",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "x-api-key: YOUR_API_KEY_HERE"
    ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}
PHP
<?php

use Illuminate\Support\Facades\Http;

$response = Http::timeout(30)
    ->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
    ->get('https://scrappa.co/api/squareyards/v1/search?city=Mumbai&category=buy&bedrooms=2&min_price=10000000&max_price=20000000&sort=price_asc');

if ($response->successful()) {
    echo $response->body();
} else {
    echo "Error: " . $response->status();
}
JavaScript
const options = {
    method: 'GET',
    headers: {
        'x-api-key': 'YOUR_API_KEY_HERE'
    }
};

fetch('https://scrappa.co/api/squareyards/v1/search?city=Mumbai&category=buy&bedrooms=2&min_price=10000000&max_price=20000000&sort=price_asc', options)
    .then(response => {
        if (!response.ok) {
            throw new Error(`HTTP error! status: ${response.status}`);
        }
        return response.text();
    })
    .then(data => console.log(data))
    .catch(error => console.error('Error:', error));
JavaScript
const axios = require('axios');

const options = {
    method: 'GET',
    url: 'https://scrappa.co/api/squareyards/v1/search?city=Mumbai&category=buy&bedrooms=2&min_price=10000000&max_price=20000000&sort=price_asc',
    headers: {
        x-api-key: 'YOUR_API_KEY_HERE',
    }
};

try {
    const response = await axios(options);
    console.log(response.data);
} catch (error) {
    console.error('Error:', error.message);
}
Ruby
require 'net/http'
require 'uri'

uri = URI.parse("https://scrappa.co/api/squareyards/v1/search?city=Mumbai&category=buy&bedrooms=2&min_price=10000000&max_price=20000000&sort=price_asc")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'

request = Net::HTTP::Get.new(uri.request_uri)
request['x-api-key'] = 'YOUR_API_KEY_HERE'

begin
    response = http.request(request)
    puts response.body
rescue => e
    puts "Error: #{e.message}"
end
Python
import http.client
import json

conn = http.client.HTTPSConnection("scrappa.co")

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    conn.request("GET", "/api/squareyards/v1/search?city=Mumbai&category=buy&bedrooms=2&min_price=10000000&max_price=20000000&sort=price_asc", headers=headers)
    res = conn.getresponse()
    data = res.read()
    print(data.decode("utf-8"))
except Exception as e:
    print(f"Error: {e}")
finally:
    conn.close()
Python
import requests

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    response = requests.get('https://scrappa.co/api/squareyards/v1/search?city=Mumbai&category=buy&bedrooms=2&min_price=10000000&max_price=20000000&sort=price_asc', headers=headers)
    response.raise_for_status()
    print(response.text)
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")
Java
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;

public class ApiExample {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();

        Request request = new Request.Builder()
            .url("https://scrappa.co/api/squareyards/v1/search?city=Mumbai&category=buy&bedrooms=2&min_price=10000000&max_price=20000000&sort=price_asc")
        .addHeader("x-api-key", "YOUR_API_KEY_HERE")
            .build();

        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.out.println("Error: " + response.code());
            }
        } catch (IOException e) {
            System.out.println("Error: " + e.getMessage());
        }
    }
}
Go
package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {
    client := &http.Client{}
    req, err := http.NewRequest("GET", "https://scrappa.co/api/squareyards/v1/search?city=Mumbai&category=buy&bedrooms=2&min_price=10000000&max_price=20000000&sort=price_asc", nil)
    if err != nil {
        fmt.Println("Error creating request:", err)
        return
    }
    req.Header.Set("x-api-key", "YOUR_API_KEY_HERE")

    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Error making request:", err)
        return
    }
    defer resp.Body.Close()

    body, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        fmt.Println("Error reading response:", err)
        return
    }

    fmt.Println(string(body))
}
Terminal
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/squareyards/v1/search?city=Mumbai&category=buy&bedrooms=2&min_price=10000000&max_price=20000000&sort=price_asc"
C#
using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY_HERE");

        try
        {
            var response = await client.SendAsync(new HttpRequestMessage(HttpMethod.Get, "https://scrappa.co/api/squareyards/v1/search?city=Mumbai&category=buy&bedrooms=2&min_price=10000000&max_price=20000000&sort=price_asc"));
            var content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}
TypeScript
import axios from 'axios';

async function run(): Promise<void> {
    try {
        const response = await axios({
            method: 'GET',
            url: 'https://scrappa.co/api/squareyards/v1/search?city=Mumbai&category=buy&bedrooms=2&min_price=10000000&max_price=20000000&sort=price_asc',
            headers: {
        'x-api-key': 'YOUR_API_KEY_HERE',
            },
        });

        console.log(response.data);
    } catch (error) {
        console.error('Error:', error);
    }
}

void run();
RUST
use reqwest::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();

    let response = client
        .get("https://scrappa.co/api/squareyards/v1/search?city=Mumbai&category=buy&bedrooms=2&min_price=10000000&max_price=20000000&sort=price_asc")
        .header("x-api-key", "YOUR_API_KEY_HERE")
        .send()
        .await?;

    println!("{}", response.text().await?);

    Ok(())
}

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

success data meta
JSON Response
200 OK
{
    "success": true,
    "data": {
        "items": [
            {
                "id": 9306882,
                "url": "https://www.squareyards.com/resale-2-bhk-650-sq-ft-apartment-in-ashford-royale/9306882",
                "title": "2 BHK Apartment For Sale in Ashford Royale",
                "listing_type": "sale",
                "project_name": "Ashford Royale",
                "price": 18200000,
                "price_display": "\u20b9 1.82 Cr",
                "currency": "INR",
                "price_period": null,
                "unit_type": "2 BHK",
                "bedrooms": 2,
                "bathrooms": 2,
                "area": 650,
                "area_unit": "sqft",
                "property_type": "Apartment",
                "status": "Under Construction",
                "possession_status": "Under Construction",
                "furnishing": "Unfurnished",
                "facing": "West",
                "floor": null,
                "view": null,
                "flooring": null,
                "parking": "1 Covered Parking",
                "city": "Mumbai",
                "locality": "Nahur",
                "locality_id": 2823,
                "latitude": 19.157592,
                "longitude": 72.94506,
                "image": "https://img.squareyards.com/secondaryPortal/IN_638960510924149900-141025030452452.jpg",
                "images": [
                    "https://img.squareyards.com/secondaryPortal/IN_638960510924149900-141025030452452.jpg"
                ],
                "highlights": [
                    "Reputed Builder",
                    "Peaceful Vicinity"
                ],
                "agent": {
                    "id": 331378,
                    "name": "YOGESH BAPU GHADIGAONKAR",
                    "type": "CP",
                    "rating": null,
                    "experience_years": 7,
                    "premium": false,
                    "location": "Mumbai",
                    "image": null,
                    "slug": "yogesh-bapu-ghadigaonkar"
                }
            }
        ],
        "page": 1,
        "per_page": 25,
        "total": 7838,
        "has_more": true
    },
    "meta": {
        "endpoint_family": "search",
        "billable": true
    }
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

422

Validation Error

A public parameter is missing or invalid, or a city, property type, bedroom value or sort cannot be resolved. The response is not billable.

{
    "errors": {
        "city": [
            "The city field is required."
        ]
    },
    "message": "The request validation failed"
}
404

Resource Not Found

The requested Square Yards resource does not exist. The response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": false,
        "endpoint_family": "search"
    },
    "error": {
        "code": "NOT_FOUND",
        "message": "The requested Square Yards resource was not found."
    },
    "success": false
}
503

Unexpected Upstream Response

Square Yards answered with a body that is not the documented shape. The response is not billable.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "search"
    },
    "error": {
        "code": "PARSER_DRIFT",
        "message": "The Square Yards API is temporarily unavailable. Please retry."
    },
    "success": false
}
503

Upstream Unavailable

Square Yards was temporarily unavailable or blocked the request. The response is not billable and the request never answers 429.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "search"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "The Square Yards API is temporarily unavailable. Please retry."
    },
    "success": false
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.