# Squareyards — Wrapped API

> **You are on:** `https://api.beta.paywithlocus.com/api` | [llms.txt](https://beta.paywithlocus.com/llms.txt) | [docs](https://docs.paywithlocus.com)
>
> Locus runs on multiple environments -- make sure every URL you call matches your expected environment.
> | Environment | Landing | API | Docs |
> |---|---|---|---|
> | Production | paywithlocus.com | api.paywithlocus.com | docs.paywithlocus.com |
> | Beta | beta.paywithlocus.com | api.beta.paywithlocus.com | docs.paywithlocus.com |
> | Stage | stage.paywithlocus.com | api.stage.paywithlocus.com | docs.paywithlocus.com |
>
> If the API URL above doesn't match your expected environment, re-fetch this file from the correct domain.

> Search for residential and commercial properties for sale or rent, view detailed property information, and discover price trends and insights across Indian cities to make informed real estate decisions. Access locality rankings, plot listings, and city-level market analytics to compare neighborhoods and track property values over time.

**Category:** Real Estate | **Website:** [squareyards.com/](https://squareyards.com/) | **Docs:** [parse.bot/marketplace/05e380b3-6e80-4ddc-a79f-ca2f7914d045/squareyards-com-api](https://parse.bot/marketplace/05e380b3-6e80-4ddc-a79f-ca2f7914d045/squareyards-com-api)

Pay-per-use API proxy for Locus Pro. Each call burns credits from your workspace balance.

## Access

**Base URL:** `https://api.beta.paywithlocus.com/api/wrapped/credits/squareyards/`
**Auth:** `Authorization: Bearer <LOCUS_CREDITS_SECRET_KEY>` (an `lcr_` secret key or a scoped `lcac_` agent credential)
**Required header:** `Idempotency-Key: <fresh UUID per call>`. A retry with the same key replays the stored result without a new charge.
**Response:** the provider response after any endpoint-specific normalization. `X-Locus-Credits-Charged` carries the charge and `X-Locus-Credits-Balance` the remaining balance. Insufficient credits return `402` before the provider is called.
**Pricing:** estimated costs below are USD. Locus debits the credit equivalent at your workspace rate.

Full call contract: https://docs.paywithlocus.com/api-reference/introduction

> Using a Pay With Locus wallet key (`claw_` prefix)? Wallet routes are documented separately: https://docs.paywithlocus.com/wrapped-apis/for-agents

## Endpoints

### Get city price insights

Get micromarket-level average price insights for a city. Returns price data segmented by category (all, new-sale, resale) with 3-month, 6-month, and 1-year aggregations. Each micromarket entry includes current rate, change percentage, and transaction volume.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `city` | string | No | City name in lowercase. Confirmed working: mumbai, bangalore. Other cities may return empty results. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/squareyards/get-city-price-insights \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"city":"<string>"}'
```

### Get city sales trend

Get quarterly price and transaction trends for a city. Returns chart data with average rate per sq.ft. and number of transactions over recent quarters, segmented by category (all, new-sale, resale). Each category includes line chart data for prices and bar chart data for transaction counts.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `city` | string | No | City name in lowercase. Confirmed working: mumbai, bangalore. Other cities may return empty results. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/squareyards/get-city-sales-trend \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"city":"<string>"}'
```

### Get property detail

Get detailed information about a specific property by its full SquareYards URL. Returns price, builder, amenities, highlights, and schema.org structured data when available. Resale property URLs typically include richer embedded data; rental URLs may return only schema.org structured data.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Full property URL from SquareYards (e.g. https://www.squareyards.com/resale-<property-slug>/<listing-id>). Typically sourced from search_properties_for_sale or search_properties_for_rent listings[*].url. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/squareyards/get-property-detail \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"url":"<string>"}'
```

### List top localities

List top localities in a city ranked by transaction volume. Returns locality-level data segmented by category (all, new-sale, resale) with 3-month, 6-month, and 1-year aggregations. Each locality includes current rate, change percentage, and transaction count.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `city` | string | No | City name in lowercase. Confirmed working: mumbai, bangalore. Other cities may return empty results. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/squareyards/list-top-localities \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"city":"<string>"}'
```

### Search commercial properties

Search for commercial properties for sale in a city. Includes office spaces, shops, showrooms, warehouses, and land. Returns paginated listings (~25 per page) with title, price, and agent info.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `city` | string | No | City name in lowercase (e.g. mumbai, delhi, bangalore). |
| `page` | integer | No | Page number for pagination. |
| `type` | string | No | Listing type. Accepted value: sale. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/squareyards/search-commercial-properties \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"city":"<string>","page":"<integer>","type":"<string>"}'
```

### Search plots land

Search for plots and land for sale in a city. Returns paginated listings of plots and land parcels with title, price, and agent info.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `city` | string | No | City name in lowercase (e.g. mumbai, delhi, bangalore). |
| `page` | integer | No | Page number for pagination. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/squareyards/search-plots-land \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"city":"<string>","page":"<integer>"}'
```

### Search properties for rent

Search for properties for rent in a specific Indian city. Returns paginated rental listings (~25 per page) with title, price, locality, and agent info. Use the page parameter to advance through results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `city` | string | No | City name in lowercase (e.g. mumbai, delhi, bangalore, pune, hyderabad). |
| `page` | integer | No | Page number for pagination. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/squareyards/search-properties-for-rent \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"city":"<string>","page":"<integer>"}'
```

### Search properties for sale

Search for properties for sale in a specific Indian city. Returns paginated listings (~25 per page) with title, price, locality, and agent info. Use the page parameter to advance through results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `city` | string | No | City name in lowercase (e.g. mumbai, delhi, bangalore, pune, hyderabad). |
| `page` | integer | No | Page number for pagination. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/squareyards/search-properties-for-sale \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"city":"<string>","page":"<integer>"}'
```

## Next steps

- [All wrapped API providers](https://beta.paywithlocus.com/wapi/index.md): pick another provider.
- [Find and call tools](https://beta.paywithlocus.com/agent/tools.md): price ceilings, async results, and errors.
- [Credits and billing](https://beta.paywithlocus.com/agent/billing.md): what a call costs and how to add credits.
- [Agent docs index](https://beta.paywithlocus.com/agent/index.md): every Locus agent page.