# Housing — 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 and retrieve real estate listings on Housing.com. Browse properties for sale, rent, plots, and commercial spaces across major Indian cities with filtering by locality and property type.

**Category:** Real Estate | **Website:** [housing.com/](https://housing.com/) | **Docs:** [parse.bot/marketplace/65dcebd0-c3be-4639-8460-14a41a823101/housing-com-api](https://parse.bot/marketplace/65dcebd0-c3be-4639-8460-14a41a823101/housing-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/housing/`
**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 flats listings

Search specifically for flats/apartments on Housing.com. Applies a 'Flats' property type filter to the generic search. Returns paginated flat listings filtered by property type.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `city` | string | No | City name to search in. Supported cities include Mumbai, Pune, Bengaluru, Hyderabad, Chennai, Delhi, Kolkata, Ahmedabad, Noida, Gurgaon, Navi Mumbai, Thane. |
| `locality` | string | No | Specific locality within the city to narrow results (e.g. 'Bandra', 'Andheri', 'Koramangala'). |
| `page` | integer | No | Page number for pagination. |
| `service` | string | No | Service type: 'buy' or 'rent'. |

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

### Get property detail

Get basic details for a specific project on Housing.com given its listing ID. Returns the project name, address (as locality array), developer name, and canonical URL. Only works for project-type listings (propertyType 'project' in search results). Resale listing IDs will return input_not_found.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `property_id` | string | Yes | Numeric project listing ID from search results where propertyType is 'project' (e.g. '352300'). Also accepts full slug (e.g. '352300-godrej-elaris-by-godrej-properties-ltd-in-mundhwa'). The numeric prefix is extracted as the project identifier. |

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

### Search buy listings

Search for properties to buy on Housing.com. Returns paginated results including project and resale listings with price, area, address, and seller information. Results can be filtered by city and locality. Uses Housing.com's internal GraphQL search API, resolving city and locality to a search hash, then fetching paginated results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `city` | string | No | City name to search in. Supported cities include Mumbai, Pune, Bengaluru, Hyderabad, Chennai, Delhi, Kolkata, Ahmedabad, Noida, Gurgaon, Navi Mumbai, Thane. |
| `limit` | integer | No | Number of results per page. |
| `locality` | string | No | Specific locality within the city to narrow results (e.g. 'Bandra', 'Andheri', 'Koramangala'). When provided, results are filtered to properties in that locality. |
| `page` | integer | No | Page number for pagination. |

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

### Search listings

Generic search for property listings across all categories on Housing.com. Supports buy, rent, plots, commercial, and paying guest searches with optional property type and locality filters. Returns paginated results. This is the most flexible search endpoint, combining service type, category, and property type filtering.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category` | string | No | Category: 'residential' or 'commercial'. |
| `city` | string | No | City name to search in. Supported cities include Mumbai, Pune, Bengaluru, Hyderabad, Chennai, Delhi, Kolkata, Ahmedabad, Noida, Gurgaon, Navi Mumbai, Thane. |
| `limit` | integer | No | Number of results per page. |
| `locality` | string | No | Specific locality within the city to narrow results (e.g. 'Bandra', 'Andheri', 'Koramangala'). |
| `page` | integer | No | Page number for pagination. |
| `property_type` | string | No | Property type filter used in search query (e.g. 'Flats', 'Apartment', 'Villa', 'Plot'). |
| `service` | string | No | Service type: 'buy', 'rent', 'plots', 'commercial', 'paying_guest'. |

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

### Search rent listings

Search for properties to rent on Housing.com. Returns paginated rental listings with monthly rent, area, address, and seller information. Internally sets service to 'rent' and delegates to the search infrastructure.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `city` | string | No | City name to search in. Supported cities include Mumbai, Pune, Bengaluru, Hyderabad, Chennai, Delhi, Kolkata, Ahmedabad, Noida, Gurgaon, Navi Mumbai, Thane. |
| `limit` | integer | No | Number of results per page. |
| `locality` | string | No | Specific locality within the city to narrow results (e.g. 'Bandra', 'Andheri', 'Koramangala'). When provided, results are filtered to properties in that locality. |
| `page` | integer | No | Page number for pagination. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/housing/search-rent-listings \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"city":"<string>","limit":"<integer>","locality":"<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.