# Spotahome — 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 rental properties on Spotahome and retrieve detailed listing information including pricing, availability, amenities, pet policy, and landlord profiles. Filter by city, budget, dates, and more to explore mid- to long-term rental options across Spotahome's global inventory.

**Category:** Real Estate | **Website:** [spotahome.com/](https://spotahome.com/) | **Docs:** [parse.bot/marketplace/78f1f4da-eb8e-498d-9c38-e0bd605eca50/spotahome-com-api](https://parse.bot/marketplace/78f1f4da-eb8e-498d-9c38-e0bd605eca50/spotahome-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/spotahome/`
**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 landlord details

Get landlord profile information and scoring details for a listing including name, response time, experience, and booking history. Requires a valid listing ID obtained from search_listings.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `listing_id` | string | Yes | The unique numeric ID of the listing (from search_listings results[*].id) |

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

### Get listing availability

Get availability and booking information for a listing including move-in date, minimum/maximum stay duration, instant booking status, and cancellation policy. Requires a valid listing ID obtained from search_listings.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `listing_id` | string | Yes | The unique numeric ID of the listing (from search_listings results[*].id) |

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

### Get listing details

Retrieve full details for a specific listing by its numeric ID. Returns comprehensive property information including features, pricing, photos, landlord info, city data, availability calendar, booking conditions, and listing statistics. Requires a valid listing ID obtained from search_listings.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `listing_id` | string | Yes | The unique numeric ID of the listing (from search_listings results[*].id) |

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

### Search listings

Search for rental listings by city with optional budget, date, and pet-friendliness filters. Returns paginated results with listing summaries including price, location, and landlord scoring. Pagination via the page parameter; each page returns up to 60 listings from the city's total.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `city` | string | No | City slug (e.g. 'madrid', 'barcelona', 'berlin') |
| `max_budget` | integer | No | Maximum monthly rent budget in EUR |
| `min_budget` | integer | No | Minimum monthly rent budget in EUR |
| `move_in` | string | No | Move-in date in YYYY-MM-DD format |
| `move_out` | string | No | Move-out date in YYYY-MM-DD format |
| `page` | integer | No | Page number for pagination (1-based) |
| `pets_friendly` | boolean | No | Filter for pet-friendly listings (client-side text filter on title/description) |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/credits/spotahome/search-listings \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"city":"<string>","max_budget":"<integer>","min_budget":"<integer>","move_in":"<string>","move_out":"<string>","page":"<integer>","pets_friendly":"<boolean>"}'
```

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