# Jaap — 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 browse housing listings for sale or rent across the Netherlands with detailed property information including photos, characteristics, and agent details. Find homes by location using autocomplete suggestions and easily navigate through results with pagination.

**Category:** Real Estate | **Website:** [jaap.nl/](https://jaap.nl/) | **Docs:** [parse.bot/marketplace/bb605866-eaea-4b86-ad5b-0fa01873ca2e/jaap-nl-api](https://parse.bot/marketplace/bb605866-eaea-4b86-ad5b-0fa01873ca2e/jaap-nl-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/jaap/`
**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 detail

Get detailed information about a specific property listing on huislijn.nl, including full description, characteristics (rooms, area, build year), photos, and agent contact information. The listing URL is obtained from search_properties_for_sale or search_properties_for_rent results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `url` | string | Yes | Full URL of the property listing on huislijn.nl (e.g. 'https://www.huislijn.nl/koopwoning/nederland/noord-holland/4387136/welnastraat-293-amsterdam'). Listing URLs are returned by search_properties_for_sale and search_properties_for_rent in listings[*].url. |

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

### Get search suggestions

Get location autocomplete suggestions for a search query. Returns matching cities, municipalities, and streets with their geographic coordinates and listing counts. Useful for resolving location names before searching.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `query` | string | Yes | Search query for city, municipality, or street name (e.g. 'Amsterdam', 'Utrecht'). |

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

### Search properties for rent

Search for properties for rent in the Netherlands. Returns paginated listing results with street address, price, property type, and listing URL. When no location is provided, returns listings from across the country. Paginates via integer page number.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `location` | string | No | City, municipality, or region name to filter results (e.g. 'Amsterdam', 'Rotterdam'). Omitting returns nationwide listings. |
| `page` | integer | No | Page number for pagination. |

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

### Search properties for sale

Search for properties for sale in the Netherlands. Returns paginated listing results with street address, price, property type, and listing URL. When no location is provided, returns listings from across the country. Paginates via integer page number.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `location` | string | No | City, municipality, or region name to filter results (e.g. 'Amsterdam', 'Rotterdam'). Omitting returns nationwide listings. |
| `page` | integer | No | Page number for pagination. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/jaap/search-properties-for-sale \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"location":"<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.