Skip to main content
POST
/onthemarket/properties/similar

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
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:OnthemarketSimilarProperty
url
string | null
address
string | null
property_title
string | null
property_type
string | null
price
number | null
display_price
string | null
price_qualifier
string | null
bedroom_count
integer | null
bathroom_count
integer | null
image
string | null
is_premium
boolean | null
is_spotlight
boolean | null
is_exclusive
boolean | null
is_recently_added
boolean | null
agent_id
integer | null
agent_name
string | null
agent_alias
string | null
agent_image
string | null