# Square Yards Listing Detail API Documentation

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.

- **Documentation:** [https://scrappa.co/docs/squareyards-api/squareyards_listing](https://scrappa.co/docs/squareyards-api/squareyards_listing)
- **API group:** Square Yards API
- **Endpoint:** `GET https://scrappa.co/api/squareyards/v1/listing`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `url` | string | No | 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. |
| `id` | integer | No | Numeric listing id such as 9306882. Use with category. |
| `category` | string | No | buy or rent. Needed with id. Defaults to buy. |

## Example request

```bash
#!/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"
```

## Example response

```json
{
    "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

| Status | Error | Description |
| --- | --- | --- |
| 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. |
| 404 | Resource Not Found | The requested Square Yards resource does not exist. The response is not billable. |
| 503 | Unexpected Upstream Response | Square Yards answered with a body that is not the documented shape. The response is not billable. |
| 503 | Upstream Unavailable | Square Yards was temporarily unavailable or blocked the request. The response is not billable and the request never answers 429. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)