Skip to main content
POST
/
api
/
pararius
/
agents
/
properties
/pararius/agents/properties
curl --request POST \
  --url https://api.anysite.io/api/pararius/agents/properties \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "agent": "<string>",
  "count": 2,
  "timeout": 300,
  "mode": "for_rent",
  "city": "",
  "alias": ""
}
'
[
  {
    "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
agent
string
required

Pararius agent (makelaar) URL, or a city/slug pair identifying the agent

Minimum string length: 1
Examples:

"https://www.pararius.com/real-estate-agents/amsterdam/my-home-amsterdam"

"amsterdam/my-home-amsterdam"

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

List the agent's rentals or properties for sale

Available options:
for_rent,
for_sale
city
string
default:""
alias
string
default:""

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