# Ejar — 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 verify licensed brokerage offices on Saudi Arabia's Ejar rental platform, and access verified broker registration details and Saudi regional information to make informed rental decisions. Find rental brokers by location and other filters to connect with legitimate property professionals in your area.

**Category:** Real Estate | **Website:** [http://ejar.sa/](http://ejar.sa/) | **Docs:** [parse.bot/marketplace/1999904e-0fbc-4444-be19-4a48e7ea4885/ejar-sa-api](https://parse.bot/marketplace/1999904e-0fbc-4444-be19-4a48e7ea4885/ejar-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/ejar/`
**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

### Check broker registration

Validates a broker office registration request by its numeric request number. Returns the registration status if found, or a not_found status with an error message if the request number does not exist. Solves an invisible reCAPTCHA v3 challenge per call.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `request_number` | string | Yes | Numeric broker office registration request number to validate. |

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

### Get regions

Returns all 13 Saudi administrative regions with Arabic/English names, geographic coordinates, and location identifiers. No parameters required. One fixed-cost request.

**Estimated cost:** Metered

_No parameters required._

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

### Search brokers

Searches registered brokerage offices on the Ejar platform with optional filters. Returns paginated results (10 per page). Filter by region (Drupal taxonomy term ID), city, district, or name. Page is 0-indexed.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `city` | string | No | City taxonomy term ID to filter by. Obtain from the site's city dropdown. |
| `district` | string | No | District taxonomy term ID to filter by. |
| `name` | string | No | Broker office name search text. |
| `page` | integer | No | 0-indexed page number for pagination. |
| `region` | string | No | Region taxonomy term ID to filter by (e.g. '169' for Riyadh, '170' for Makkah). Omitting returns all regions. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/ejar/search-brokers \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"city":"<string>","district":"<string>","name":"<string>","page":"<integer>","region":"<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.