# 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. Each call is automatically billed to your wallet in USDC.

## Access

**Base URL:** `https://api.paywithlocus.com/api/wrapped/parse-spotahome-com-api-78f1f4da/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## 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/parse-spotahome-com-api-78f1f4da/get_landlord_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -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/parse-spotahome-com-api-78f1f4da/get_listing_availability \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -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/parse-spotahome-com-api-78f1f4da/get_listing_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -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/parse-spotahome-com-api-78f1f4da/search_listings \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -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>"}'
```