Skip to main content
POST
/onthemarket/overseas/search

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
country
enum<string>
required
Available options:
global,
anguilla,
antigua-and-barbuda,
australia,
austria,
barbados,
belgium,
cambodia,
canada,
cayman-islands,
costa-rica,
croatia,
cyprus,
dominican-republic,
ecuador,
fiji,
france,
germany,
gibraltar,
greece,
grenada,
hong-kong,
iceland,
india,
indonesia,
ireland,
italy,
jamaica,
kenya,
malaysia,
maldives,
malta,
mauritius,
mexico,
monaco,
montenegro,
morocco,
norway,
portugal,
puerto-rico,
romania,
saint-lucia,
saint-vincent-and-the-grenadines,
south-africa,
spain,
sri-lanka,
sweden,
switzerland,
taiwan,
thailand,
turkey,
turks-and-caicos-islands,
united-arab-emirates,
united-states-of-america
count
integer
required
Required range: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
region
string | null
min_price
integer | null
Required range: x >= 0
max_price
integer | null
Required range: x >= 0
min_bedrooms
integer | null
Required range: x >= 0
max_bedrooms
integer | null
Required range: x >= 0
added_since
enum<string> | null
Available options:
24-hours,
3-days,
7-days
sort
enum<string>
default:price_high
Available options:
recommended,
price_high,
price_low,
recent

Response

Successful Response

id
string
required
@type
string
default:OnthemarketOverseasProperty
url
string | null
address
string | null
property_title
string | null
price
number | null
display_price
string | null
local_price
string | null
price_qualifier
string | null
bedroom_count
integer | null
image
string | null
agent_id
integer | null
agent_name
string | null
agent_image
string | null