# Zameen — Wrapped API

> **You are on:** `https://api.paywithlocus.com/api` | [llms.txt](https://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 browse Pakistani real estate listings with detailed property information including prices, photos, and seller contact numbers. Find your ideal property by filtering through thousands of active listings on Zameen.com's marketplace.

**Category:** Real Estate | **Website:** [zameen.com/](https://zameen.com/) | **Docs:** [parse.bot/marketplace/2bf9e543-e4dc-45c5-b807-b160f9167e77/zameen-com-api](https://parse.bot/marketplace/2bf9e543-e4dc-45c5-b807-b160f9167e77/zameen-com-api)

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

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/credits/zameen/`
**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 property

Retrieve full details for a single property listing by its Zameen ID. Returns price, all contact phone numbers, WhatsApp, location coordinates, agency info, and description.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `property_id` | string | Yes | Zameen property external ID (numeric string, e.g. from search_properties results). |

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

### Search properties

Search property listings by city and location. Returns paginated results including price, contact phone numbers, WhatsApp, and agency information. Results are sorted by relevance and recency.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category` | string | No | Property category filter. |
| `city` | string | No | City name as it appears in Zameen URL slugs (e.g. Lahore, Karachi, Islamabad). |
| `location_id` | string | No | Zameen location identifier. Combined with city to form the search scope (e.g. '1' for Lahore city-wide, '9' for DHA Defence Lahore). |
| `page` | integer | No | Page number for pagination (1-based). |
| `page_size` | integer | No | Number of results per page (1-50). |
| `purpose` | string | No | Listing purpose filter. |

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

## Next steps

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