# /seloger/listings/search

`POST /api/seloger/listings/search`

Price: 10 credits

Search SeLoger real estate listings by location (city, arrondissement, neighbourhood or postal code) with mode (achat/location), property type, price, area, room, bedroom, floor, price-per-m², land-area and energy-class (DPE) filters, free-text keywords, the full amenity checklist (terrace, balcony, lift, parking, garage, cellar, pool, garden, fireplace, caretaker, parquet, disabled access, south-facing, ground/top floor, furnished, flat-share, student and more) and ordering. Returns listing cards with title, property type, sale or rental distribution, price and price per m², living area, rooms, bedrooms, energy class, description, tags, address, nearby transport lines, photos, virtual tour and video links, the listing detail url and the listing agency.

## How to use it

Search SeLoger listings in a location. location is a city ('Lyon'), arrondissement ('Paris 15'), neighbourhood or postal code ('75015'); mode selects achat (for sale) or location (for rent); property_type filters appartement/maison/all; sort orders by price/area/date. Narrow with min_price/max_price, min_area/max_area, min_rooms, min_bedrooms, min_floor/max_floor, max_price_per_m2, min_land_area, energy_class (the energy performance classes to keep), keywords (free text the listing must mention) and the amenity flags (has_terrace, has_balcony, has_lift, has_parking, has_garage, has_box, has_cellar, has_basement, has_locker, has_pool, has_garden, has_fireplace, has_guardian, has_intercom, has_digicode, has_alarm, has_parquet, has_living_room, has_dining_room, has_separate_toilet, has_entrance_hall, has_view, is_unobstructed_view, is_south_facing, is_ground_floor, is_top_floor, has_disabled_access, needs_work, is_exclusive, has_price_drop, is_private_seller, has_video, has_virtual_tour; is_furnished, allows_flat_share and is_student_housing apply to rentals). Each result has id, url, title, property_type, distribution_type (BUY for sales, RENT for rentals), is_new, is_exclusive, is_life_annuity (viager), price (sale price for BUY, monthly rent for RENT), price_note (SeLoger's short code for what the price covers, e.g. cc for charges included, rentals only), price_per_m2, monthly_price (estimated monthly mortgage payment, sales only), area_m2, room_count, bedroom_count, energy_class, description, tags, city, zip_code, district, transport (nearby metro/rer/tram/train lines), images, photo_count (how many photos the listing has in total), virtual_tour_url, video_url and agency (id, name, is_private_seller, phone, url, website_url, image).

## Parameters

- `access-token` (string, required)

## Request body

- `timeout` (integer) — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
- `location` (string, required) — City, arrondissement, neighbourhood or postal code to search in (examples: "Paris 15", "Bordeaux", "Lyon", "75015"; minLength: 1)
- `mode` (string) — Listing mode (default: "achat"; one of: "achat", "location")
- `property_type` (string) — Property type filter (default: "all"; one of: "all", "appartement", "maison")
- `sort` (string) — Result ordering (default: "relevance"; one of: "relevance", "price_asc", "price_desc", "date_desc")
- `min_price` (integer, nullable) — Minimum price filter (min: 0)
- `max_price` (integer, nullable) — Maximum price filter (min: 0)
- `min_area` (integer, nullable) — Minimum living area filter in m² (min: 0)
- `max_area` (integer, nullable) — Maximum living area filter in m² (min: 0)
- `min_rooms` (integer, nullable) — Minimum number of rooms filter (min: 1)
- `min_bedrooms` (integer, nullable) — Minimum number of bedrooms filter (min: 1)
- `energy_class` (array) — Energy performance (DPE) classes to keep (default: []; one of: "A", "B", "C", "D", "E", "F", "G")
- `min_floor` (integer, nullable) — Minimum building floor filter (min: 0)
- `max_floor` (integer, nullable) — Maximum building floor filter (min: 0)
- `max_price_per_m2` (integer, nullable) — Maximum price per m² filter (min: 0)
- `min_land_area` (integer, nullable) — Minimum land area filter in m² (min: 0)
- `keywords` (array) — Free-text terms the listing must mention (default: []; examples: ["balcon","calme"])
- `has_terrace` (boolean) — Only listings with a terrace (default: false)
- `has_balcony` (boolean) — Only listings with a balcony (default: false)
- `has_lift` (boolean) — Only listings in a building with a lift (default: false)
- `has_parking` (boolean) — Only listings with parking (default: false)
- `has_garage` (boolean) — Only listings with a garage (default: false)
- `has_box` (boolean) — Only listings with a lock-up garage box (default: false)
- `has_cellar` (boolean) — Only listings with a cellar (default: false)
- `has_basement` (boolean) — Only listings with a basement (default: false)
- `has_locker` (boolean) — Only listings with a storage locker (default: false)
- `has_pool` (boolean) — Only listings with a swimming pool (default: false)
- `has_garden` (boolean) — Only listings with a garden (default: false)
- `has_fireplace` (boolean) — Only listings with a fireplace (default: false)
- `has_guardian` (boolean) — Only listings in a building with a caretaker (default: false)
- `has_intercom` (boolean) — Only listings with an intercom (default: false)
- `has_digicode` (boolean) — Only listings with a keypad entry (default: false)
- `has_alarm` (boolean) — Only listings with an alarm system (default: false)
- `has_parquet` (boolean) — Only listings with parquet flooring (default: false)
- `has_living_room` (boolean) — Only listings with a separate living room (default: false)
- `has_dining_room` (boolean) — Only listings with a dining room (default: false)
- `has_separate_toilet` (boolean) — Only listings with a separate toilet (default: false)
- `has_entrance_hall` (boolean) — Only listings with an entrance hall (default: false)
- `has_view` (boolean) — Only listings advertising a view (default: false)
- `is_unobstructed_view` (boolean) — Only listings with an unobstructed view (default: false)
- `is_south_facing` (boolean) — Only south-facing listings (default: false)
- `is_ground_floor` (boolean) — Only ground-floor listings (default: false)
- `is_top_floor` (boolean) — Only top-floor listings (default: false)
- `has_disabled_access` (boolean) — Only listings with disabled access (default: false)
- `needs_work` (boolean) — Only listings requiring renovation work (default: false)
- `is_exclusive` (boolean) — Only listings held exclusively by one agency (default: false)
- `has_price_drop` (boolean) — Only listings whose price recently dropped (default: false)
- `is_private_seller` (boolean) — Only listings sold directly by their owner (default: false)
- `has_video` (boolean) — Only listings with a video (default: false)
- `has_virtual_tour` (boolean) — Only listings with a virtual tour (default: false)
- `is_furnished` (boolean) — Only furnished rentals (rentals only) (default: false)
- `allows_flat_share` (boolean) — Only rentals open to flat sharing (rentals only) (default: false)
- `is_student_housing` (boolean) — Only student rentals (rentals only) (default: false)
- `count` (integer, required) — Max number of results to return (min: 1)

## Response

### 200 — Successful Response

- `@type` (string) (default: "SelogerSearchListing")
- `id` (string, required)
- `url` (string, nullable)
- `property_type` (string, nullable)
- `distribution_type` (string, nullable)
- `is_new` (boolean, nullable)
- `is_exclusive` (boolean, nullable)
- `is_life_annuity` (boolean, nullable)
- `price` (number, nullable)
- `price_note` (string, nullable)
- `price_per_m2` (number, nullable)
- `monthly_price` (number, nullable)
- `area_m2` (number, nullable)
- `room_count` (integer, nullable)
- `bedroom_count` (integer, nullable)
- `energy_class` (string, nullable)
- `description` (string, nullable)
- `tags` (array) (default: [])
- `city` (string, nullable)
- `zip_code` (string, nullable)
- `district` (string, nullable)
- `transport` (array) (default: [])
  - `@type` (string) (default: "SelogerListingTransport")
  - `type` (string, nullable)
  - `lines` (array) (default: [])
- `images` (array) (default: [])
- `photo_count` (integer, nullable)
- `virtual_tour_url` (string, nullable)
- `video_url` (string, nullable)
- `agency` (object, nullable)
  - `@type` (string) (default: "SelogerSearchAgency")
  - `id` (string, nullable)
  - `name` (string, nullable)
  - `is_private_seller` (boolean, nullable)
  - `phone` (string, nullable)
  - `url` (string, nullable)
  - `website_url` (string, nullable)
  - `image` (string, nullable)

## Errors

### 422 — Validation Error

The request body did not validate

What to do: Check the fields against this schema. A URN with the wrong prefix is the most common cause.

- `detail` (array)
  - `loc` (array, required)
  - `msg` (string, required)
  - `type` (string, required)
  - `input` (any)
  - `ctx` (object)

### 408

The request ran past its time limit

What to do: Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.

### 412

Location could not be resolved

What to do: Retrying will not help: either the entity does not exist, or the input points at a different one.

### 429

Too many requests: a rate limit or a usage window is exhausted

What to do: When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.

### 500

Something broke on our side

What to do: Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.

### 529

Rate limit reached, or the endpoint is overloaded

What to do: Wait at least 30 seconds, then retry.

## Response envelope

Success: Array of objects (may be empty if no results)

Error: Error may coexist with partial results if it occurs mid-execution. Check X-Error header and status code.

Every response carries these headers:

- `X-Error` — Error message text (present only on error)
- `X-Request-ID` — Unique request identifier
- `X-Execution-Time` — Execution time in seconds
- `X-Result-Count` — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
- `X-Total-Available-Results` — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
- `X-Warning` — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
- `X-Retry-After` — Seconds to wait before retrying. Present only on 429.