Skip to main content
POST
/onthemarket/agents

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
agent
string
required
Minimum string length: 1
timeout
integer
default:300
Required range: 20 <= x <= 1500

Response

Successful Response

alias
string
required
@type
string
default:OnthemarketAgent
id
integer | null
url
string | null
name
string | null
address
string | null
postcode
string | null
phone
string | null
website_url
string | null
image
string | null
cover
string | null
latitude
number | null
longitude
number | null
rank
integer | null
is_sales_agent
boolean | null
is_lettings_agent
boolean | null
is_overseas_agent
boolean | null
is_virtual
boolean | null
is_enhanced
boolean | null
sale_property_count
integer | null
rent_property_count
integer | null