/funda/listings/search

POST /api/funda/listings/search

Price: 5 credits

Search Funda real estate listings by area (city or city/neighbourhood) and mode (koop/huur/nieuwbouw/recreatie). Returns listing cards with address, price, living area, rooms, bedrooms, energy label, construction type, selling agent, photos and the listing detail url.

How to use it

Search Funda listings in an area. area is a city ('amsterdam') or city/neighbourhood ('amsterdam/cremerbuurt-west'); mode selects koop (for sale), huur (for rent), nieuwbouw (new build) or recreatie. Each result has id, url, object_type, offering_type, status, address (street, house_number, postcode, city, neighbourhood, province, country), price (numeric), price_label (sale condition, e.g. k.k./v.o.n.), living_area_m2, room_count, bedroom_count, energy_label, construction_type, blikvanger (promo headline), available_media_types, images, agent (id, name, association, url) and publish_date.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• area string required — Area to search in: a city, or city/neighbourhood (examples: "amsterdam", "utrecht", "amsterdam/cremerbuurt-west"; minLength: 1)
• mode string — Listing mode (default: "koop"; one of: "koop", "huur", "nieuwbouw", "recreatie")
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "FundaSearchListing")
• id string required
• url string nullable
• object_type string nullable
• offering_type string nullable
• status string nullable
• address object nullable
  • @type string (default: "FundaSearchAddress")
  • street string nullable
  • house_number string nullable
  • postcode string nullable
  • city string nullable
  • neighbourhood string nullable
  • province string nullable
  • country string nullable
• price integer nullable
• price_label string nullable
• living_area_m2 integer nullable
• room_count integer nullable
• bedroom_count integer nullable
• energy_label string nullable
• construction_type string nullable
• blikvanger string nullable
• available_media_types array (default: [])
• images array (default: [])
• agent object nullable
  • @type string (default: "FundaSearchAgent")
  • id string nullable
  • name string nullable
  • association string nullable
  • url string nullable
• publish_date 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 — The entity was not found, or a precondition failed 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.