# Yad2 — 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 apartments and cars on Yad2's marketplace and access detailed listing information including photos, prices, and specifications. Instantly reveal seller contact information to connect directly with real estate agents and car dealers.

**Category:** Real Estate | **Website:** [yad2.co.il/](https://yad2.co.il/) | **Docs:** [parse.bot/marketplace/88c80fc9-71a4-4294-aec9-c4d7fdcbe672/yad2-co-il-api](https://parse.bot/marketplace/88c80fc9-71a4-4294-aec9-c4d7fdcbe672/yad2-co-il-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/yad2/`
**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 apartment listing details

Get full details of a specific apartment listing by its token. Returns comprehensive information including address, amenities, property details, pricing, and dates.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `token` | string | Yes | Listing token from search results (8-character alphanumeric string). |

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

### Get car listing details

Get full details of a specific car listing by its token. Returns comprehensive vehicle information including specifications, engine details, mileage, color, gearbox, and seller info.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `token` | string | Yes | Listing token from search_cars results (8-character alphanumeric string, e.g. de1yzyw0). |

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

### Reveal contact phone

Reveal the contact phone number for a specific listing. Returns the seller's name and phone number. May include agencyName and agencyLogo for dealer listings, and isVirtualPhoneNumber flag.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `category` | string | Yes | Listing category. Accepted values: 'realestate', 'vehicles'. |
| `token` | string | Yes | Listing token from search results (8-character alphanumeric string). |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/yad2/reveal-contact-phone \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"category":"<string>","token":"<string>"}'
```

### Search apartments for rent

Search for apartments for rent on Yad2. Returns a paginated list of rental listings from the specified region (defaults to region 1 - Center). Combines private, agency, and platinum listings. Supports filtering by price range and room count.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `city` | string | No | City ID (e.g. 5000 for Tel Aviv). |
| `page` | integer | No | Page number for pagination. |
| `price_max` | integer | No | Maximum monthly rent in ILS. |
| `price_min` | integer | No | Minimum monthly rent in ILS. |
| `rooms_max` | number | No | Maximum number of rooms (supports half-rooms, e.g. 4.5). |
| `rooms_min` | number | No | Minimum number of rooms (supports half-rooms, e.g. 2.5). |

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

### Search apartments for sale

Search for apartments for sale on Yad2. Returns a paginated list of sale listings from the specified region (defaults to region 1 - Center). Combines private, agency, and platinum listings. Supports filtering by price range and room count.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `city` | string | No | City ID (e.g. 5000 for Tel Aviv). |
| `page` | integer | No | Page number for pagination. |
| `price_max` | integer | No | Maximum price in ILS. |
| `price_min` | integer | No | Minimum price in ILS. |
| `rooms_max` | number | No | Maximum number of rooms (supports half-rooms, e.g. 4.5). |
| `rooms_min` | number | No | Minimum number of rooms (supports half-rooms, e.g. 2.5). |

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

### Search cars

Search for cars on Yad2 with optional filters. Returns a paginated list of vehicle listings matching the criteria. Results include pricing, manufacturer, model, year, and seller info. Paginated server-side (40 items per page); advance with page parameter.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `area` | string | No | Area ID for geographic filtering (numeric, e.g. 6 for HaKrayot area, 7 for Jerusalem area). |
| `manufacturer` | string | No | Manufacturer ID (numeric, e.g. 21 for Hyundai, 40 for Skoda, 30 for Mitsubishi). |
| `model` | string | No | Model ID (numeric, e.g. 10272). Must be used with manufacturer. |
| `page` | integer | No | Page number for pagination. |
| `price_max` | string | No | Maximum price in ILS (e.g. 100000). Combined with price_min into a range filter. |
| `price_min` | string | No | Minimum price in ILS (e.g. 50000). Combined with price_max into a range filter. |
| `year_max` | string | No | Maximum manufacturing year (e.g. 2026). Combined with year_min into a range filter. |
| `year_min` | string | No | Minimum manufacturing year (e.g. 2020). Combined with year_max into a range filter. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/yad2/search-cars \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"area":"<string>","manufacturer":"<string>","model":"<string>","page":"<integer>","price_max":"<string>","price_min":"<string>","year_max":"<string>","year_min":"<string>"}'
```

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