Skip to main content
POST
/
api
/
domain
/
agents
/domain/agents
curl --request POST \
  --url https://api.anysite.io/api/domain/agents \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "agent": "<string>",
  "timeout": 300
}
'
[
  {
    "id": "<string>",
    "@type": "@domain_agency",
    "name": "<string>",
    "alias": "<string>",
    "url": "<string>",
    "description": "<string>",
    "website": "<string>",
    "profile_tier": "<string>",
    "is_archived": true,
    "image": "<string>",
    "cover": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "mobile": "<string>",
    "address": "<string>",
    "suburb": "<string>",
    "state": "<string>",
    "postcode": "<string>",
    "facebook_url": "<string>",
    "twitter_url": "<string>",
    "instagram_url": "<string>",
    "linkedin_url": "<string>",
    "youtube_url": "<string>",
    "for_sale_count": 123,
    "sold_count": 123,
    "private_treaty_count": 123,
    "auctioned_count": 123,
    "for_rent_count": 123,
    "leased_count": 123,
    "agents": []
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
agent
string
required

Domain agency id or agency profile URL containing it

Minimum string length: 1
Examples:

"37188"

"https://www.domain.com.au/real-estate-agencies/ljhookerbondibeach-37188/"

​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500

Response

Successful Response

​
id
string
required
​
@type
string
default:@domain_agency
​
name
string | null
​
alias
string | null
​
url
string | null
​
description
string | null
​
website
string | null
​
profile_tier
string | null
​
is_archived
boolean | null
​
image
string | null
​
cover
string | null
​
phone
string | null
​
email
string | null
​
mobile
string | null
​
address
string | null
​
suburb
string | null
​
state
string | null
​
postcode
string | null
​
facebook_url
string | null
​
twitter_url
string | null
​
instagram_url
string | null
​
linkedin_url
string | null
​
youtube_url
string | null
​
for_sale_count
integer | null
​
sold_count
integer | null
​
private_treaty_count
integer | null
​
auctioned_count
integer | null
​
for_rent_count
integer | null
​
leased_count
integer | null
​
agents
DomainAgencyContact · object[]