Skip to main content
POST
/
api
/
pararius
/
agents
/pararius/agents
curl --request POST \
  --url https://api.anysite.io/api/pararius/agents \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "agent": "<string>",
  "timeout": 300,
  "city": "",
  "alias": ""
}
'
[
  {
    "id": "<string>",
    "@type": "@pararius_agent",
    "name": "<string>",
    "alias": "<string>",
    "city": "<string>",
    "url": "<string>",
    "tagline": "<string>",
    "description": "<string>",
    "website_url": "<string>",
    "email": "<string>",
    "image": "<string>",
    "coordinates": [],
    "offerings": [],
    "employees": []
  }
]

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"

​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
city
string
default:""
​
alias
string
default:""

Response

Successful Response

​
id
string
required
​
@type
string
default:@pararius_agent
​
name
string | null
​
alias
string | null
​
city
string | null
​
url
string | null
​
tagline
string | null
​
description
string | null
​
website_url
string | null
​
email
string | null
​
image
string | null
​
coordinates
number[]
​
offerings
ParariusAgentOffering · object[]
​
employees
ParariusAgentEmployee · object[]