Skip to main content
POST
/compass/listings/search

Authorizations

access-token
string
header
required

API token from the dashboard

Headers

access-token
string
required

Body

application/json
location
string
required
Minimum string length: 1
count
integer
required
Required range: x >= 1
timeout
integer
default:300
Required range: 20 <= x <= 1500
listing_type
enum<integer>
default:2
Available options:
2,
1
sale_statuses
enum<integer>[]
Available options:
9,
12,
7
property_types
enum<string>[] | null
Available options:
single_family,
condo,
co_op,
townhouse,
multi_family,
land,
mobile_manufactured
min_price
integer | null
Required range: x >= 0
max_price
integer | null
Required range: x >= 0
min_beds
integer | null
Required range: x >= 0
max_beds
integer | null
Required range: x >= 0
min_baths
integer | null
Required range: x >= 0
min_sqft
integer | null
Required range: x >= 0
max_sqft
integer | null
Required range: x >= 0
min_year_built
integer | null
Required range: x >= 0
max_year_built
integer | null
Required range: x >= 0
max_hoa
integer | null
Required range: x >= 0
min_lot_size_acres
number | null
Required range: x >= 0
max_lot_size_acres
number | null
Required range: x >= 0

Response

Successful Response

id
string
required
@type
string
default:CompassListingCard
price
number | null
price_label
string | null
address
string | null
region
string | null
beds
number | null
baths
number | null
sqft
integer | null
lot_acres
number | null
status_code
integer | null
badges
string[]
latitude
number | null
longitude
number | null
image
string | null
images
string[]