/pararius/properties/search

POST /api/pararius/properties/search

Price: 20 credits

Search Pararius real estate listings by area (city / city area / district / neighbourhood) and mode (rent or buy), with the full Pararius filter set: property type, price range, bedrooms, rooms, living area, plot area, interior, construction type, construction year, search radius, facilities, location situations, availability, rental period and published-since. Returns listing cards with address, price, living area, rooms, interior, agent, photo and the listing detail url.

How to use it

Search Pararius listings in an area. area is a location slug ('amsterdam', 'rotterdam'); mode selects rent or buy. Filters: property_type (apartment/house/studio/room), price_min/price_max, bedrooms_min, rooms_min, living_area_min, plot_area_min (buy), interior (shell/upholstered/furnished), construction_type (existing/newly_built), construction_year_min/max, radius_km, facilities[], situations[], available_from, rental_period, published_since_days. Each result has id, url, title, offering_type, postcode, city, district, price (numeric), price_label, living_area_m2, room_count, interior, is_highlighted, image and agent (name, alias, city, url).

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, city area, district or neighbourhood slug (examples: "amsterdam", "rotterdam", "utrecht"; minLength: 1)
• mode string — Search for rentals or properties for sale (default: "for_rent"; one of: "for_rent", "for_sale")
• count integer required — Max number of results to return (min: 1)
• property_type string nullable — Property type (one of: "apartment", "house", "studio", "room")
• price_min integer nullable — Minimum price (€) (min: 0)
• price_max integer nullable — Maximum price (€) (min: 0)
• bedrooms_min integer nullable — Minimum number of bedrooms (min: 1)
• rooms_min integer nullable — Minimum number of rooms (min: 1)
• living_area_min integer nullable — Minimum living floor area (m²) (min: 1)
• plot_area_min integer nullable — Minimum plot area (m², for-sale only) (min: 1)
• interior string nullable — Interior / furnishing level (one of: "shell", "upholstered", "furnished")
• construction_type string nullable — Construction type (one of: "existing", "newly_built")
• construction_year_min integer nullable — Minimum construction year (min: 1500)
• construction_year_max integer nullable — Maximum construction year (min: 1500)
• radius_km integer nullable — Search radius around the area (km) (min: 1)
• facilities array nullable — Required facilities (one of: "air_conditioning", "balcony", "bath", "elevator", "fireplace", "garage", "garden", "parking", "roof_terrace", "toilet", "shower", "storage_room", "suitable_to_share", "swimming_pool")
• situations array nullable — Location situations (one of: "in_residential_area", "at_calm_road", "near_public_transport", "in_center", "unobstructed_view", "by_water", "at_navigable_waterway", "near_school", "by_park", "near_shopping_center", "open_position", "sheltered_position", "at_busy_road", "in_wooded_area", "beside_forest", "at_business_park", "outside_built-up_area", "peripheral", "near_airport", "near_sea")
• available_from string nullable — Availability (for-rent) (one of: "as_soon_as_possible", "within_1_month", "within_2_months", "within_3_months", "later")
• rental_period string nullable — Rental period (for-rent) (one of: "indefinite", "temporary")
• published_since_days integer nullable — Only listings published within this many days (min: 1)

Response

• @type string (default: "ParariusSearchListing")
• id string required
• url string nullable
• offering_type string nullable
• postcode string nullable
• city string nullable
• district string nullable
• price integer nullable
• price_label string nullable
• living_area_m2 integer nullable
• room_count integer nullable
• interior string nullable
• is_highlighted boolean nullable
• image string nullable
• agent object nullable
  • @type string (default: "ParariusSearchAgent")
  • name string nullable
  • alias string nullable
  • city string nullable
  • url 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.