Skip to main content
POST
/onthemarket/agents/search

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
location_id
string
required
Minimum string length: 1
count
integer
required
Required range: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
radius
enum<string> | null
Available options:
0,
0.25,
0.5,
1,
2,
3,
4,
5,
7.5,
10,
15,
20,
30,
40
agent_name
string | null

Response

Successful Response

alias
string
required
@type
string
default:OnthemarketAgentCard
id
integer | null
url
string | null
name
string | null
company_name
string | null
address
string | null
phone
string | null
image
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
has_sale_properties
boolean | null
has_rent_properties
boolean | null
has_overseas_properties
boolean | null
is_enhanced
boolean | null