# Trouverunlogement Lescrous — 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 and browse student dormitory listings across France with location autocomplete and detailed accommodation information managed by CROUS. Get comprehensive details about available housing options, though you'll need authentication to check real-time room availability.

**Category:** Real Estate | **Website:** [trouverunlogement.lescrous.fr/](https://trouverunlogement.lescrous.fr/) | **Docs:** [parse.bot/marketplace/34fbe91e-e88b-44e1-a744-724fbc053080/trouverunlogement-lescrous-fr-api](https://parse.bot/marketplace/34fbe91e-e88b-44e1-a744-724fbc053080/trouverunlogement-lescrous-fr-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-trouverunlogement-lescrous-fr-api-34fbe91e/`
**Auth:** `Authorization: Bearer <LOCUS_API_KEY>`

## Endpoints

### filter_by_price

Filter housing search results by maximum monthly rent price in euros. Compares the provided max_price against each accommodation's minimum rent (stored in cents internally).

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `max_price` | number | Yes | Maximum monthly rent price in euros (e.g. 400 for €400/month). Accommodations with a minimum rent at or below this amount are returned. |
| `page` | integer | No | Page number for pagination. |
| `page_size` | integer | No | Number of results per page. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-trouverunlogement-lescrous-fr-api-34fbe91e/filter_by_price \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"max_price":"<number>","page":"<integer>","page_size":"<integer>"}'
```

### filter_by_room_type

Filter housing listings by accommodation type label. Performs a case-insensitive substring match on the accommodation label field.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. |
| `page_size` | integer | No | Number of results per page. |
| `room_type` | string | Yes | Room type to filter by (case-insensitive substring match on label, e.g. 'Studio', 'T1', 'T2', 'Chambre', 'Studette'). |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-trouverunlogement-lescrous-fr-api-34fbe91e/filter_by_room_type \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"page":"<integer>","page_size":"<integer>","room_type":"<string>"}'
```

### get_available_residences

Retrieve only accommodations that are currently marked as available for booking. Fetches the current page of listings and filters to those with available=true.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. |
| `page_size` | integer | No | Number of results per page. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-trouverunlogement-lescrous-fr-api-34fbe91e/get_available_residences \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"page":"<integer>","page_size":"<integer>"}'
```

### get_residence_details

Get full details for a specific housing accommodation by its numeric ID. Returns comprehensive information including area, equipment, rent, residence description, transport links, and booking data.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `accommodation_id` | string | Yes | Numeric accommodation ID (e.g. '1311'). Obtainable from search_residences results items. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-trouverunlogement-lescrous-fr-api-34fbe91e/get_residence_details \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"accommodation_id":"<string>"}'
```

### list_crous_regions

List all CROUS regional organizations across France with their IDs and names. Returns a static list of 24 CROUS regions.

**Estimated cost:** Metered

_No parameters required._

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-trouverunlogement-lescrous-fr-api-34fbe91e/list_crous_regions \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'
```

### search_residences

Search for student housing accommodations across France. Returns a paginated list of accommodations with residence details, rent prices, equipment, and availability status. Also includes aggregation data with map markers and filter counts. Default page size is 24.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `occupation_modes` | string | No | Comma-separated occupation mode filters. Accepted values: 'alone', 'couple', 'house_sharing'. |
| `page` | integer | No | Page number for pagination. |
| `page_size` | integer | No | Number of results per page. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-trouverunlogement-lescrous-fr-api-34fbe91e/search_residences \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"occupation_modes":"<string>","page":"<integer>","page_size":"<integer>"}'
```

### search_residences_by_city

Search and filter housing listings by city name. Performs a case-insensitive text match against the residence address and label fields within the current page of results.

**Estimated cost:** Metered

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `city` | string | Yes | City name to search for (case-insensitive match against residence address and label, e.g. 'Tulle', 'Montpellier', 'Evry'). |
| `page` | integer | No | Page number for pagination. |
| `page_size` | integer | No | Number of results per page. |

```bash
curl -X POST https://api.paywithlocus.com/api/wrapped/parse-trouverunlogement-lescrous-fr-api-34fbe91e/search_residences_by_city \
  -H "Authorization: Bearer YOUR_LOCUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"city":"<string>","page":"<integer>","page_size":"<integer>"}'
```