Skip to main content
POST
/onthemarket/properties/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
search_type
enum<string>
required
Available options:
for-sale,
to-rent,
new-homes
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
min_price
integer | null
Required range: x >= 0
max_price
integer | null
Required range: x >= 0
price_frequency
enum<string> | null
Available options:
pcm,
pw
min_bedrooms
integer | null
Required range: x >= 0
max_bedrooms
integer | null
Required range: x >= 0
property_type
enum<string>[] | null
Available options:
detached,
semi-detached,
terraced,
bungalow,
flats-apartments,
farms-land,
park-homes
keywords
string | null
added_since
enum<string> | null
Available options:
24-hours,
3-days,
7-days
sort
enum<string>
default:recommended
Available options:
recommended,
price_high,
price_low,
recent
include_under_offer
boolean | null
include_let_agreed
boolean | null
furnished
enum<string> | null
Available options:
furnished,
part-furnished,
unfurnished
let_length
enum<string> | null
Available options:
long-term,
short-term
auction
boolean | null
shared_ownership
boolean | null
new_build
boolean | null
retirement
boolean | null
student
boolean | null
shared_accommodation
boolean | null
pet_friendly
boolean | null
accessible_features
boolean | null
greener_choice
boolean | null
recently_reduced
boolean | null
matterport_tour
boolean | null
virtual_tour
boolean | null
video
boolean | null

Response

Successful Response

id
string
required
@type
string
default:OnthemarketPropertyCard
url
string | null
address
string | null
property_title
string | null
property_type
string | null
price
number | null
display_price
string | null
short_price
string | null
price_qualifier
string | null
bedroom_count
integer | null
bathroom_count
integer | null
features
string[]
image
string | null
images
string[]
latitude
number | null
longitude
number | null
main_label
string | null
added_reduced_label
string | null
is_spotlight
boolean | null
agent_id
integer | null
agent_name
string | null
agent_alias
string | null
agent_phone
string | null
agent_image
string | null