Skip to main content
POST
/onthemarket/properties

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

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

Response

Successful Response

id
string
required
@type
string
default:OnthemarketProperty
url
string | null
address
string | null
postcode
string | null
property_title
string | null
property_type
string | null
search_type
string | null
status
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
summary
string | null
features
string[]
labels
string[]
key_info
object[]
epc_rating
string | null
epc_date
string | null
council_tax_band
string | null
tenure
string | null
ground_rent
string | null
service_charge
string | null
broadband_type
string | null
broadband_download_mbps
integer | null
broadband_upload_mbps
integer | null
mobile_signal_ee
string | null
mobile_signal_o2
string | null
mobile_signal_three
string | null
mobile_signal_vodafone
string | null
crime_score
integer | null
crime_level
string | null
area_average_price
string | null
area_average_price_label
string | null
latitude
number | null
longitude
number | null
image
string | null
images
string[]
floorplans
string[]
epc_graphs
string[]
documents
string[]
stations
object[]
schools
object[]
tours
object[]
view_count
string | null
added_reduced_label
string | null
is_new_home
boolean | null
is_premium
boolean | null
is_student
boolean | null
is_overseas
boolean | null
is_exclusive
boolean | null
has_matterport_tour
boolean | null
has_video_tour
boolean | null
agent
object | null