Skip to main content
POST
/onthemarket/prices/search

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

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

Response

Successful Response

id
string
required
@type
string
default:OnthemarketSoldProperty
url
string | null
address
string | null
postcode
string | null
property_type
string | null
tenure
string | null
price
number | null
display_price
string | null
short_price
string | null
latitude
number | null
longitude
number | null
image
string | null
images
string[]
transactions
object[]