# Sakani — 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.

> Browse popular housing projects and individual property units on Sakani, and retrieve current price range limits and platform version info for building search filters.

**Category:** Real Estate | **Website:** [sakani.sa/](https://sakani.sa/) | **Docs:** [parse.bot/marketplace/8d03c1d4-df85-4a98-bd84-43600181d47d/sakani-sa-api](https://parse.bot/marketplace/8d03c1d4-df85-4a98-bd84-43600181d47d/sakani-sa-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/sakani/`
**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 popular projects

Retrieve popular land and real estate projects from the sakani.sa marketplace, sorted by popularity. Each project includes pricing range, developer information, media URLs, unit availability statistics, and government subsidy eligibility tags. Results are filtered by geography and project type. No pagination — the full filtered set is returned in one response (capped by limit).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `city_id` | integer | No | Filter by city ID (e.g. 14 for Riyadh). |
| `limit` | integer | No | Maximum number of projects to return. |
| `project_type` | string | No | Filter by project type. |
| `region_id` | integer | No | Filter by region ID (e.g. 1 for Riyadh region). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/sakani/get-popular-projects \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"city_id":"<integer>","limit":"<integer>","project_type":"<string>","region_id":"<integer>"}'
```

### Get popular units

Retrieve individual property units from the sakani.sa marketplace, sorted by popularity. Each unit includes pricing, size, bedroom/bathroom counts, floor number, and associated project information. Results are filtered by geography, unit type, bedrooms, and price range. No pagination — the full filtered set is returned in one response (capped by limit).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `bedrooms` | integer | No | Filter by number of bedrooms. |
| `city_id` | integer | No | Filter by city ID (e.g. 14 for Riyadh). |
| `limit` | integer | No | Maximum number of units to return. |
| `max_price` | integer | No | Maximum price filter in SAR. |
| `min_price` | integer | No | Minimum price filter in SAR. |
| `region_id` | integer | No | Filter by region ID (e.g. 1 for Riyadh region). |
| `unit_type` | string | No | Filter by unit type. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/sakani/get-popular-units \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"bedrooms":"<integer>","city_id":"<integer>","limit":"<integer>","max_price":"<integer>","min_price":"<integer>","region_id":"<integer>","unit_type":"<string>"}'
```

### Get price ranges

Retrieve the highest unit sale and rental prices currently available in the sakani.sa marketplace. Useful for setting upper bounds on price filters in search queries. Returns two integers representing the maximum observed sale price and rental price in SAR.

**Estimated cost:** Metered

_No parameters required._

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

### Get version info

Retrieve the current API deployment version hash from sakani.sa. Returns a single version string identifying the currently deployed marketplace API build.

**Estimated cost:** Metered

_No parameters required._

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

## 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.