# Studapart — 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 thousands of student housing listings across France, including private rentals, shared apartments, and dorms, while viewing detailed information about pricing, amenities, availability, and individual rooms. Filter by location and residence type to find the perfect student accommodation that matches your needs.

**Category:** Real Estate | **Website:** [studapart.com/](https://studapart.com/) | **Docs:** [parse.bot/marketplace/af2c202d-8622-44ac-9d66-0957893ebd45/studapart-com-api](https://parse.bot/marketplace/af2c202d-8622-44ac-9d66-0957893ebd45/studapart-com-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/studapart/`
**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 listing detail residence

Get detailed information for a specific student residence by its numeric ID. Returns the first matching listing entry with full metadata including services, media, availability periods, description, and owner information. If the residence is not found, returns input_not_found.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `residence_id` | integer | Yes | Numeric ID of the residence (from search_listings or search_residences results, field residenceId). |

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

### Get residence rooms

Get the list of individual room types available within a student residence. Each room entry represents a distinct unit type (e.g. studio, T1, T2) with its own surface area, rent, and availability. Returns up to 100 rooms per residence.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `residence_id` | integer | Yes | Numeric ID of the residence (from search_listings or search_residences results, field residenceId). |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/studapart/get-residence-rooms \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"residence_id":"<integer>"}'
```

### List cities

Get the list of supported cities with their slugs and internal search tags. Use the slug values as the city parameter in search_listings and search_residences. Returns a static list of cities where Studapart has listings.

**Estimated cost:** Metered

_No parameters required._

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

### Search listings

Search for student housing listings by city with rent filters. Returns paginated results containing individual room/unit entries from both private rentals and student residences. Each item includes pricing, surface area, services, availability windows, and media. Pagination is manual via offset/limit; total count is returned for client-side page calculation.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `city` | string | No | City slug to search in. Use values from list_cities endpoint. |
| `limit` | integer | No | Number of results per page. |
| `offset` | integer | No | Offset for pagination (number of items to skip). |
| `rent_max` | integer | No | Maximum monthly rent including expenses, in euros. |
| `rent_min` | integer | No | Minimum monthly rent in euros. |

```bash
curl -X POST https://api.beta.paywithlocus.com/api/wrapped/credits/studapart/search-listings \
  -H "Authorization: Bearer $LOCUS_CREDITS_SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"city":"<string>","limit":"<integer>","offset":"<integer>","rent_max":"<integer>","rent_min":"<integer>"}'
```

### Search residences

Search specifically for student residences (résidences étudiantes) by city. Returns only residence-type listings, excluding private rentals. Pagination is manual via offset/limit.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `city` | string | No | City slug to search in. Use values from list_cities endpoint. |
| `limit` | integer | No | Maximum number of results to return. |
| `offset` | integer | No | Offset for pagination (number of items to skip). |

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