/pap/listings/search

POST /api/pap/listings/search

Price: 10 credits

Search PAP.fr real estate listings by location (city, arrondissement, department, region or postal code) for sale (vente) or rent (location), with property type, rooms, bedrooms, price, living area, land area, new-build exclusion and amenity filters. Returns listing cards with property type, price, living area, rooms, bedrooms, energy class, city, zip code, description snippet, photo and the listing detail url.

How to use it

Search PAP.fr listings in a location. location is a city ('Bordeaux'), arrondissement ('Paris 15'), department, region or postal code ('75015'); produit selects vente (for sale) or location (for rent); property_type filters one or more of appartement/maison/terrain/garage-parking/immeuble/etc.; rooms filters by number of rooms (1=studio … 6 = 6 or more); min_bedrooms, min_price/max_price, min_area/max_area, min_land_area/max_land_area, exclude_new and tags narrow the results. Each result has id, url, property_type, price, area_m2, room_count, bedroom_count, energy_class, city, zip_code, description and 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, department, region or postal code to search in (examples: "Bordeaux", "Paris 15", "Lyon", "75015"; minLength: 1)
• produit string — Listing type: sale (vente) or rent (location) (default: "vente"; one of: "vente", "location")
• property_type array — Property type filters (default: []; one of: "maison", "appartement", "terrain", "garage-parking", "immeuble", "surface-a-amenager", "peniche", "mobil-home", "viager", "multipropriete", "residence-avec-service", "bureaux", "local-commercial", "fonds-de-commerce", "local-d-activite", "divers")
• rooms array — Number-of-rooms filters (1=studio … 6 means 6+) (default: [])
• min_bedrooms integer nullable — Minimum number of bedrooms filter (min: 1; max: 6)
• 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_land_area integer nullable — Minimum land area filter in m² (min: 0)
• max_land_area integer nullable — Maximum land area filter in m² (min: 0)
• exclude_new boolean — Exclude new-build (neuf) listings (default: false)
• tags array — Amenity/characteristic filters (default: []; one of: "ascenseur", "duplex-triplex", "dernier-etage", "piscine", "balcon-terrasse", "garages-parkings", "acces-handicape", "investissement-locatif", "visite-virtuelle")
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "PapSearchListing")
• id string required
• url string nullable
• property_type string nullable
• price number nullable
• area_m2 number nullable
• room_count integer nullable
• bedroom_count integer nullable
• energy_class string nullable
• city string nullable
• zip_code string nullable
• description string nullable
• image string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit 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 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 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 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 Wait at least 30 seconds, then retry.

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