Compass.com avatar

Compass.com

Try for free

1 day trial then $12.00/month - No credit card required now

Go to Store
Compass.com

Compass.com

canadesk/compass-properties
Try for free

1 day trial then $12.00/month - No credit card required now

Search for US properties with advanced filters, or get details, offers and similar homes from the Compass URL. It's fast and costs little!

Operation

operationEnumOptional

Value options:

"se": string"gl": string"gs": string

Default value of this property is "se"

Format

formatEnumOptional

See Information tab!

Value options:

"raw": string"simplified": string

Default value of this property is "simplified"

Location or URL

locationstringRequired

Location for Search. URL for Get.

Default value of this property is "downtown los angeles"

Location Type

locationTypeEnumOptional

Only for Search. See Information tab!

Value options:

"first": string"5": string"2": string

Default value of this property is "first"

Price Range

pricestringOptional

Min-max. Leave empty for all. See Information tab!

Default value of this property is "300000-3750000"

Sort Order

sortOrderEnumOptional

Value options:

"asc": string"desc": string

Default value of this property is "asc"

Sort By

sortEnumOptional

Value options:

"price": string"recommended": string"beds": string"baths": string"sqft": string"ppsf": string"dom": string"addr": string"loc": string

Default value of this property is "price"

Bedrooms

bedsstringOptional

Min-max. Set 0 for studios.

Default value of this property is "1-4"

Minimum Bathrooms

bathsintegerOptional

A maximum of 6 will include 6+ bathrooms.

Default value of this property is 1

Property Type

propertyTypeEnumOptional

Type of property

Value options:

"all": string"Single Family": string"Condo": string"Townhouse": string"Co-op": string"Land": string"Multi Family": string

Default value of this property is "all"

Listing Type

listingTypeEnumOptional

Type of listing

Value options:

"all": string"0-2": string"3": string"4": string"5": string

Default value of this property is "all"

Listing Status

statusEnumOptional

Value options:

"all": string"12": string"9": string"2-3-11": string"8": string

Default value of this property is "9"

Sold Date

soldDateEnumOptional

Only relevant when Listing Status is set to Sold.

Value options:

"7days": string"30days": string"90days": string"6months": string"1year": string"2years": string"3years": string"anytime": string

Default value of this property is "6months"

On Market Since (days)

daysOnMarketintegerOptional

A maximum of 180 will include 180+ days.

Default value of this property is 0

Open House

openHouseEnumOptional

Value options:

"exclude": string"thisweekend": string"anytime": string

Default value of this property is "exclude"

Square Footage

sqftstringOptional

Min-max. Leave empty for all. See Information tab!

Default value of this property is "500-8000"

Year Built

builtstringOptional

Min-max. Leave empty for all. See Information tab!

Default value of this property is ""

Lot Size

lotSizestringOptional

Min-max. Leave empty for all. See Information tab!

Default value of this property is "2000-"

Stories

storiesstringOptional

Min-max. Leave empty for all. See Information tab!

Default value of this property is ""

Maximum HOA Fees (/m)

hoaintegerOptional

Default value of this property is 0

GreatSchools Rating

greatSchoolsRatingintegerOptional

Default value of this property is 0

School Level

schoolLevelEnumOptional

Only when GreatSchools rating is enabled.

Value options:

"all": string"0": string"1": string"2": string

Default value of this property is "all"

Include Unrated Schools

includeUnratedSchoolsbooleanOptional

Whether to include unrated schools

Default value of this property is false

Minimum Parking Spaces

parkingSpacesintegerOptional

A maximum of 5 will include 5+ parking spaces.

Default value of this property is 1

Has Washer

hasWasherbooleanOptional

Whether the property has a washer

Default value of this property is false

Has Outdoor Space

hasOutdoorbooleanOptional

Whether the property has outdoor space

Default value of this property is false

Has Basement

hasBasementbooleanOptional

Whether the property has a basement

Default value of this property is false

Has Garage

hasGaragebooleanOptional

Whether the property has a garage

Default value of this property is false

Has Air Conditioning

hasACbooleanOptional

Whether the property has air conditioning

Default value of this property is false

Has Waterfront

hasWaterfrontbooleanOptional

Whether the property has waterfront

Default value of this property is false

Has Elevator

hasElevatorbooleanOptional

Whether the property has an elevator

Default value of this property is false

Has Pool

hasPoolbooleanOptional

Whether the property has a pool

Default value of this property is false

Has Doorman

hasDoormanbooleanOptional

Whether the property has a doorman

Default value of this property is false

Delay

delayintegerOptional

Waiting time between requests.

Default value of this property is 2

Proxy configuration

proxyobjectOptional

Select proxies to be used by your crawler.

Developer
Maintained by Community

Actor Metrics

  • 1 monthly user

  • 0 No stars yet

  • Created in Feb 2025

  • Modified 11 hours ago