Skip to main content
POST
/onthemarket/agents/properties

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
agent
string
required
Minimum string length: 1
transaction_type
enum<string>
required
Available options:
for-sale,
to-rent,
overseas
count
integer
required
Required range: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
sort
enum<string>
default:recent
Available options:
recommended,
price_high,
price_low,
recent
include_unavailable
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