/pap/listings

POST /api/pap/listings

Price: 5 credits

Get full PAP.fr real estate listing details by reference number (or listing URL): title, property type, transaction type, price and price per m², living area, number of rooms and bedrooms, floor, energy (DPE) and greenhouse gas (GES) classes, full description, seller type, address (street, city, zip code, country), and photos.

How to use it

Fetch a single PAP.fr listing (annonce) by numeric reference number or a listing URL. Returns one item with id, url, document_title, property_type, transaction_type, price, price_currency, price_per_m2, area_m2, room_count, bedroom_count, floor, energy_class (DPE), gas_emission_class (GES), description, seller_type (Particulier/Agence), features, address (street, city, zip_code, country) and images.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• listing string required — PAP listing reference number or a listing URL containing it (examples: "462601281", "https://www.pap.fr/annonces/appartement-paris-7e-75007-r462601281"; minLength: 1)

Response

• @type string (default: "PapListing")
• id string required
• url string nullable
• document_title string nullable
• property_type string nullable
• transaction_type string nullable
• price number nullable
• price_currency string nullable
• price_per_m2 number nullable
• area_m2 number nullable
• room_count integer nullable
• bedroom_count integer nullable
• floor string nullable
• energy_class string nullable
• gas_emission_class string nullable
• description string nullable
• seller_type string nullable
• features array (default: [])
  • @type string (default: "PapListingFeature")
  • name string nullable
  • value string nullable
• address object nullable
  • @type string (default: "PapListingAddress")
  • street string nullable
  • city string nullable
  • zip_code string nullable
  • country string nullable
• images array (default: [])

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 — Listing not found (well-formed but nonexistent or expired reference number) 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.