Compass
Search Compass listings, property details, map clusters, and public agent profiles. Results are public listings only. Photos, history, and other fields are omitted when a listing does not have them. Listing data includes attribution and compliance fields. This API does not grant the right to republish that content.
Version: 2.0.0•Category: Real Estate
GET /api/listings/search
Search public sale and rental listings. Choose a market with geography, or send all four bounding-box coordinates, but not both. Status filters apply to sales only. The result count is the total reported for the search, and a page does not include every match. Some listings omit photos, history, or other fields.
Parameters
geography
STRING
Market slug, such as miami. This is a market area, not an exact city boundary. Send this or all four bounding-box coordinates, not both.
ne_lat
NUMBER
One corner of the bounding box. Send ne_lat, ne_lng, sw_lat, and sw_lng together. sw_lat must be less than ne_lat, and sw_lng must be less than ne_lng. Boxes that cross the antimeridian are not supported. On a search endpoint, send these coordinates or geography, but not both.
ne_lng
NUMBER
One corner of the bounding box. Send ne_lat, ne_lng, sw_lat, and sw_lng together. sw_lat must be less than ne_lat, and sw_lng must be less than ne_lng. Boxes that cross the antimeridian are not supported. On a search endpoint, send these coordinates or geography, but not both.
sw_lat
NUMBER
One corner of the bounding box. Send ne_lat, ne_lng, sw_lat, and sw_lng together. sw_lat must be less than ne_lat, and sw_lng must be less than ne_lng. Boxes that cross the antimeridian are not supported. On a search endpoint, send these coordinates or geography, but not both.
sw_lng
NUMBER
One corner of the bounding box. Send ne_lat, ne_lng, sw_lat, and sw_lng together. sw_lat must be less than ne_lat, and sw_lng must be less than ne_lng. Boxes that cross the antimeridian are not supported. On a search endpoint, send these coordinates or geography, but not both.
listing_type
ENUM
sale or rental. Defaults to sale.
limit
NUMBER
How many listings to return, from 1 to 50. Defaults to 10.
start
NUMBER
How many results to skip. Do not combine this with cursor.
cursor
STRING
Page token returned as nextCursor. Keep the same filters when you turn the page.
min_price
NUMBER
Minimum sale price, or minimum monthly rent when listing_type is rental.
max_price
NUMBER
Maximum sale price, or maximum monthly rent when listing_type is rental.
min_bedrooms
NUMBER
Minimum number of bedrooms. The minimum cannot be greater than the maximum. A listing with no bedroom count is not treated as zero.
max_bedrooms
NUMBER
Maximum number of bedrooms. The maximum cannot be less than the minimum. A listing with no bedroom count is not treated as zero.
min_bathrooms
NUMBER
Minimum number of bathrooms. A listing with no bathroom count is not treated as zero.
min_sqft
NUMBER
Minimum interior size in square feet. The minimum cannot be greater than the maximum.
max_sqft
NUMBER
Maximum interior size in square feet. The maximum cannot be less than the minimum.
max_days_on_market
NUMBER
Maximum days on market.
property_types
STRING
Comma-separated property types, such as Land or Single Family. Use names from the property-types endpoint.
features
STRING
Comma-separated features, such as Pool. Use names from the features endpoint. Not every feature is available in every market.
status
ENUM
Sale listings only: active, coming_soon, contingent, pending, or sold. Cannot be used with rentals. A pending listing may be labeled Pending or Active With Contract.
off_mls
BOOLEAN
When true, only off-MLS listings are returned. This is not the same as Coming Soon and does not include private listings.
portfolio_only
BOOLEAN
When true, only portfolio listings are returned. Results can include several brokerage brands, not only Compass.
new_construction
BOOLEAN
When true, only new-development listings are returned. When false or omitted, new construction is not excluded.
Code Examples
Language:
Client:
fetch('https://api.apivex.com/compass/api/listings/search?geography=miami&listing_type=sale&limit=10', {
method: 'GET',
headers: {
'x-apivex-key': 'YOUR_API_KEY'
}
})
.then(response => response.json())
.then(data => console.log(data));Responses
200
Successful response