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

Square Yards Listing Detail API Documentation

GET https://scrappa.co/api/squareyards/v1/listing?url=https%3A%2F%2Fwww.squareyards.com%2Frental-1-bhk-432-sq-ft-apartment-in-ruparel-elara%2F10410525

Read one listing by the url from /search, or by its id and category. The answer has the title, price, price per square foot, rent deposit when shown, bedrooms, rooms, bathrooms, area, floor, total floors, facing, view, balcony, flooring, tower, availability date, furnishing, the full specification table, description, amenities by group, furnishing items, the photos of the listing and of its project, approximate coordinates and the agent. Coordinates are at locality level and are labelled so. Fields the page does not show are null. Phone numbers are never returned. An unknown listing is a non-billable 404.

Square Yards Listing Detail API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/squareyards/v1/listing?url=https%3A%2F%2Fwww.squareyards.com%2Frental-1-bhk-432-sq-ft-apartment-in-ruparel-elara%2F10410525
Auth header
x-api-key
Cost
1 credit/request
Response preview
200 OK
{
    "success": true,
    "data": {
        "id": 10410525,
        "url": "https://www.squareyards.com/rental-1-bhk-432-sq-ft-apartment-in-ruparel-elara/10410525",
        "title": "1 Bedroom Apartment in Ruparel Elara, Kandivali West, Mumbai",
        "listing_type": "rent",
        "price": 30000,
        "price_display": "\u20b9 30,000",
        "currency": "INR",
        "price_period": "Per Month",
        "price_per_sqft": null,
        "fees": {
            "security_deposit": 90000,
...

Parameters

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

Runnable path

This endpoint has no required query parameters.

3 optional filters available.

url string Optional
Open example

Listing url as returned by /search, for example https://www.squareyards.com/resale-2-bhk-650-sq-ft-apartment-in-ashford-royale/9306882. Use url or id.

Example value https://www.squareyards.com/rental-1-bhk-432-sq-ft-apartment-in-ruparel-elara/10410525
id integer Optional

Numeric listing id such as 9306882. Use with category.

Example value 1234567890
category string Optional

buy or rent. Needed with id. Defaults to buy.

Example value example

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/squareyards/v1/listing?url=https%3A%2F%2Fwww.squareyards.com%2Frental-1-bhk-432-sq-ft-apartment-in-ruparel-elara%2F10410525",
    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/listing?url=https%3A%2F%2Fwww.squareyards.com%2Frental-1-bhk-432-sq-ft-apartment-in-ruparel-elara%2F10410525');

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/listing?url=https%3A%2F%2Fwww.squareyards.com%2Frental-1-bhk-432-sq-ft-apartment-in-ruparel-elara%2F10410525', 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/listing?url=https%3A%2F%2Fwww.squareyards.com%2Frental-1-bhk-432-sq-ft-apartment-in-ruparel-elara%2F10410525',
    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/listing?url=https%3A%2F%2Fwww.squareyards.com%2Frental-1-bhk-432-sq-ft-apartment-in-ruparel-elara%2F10410525")
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/listing?url=https%3A%2F%2Fwww.squareyards.com%2Frental-1-bhk-432-sq-ft-apartment-in-ruparel-elara%2F10410525", 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/listing?url=https%3A%2F%2Fwww.squareyards.com%2Frental-1-bhk-432-sq-ft-apartment-in-ruparel-elara%2F10410525', 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/listing?url=https%3A%2F%2Fwww.squareyards.com%2Frental-1-bhk-432-sq-ft-apartment-in-ruparel-elara%2F10410525")
        .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/listing?url=https%3A%2F%2Fwww.squareyards.com%2Frental-1-bhk-432-sq-ft-apartment-in-ruparel-elara%2F10410525", 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/listing?url=https%3A%2F%2Fwww.squareyards.com%2Frental-1-bhk-432-sq-ft-apartment-in-ruparel-elara%2F10410525"
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/listing?url=https%3A%2F%2Fwww.squareyards.com%2Frental-1-bhk-432-sq-ft-apartment-in-ruparel-elara%2F10410525"));
            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/listing?url=https%3A%2F%2Fwww.squareyards.com%2Frental-1-bhk-432-sq-ft-apartment-in-ruparel-elara%2F10410525',
            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/listing?url=https%3A%2F%2Fwww.squareyards.com%2Frental-1-bhk-432-sq-ft-apartment-in-ruparel-elara%2F10410525")
        .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": {
        "id": 10410525,
        "url": "https://www.squareyards.com/rental-1-bhk-432-sq-ft-apartment-in-ruparel-elara/10410525",
        "title": "1 Bedroom Apartment in Ruparel Elara, Kandivali West, Mumbai",
        "listing_type": "rent",
        "price": 30000,
        "price_display": "\u20b9 30,000",
        "currency": "INR",
        "price_period": "Per Month",
        "price_per_sqft": null,
        "fees": {
            "security_deposit": 90000,
            "maintenance": null,
            "brokerage": null
        },
        "unit_type": "1 BHK",
        "bedrooms": 1,
        "rooms": 1,
        "bathrooms": 2,
        "area": 432,
        "area_unit": "sqft",
        "property_type": "Apartment",
        "project": "Ruparel Elara",
        "city": "Mumbai",
        "locality": "Kandivali West",
        "floor": "11",
        "total_floors": 23,
        "facing": "West",
        "available_from": "Immediately",
        "latitude": 19.207823,
        "longitude": 72.842471,
        "coordinates_precision": "locality",
        "furnishing_items": [
            "1 Fan",
            "1 Geyser"
        ],
        "amenities": {
            "all": [
                "Gymnasium",
                "Swimming Pool"
            ],
            "groups": {
                "Sports": [
                    "Gymnasium",
                    "Swimming Pool"
                ]
            }
        },
        "images": [
            "https://img.squareyards.com/secondaryPortal/optImages/IN_639156798884732438-2905260731283128.jpg"
        ],
        "agent": {
            "id": 130252,
            "name": "Sunil Kumar Mohanty",
            "type": "EMPLOYEE",
            "profile_url": "https://www.squareyards.com/agent/vijay-rajendra-singh/130252"
        }
    },
    "meta": {
        "endpoint_family": "listing",
        "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": "listing"
    },
    "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": "listing"
    },
    "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": "listing"
    },
    "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.