Skip to main content
POST
/
api
/
pararius
/
properties
/
search
/pararius/properties/search
curl --request POST \
  --url https://api.anysite.io/api/pararius/properties/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "area": "<string>",
  "count": 2,
  "timeout": 300,
  "mode": "for_rent",
  "price_min": 1,
  "price_max": 1,
  "bedrooms_min": 2,
  "rooms_min": 2,
  "living_area_min": 2,
  "plot_area_min": 2,
  "construction_year_min": 1501,
  "construction_year_max": 1501,
  "radius_km": 2,
  "facilities": [],
  "situations": [],
  "published_since_days": 2
}
'
[
  {
    "id": "<string>",
    "@type": "@pararius_search_listing",
    "url": "<string>",
    "title": "<string>",
    "offering_type": "<string>",
    "postcode": "<string>",
    "city": "<string>",
    "district": "<string>",
    "price": 123,
    "price_label": "<string>",
    "living_area_m2": 123,
    "room_count": 123,
    "interior": "<string>",
    "is_highlighted": true,
    "image": "<string>",
    "agent": {
      "@type": "@pararius_search_agent",
      "name": "<string>",
      "alias": "<string>",
      "city": "<string>",
      "url": "<string>"
    }
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
area
string
required

Area to search in: a city, city area, district or neighbourhood slug

Minimum string length: 1
Examples:

"amsterdam"

"rotterdam"

"utrecht"

​
count
integer
required

Max number of results to return

Required range: x >= 1
​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
mode
enum<string>
default:for_rent

Search for rentals or properties for sale

Available options:
for_rent,
for_sale
​
property_type
enum<string> | null

Property type

Available options:
apartment,
house,
studio,
room
​
price_min
integer | null

Minimum price (€)

Required range: x >= 0
​
price_max
integer | null

Maximum price (€)

Required range: x >= 0
​
bedrooms_min
integer | null

Minimum number of bedrooms

Required range: x >= 1
​
rooms_min
integer | null

Minimum number of rooms

Required range: x >= 1
​
living_area_min
integer | null

Minimum living floor area (m²)

Required range: x >= 1
​
plot_area_min
integer | null

Minimum plot area (m², for-sale only)

Required range: x >= 1
​
interior
enum<string> | null

Interior / furnishing level

Available options:
shell,
upholstered,
furnished
​
construction_type
enum<string> | null

Construction type

Available options:
existing,
newly_built
​
construction_year_min
integer | null

Minimum construction year

Required range: x >= 1500
​
construction_year_max
integer | null

Maximum construction year

Required range: x >= 1500
​
radius_km
integer | null

Search radius around the area (km)

Required range: x >= 1
​
facilities
enum<string>[] | null

Required facilities

Available options:
air_conditioning,
balcony,
bath,
elevator,
fireplace,
garage,
garden,
parking,
roof_terrace,
toilet,
shower,
storage_room,
suitable_to_share,
swimming_pool
​
situations
enum<string>[] | null

Location situations

Available options:
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
enum<string> | null

Availability (for-rent)

Available options:
as_soon_as_possible,
within_1_month,
within_2_months,
within_3_months,
later
​
rental_period
enum<string> | null

Rental period (for-rent)

Available options:
indefinite,
temporary
​
published_since_days
integer | null

Only listings published within this many days

Required range: x >= 1

Response

Successful Response

​
id
string
required
​
@type
string
default:@pararius_search_listing
​
url
string | null
​
title
string | null
​
offering_type
string | null
​
postcode
string | null
​
city
string | null
​
district
string | null
​
price
integer | null
​
price_label
string | null
​
living_area_m2
integer | null
​
room_count
integer | null
​
interior
string | null
​
is_highlighted
boolean | null
​
image
string | null
​
agent
ParariusSearchAgent · object