# Compass.com (`canadesk/compass-properties`) Actor

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

- **URL**: https://apify.com/canadesk/compass-properties.md
- **Developed by:** [Canadesk Support](https://apify.com/canadesk) (community)
- **Categories:** Real estate, SEO tools, Lead generation
- **Features:** Full permissions
- **Stats:** 17 total users, 0 monthly users, 100.0% runs succeeded, 3 bookmarks
- **User rating**: No ratings yet

## Pricing

Pay per usage

This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-usage

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

### Input

- Operation (select)

  - Search: Returns list of properties matching the set filters. Location must NOT be URL.

    The default behaviour is the same as the website. However, you can also use Input "Location Type" to narrow down your search.

    For example, "Los Angeles" is likely to return a random neighbourhood instead of the full city area.

  - Get Listing: Returns details for the property. Location MUST be URL.

  - Get Similar Listings:  Returns homes similar to the property. Location MUST be URL.

- Location (select)

  Can be a city, address, etc. The first result hit will be used for the search.

  For URLs, the expected format is: https://www.compass.com/listing/{address}/{id}

- Filters

  All other fields are filters related to search. They are not compatible with "Get" operations.

### Output

**Search** returns:

```
{
	"listing": {
		"listingIdSHA": "1708228170181493545",
		"compassPropertyId": 55525616439822350,
		"feedListingId": "1708228170181493545",
		"listingType": 2,
		"sourceFilters": [
			3,
			2
		],
		"location": {
			"prettyAddress": "855 North Croft Avenue, Unit 309",
			"streetNumber": "855",
			"street": "Croft",
			"streetType": "Ave",
			"unitNumber": "309",
			"unitType": "Unit",
			"neighborhood": "West Hollywood Vicinity",
			"subNeighborhoods": [
				"West Hollywood Vicinity",
				"Central Los Angeles",
				"Los Angeles",
				"Los Angeles County"
			],
			"city": "Los Angeles",
			"state": "CA",
			"zipCode": "90069",
			"longitude": -118.3745458,
			"latitude": 34.0866344,
			"geoId": "la",
			"timezone": "America/Los_Angeles",
			"countyFipsCode": "06037"
		},
		"size": {
			"bedrooms": 2,
			"fullBathrooms": 3,
			"oneQuarterBathrooms": 0,
			"threeQuarterBathrooms": 0,
			"totalBathrooms": 3,
			"bathrooms": 3,
			"squareFeet": 1450,
			"levelsOrStories": "Levels: One"
		},
		"status": 0,
		"localizedStatus": "Active",
		"price": {
			"lastKnown": 1525000,
			"listed": 1525000,
			"charges": [
				{
					"chargeAmount": 590,
					"chargeType": 2
				}
			],
			"perSquareFoot": 1051.7241379310344,
			"monthlySalesCharges": 590,
			"monthlySalesChargesInclTaxes": 590,
			"formatted": "$1,525,000",
			"negotiability": 0,
			"lastPropertyClosePrice": 1300000
		},
		"date": {
			"listed": 1736409600000,
			"updated": 1739230696000,
			"daysOnMarket": 27,
			"priceStatusUpdated": 1736409600000,
			"lastPropertyCloseDate": 1559199600000
		},
		"events": [
			{
				"timestamp": 1736409600000,
				"status": 0,
				"price": 1525000,
				"source": {
					"externalSourceName": "la_crmls_rets",
					"externalSourceId": "24474487",
					"sourceDisplayName": "CRMLS"
				},
				"feedListingId": "1708228170181493545"
			}
		],
		"latestTransaction": true,
		"buildingInfo": {
			"buildingIdSHA": "302d21c9cecc08c2b7ec5c0494a5fde59462d7ce",
			"id": "837807385884238469",
			"buildingAddress": "855 N Croft Ave",
			"buildingName": "855 Croft",
			"buildingYearOpened": 2009,
			"pageLink": "/building/855-croft-los-angeles-ca/837807385884238469/"
		},
		"detailedInfo": {
			"amenities": [
				"Common Roof Deck",
				"Barbecue Area",
				"Elevator",
				"Garage",
				"Assigned Parking",
				"Common Media / Recreation Room",
				"Washer / Dryer in Unit",
				"Air Conditioning",
				"Private Outdoor Space",
				"Guest Parking",
				"Parking Included",
				"Pets Conditional",
				"Lowrise",
				"Unfurnished",
				"Security System"
			],
			"propertyType": {
				"masterType": {
					"GLOBAL": [
						"Condo"
					],
					"LOCAL_1": [
						"Residential"
					],
					"LOCAL_2": [
						"Condominium"
					]
				}
			},
			"outdoorSpace": [
				"Common Roof Deck",
				"Barbecue Area",
				"Private Outdoor Space"
			],
			"assessorDetails": {
				"assessorInfo": {
					"title": "Assessor Information",
					"propertyTax": {
						"taxYear": "2024",
						"tax": "$17,123",
						"dateUpdated": 1698710400000,
						"monthlyTax": "$1,427"
					},
					"assessment": {
						"title": "Taxable Value",
						"landValue": 437456,
						"additionsValue": 984280,
						"year": "2024",
						"previousValue": "$1,421,736",
						"dateUpdated": 1702080000000
					}
				},
				"categories": [
					{
						"name": "Home Facts",
						"subCategories": [
							{
								"fields": [
									{
										"key": "Beds",
										"value": "2"
									},
									{
										"key": "Total Finished SqFt",
										"value": "1,450 SqFt"
									},
									{
										"key": "Above Grade Finished SqFt",
										"value": "1,450 SqFt"
									},
									{
										"key": "Lot Size",
										"value": "26,705 SqFt"
									},
									{
										"key": "Style",
										"value": "Condominium"
									},
									{
										"key": "Year Built",
										"value": "2009"
									},
									{
										"key": "Zoning",
										"value": "LAR3"
									},
									{
										"key": "County",
										"value": "LOS ANGELES"
									},
									{
										"key": "APN",
										"value": "5529-003-114"
									}
								]
							}
						]
					}
				]
			},
			"totalParkingSpaces": 2,
			"waterfrontYN": false,
			"view": [
				"City Lights",
				"Tree Top"
			],
			"architecturalStyle": [
				"Contemporary"
			]
		},
		"media": [
			{
				"category": 0,
				"thumbnailUrl": "https://www.compass.com/m/16b3105276584751288ba82f080b3a72ddf9ff34_img_0_bef24/165x165.jpg",
				"originalUrl": "https://www.compass.com/m/16b3105276584751288ba82f080b3a72ddf9ff34_img_0_bef24/origin.jpg",
				"width": 1080,
				"height": 720
			},
			{
				"category": 0,
				"thumbnailUrl": "https://www.compass.com/m/16b3105276584751288ba82f080b3a72ddf9ff34_img_1_8c035/165x165.jpg",
				"originalUrl": "https://www.compass.com/m/16b3105276584751288ba82f080b3a72ddf9ff34_img_1_8c035/origin.jpg",
				"width": 1080,
				"height": 720
			},
			...
		],
		"dealInfo": {
			"transactionType": 0,
			"cobrokerFeePercent": 2.5,
			"courtesyOf": "Listing Courtesy of Compass, Catherine Shakib Kamran, DRE #01216928; Compass, Cathy Hou, DRE #02155230"
		},
		"isConsumerSearchable": true,
		"isOffMLS": false,
		"userListingCompliance": {
			"descriptionCompliance": 0
		},
		"parcelNumber": "5529-003-114",
		"externalId": "24-474487",
		"badges": {
			"cornerBadges": [
				{
					"badgeType": 0,
					"displayText": "Listed By Compass"
				}
			]
		},
		"databaseSource": {
			"externalSourceName": "la_claw_v2",
			"sourceDisplayName": "CLAW",
			"contributingDatasetList": [
				"la_claw_v2",
				"listing_editor_manual",
				"la_crmls_rets",
				"building"
			]
		},
		"pageLink": "/listing/855-north-croft-avenue-unit-309-los-angeles-ca-90069/1708228170181493545/",
		"navigationPageLink": "/listing/855-north-croft-avenue-unit-309-los-angeles-ca-90069/1708228170181493545/",
		"canonicalPageLink": "/listing/855-north-croft-avenue-unit-309-los-angeles-ca-90069/1708228170181493545/",
		"editable": true,
		"cloneable": false,
		"externalListingSha": "16b3105276584751288ba82f080b3a72ddf9ff34",
		"secondaryMlsIds": [
			"24474487"
		]
	}
}
```

**Get Similar listings** returns:

```
[
	{
		"listingIdSHA": "1739939710866521817",
		"compassPropertyId": 247144402521749630,
		"feedListingId": "1739939710866521817",
		"listingType": 2,
		"sourceFilters": [
			3
		],
		"location": {
			"prettyAddress": "723 Miramar Avenue South",
			"streetNumber": "723",
			"street": "Miramar",
			"streetType": "Ave",
			"neighborhood": "Spice Ranch",
			"subNeighborhoods": [
				"Spice Ranch",
				"San Jacinto",
				"Riverside County"
			],
			"city": "San Jacinto",
			"state": "CA",
			"zipCode": "92583",
			"longitude": -116.9457103,
			"latitude": 33.7798325,
			"geoId": "la",
			"timezone": "America/Los_Angeles",
			"countyFipsCode": "06065"
		},
		"size": {
			"bedrooms": 3,
			"fullBathrooms": 2,
			"oneQuarterBathrooms": 0,
			"halfBathrooms": 0,
			"threeQuarterBathrooms": 0,
			"totalBathrooms": 2,
			"bathrooms": 2,
			"squareFeet": 1120,
			"lotSizeInSquareFeet": 6098,
			"formattedLotSize": "0.14 AC / 6,098 SF",
			"levelsOrStories": "Levels: One, StoriesTotal: 1.0"
		},
		"status": 0,
		"localizedStatus": "Active",
		"price": {
			"lastKnown": 436000,
			"listed": 455000,
			"perSquareFoot": 389.2857142857143,
			"monthlySalesCharges": 0,
			"monthlySalesChargesInclTaxes": 0,
			"formatted": "$436,000",
			"negotiability": -0.041758241758241756
		},
		"date": {
			"listed": 1735200000000,
			"updated": 1738858714000,
			"daysOnMarket": 47,
			"priceStatusUpdated": 1735200000000,
			"cumulativeDaysOnMarket": 47
		},
		"events": [
			{
				"timestamp": 1735200000000,
				"status": 0,
				"price": 455000,
				"source": {
					"externalSourceName": "la_crmls_rets",
					"externalSourceId": "IV24253932",
					"sourceDisplayName": "CRMLS"
				},
				"feedListingId": "1739939710866521817"
			}
		],
		"latestTransaction": true,
		"buildingInfo": {
			"buildingIdSHA": "dd57670e36ae0f7ab02c63dc82c19e05f5a7a5a3",
			"buildingAddress": "723 Miramar Ave S",
			"buildingYearOpened": 1972
		},
		"detailedInfo": {
			"amenities": [
				"Washer / Dryer in Unit",
				"Air Conditioning",
				"Stainless Steel Appliances",
				"Parking Included"
			],
			"propertyType": {
				"masterType": {
					"GLOBAL": [
						"Single Family"
					],
					"LOCAL_1": [
						"Residential"
					],
					"LOCAL_2": [
						"Single Family Residence",
						"Detached",
						"Single Family"
					]
				}
			},
			"assessorDetails": {
				"assessorInfo": {
					"title": "Assessor Information",
					"propertyTax": {
						"taxYear": "2024",
						"tax": "$1,486",
						"dateUpdated": 1698796800000,
						"monthlyTax": "$124"
					},
					"assessment": {
						"title": "Taxable Value",
						"landValue": 47809,
						"additionsValue": 75407,
						"year": "2024",
						"previousValue": "$123,216",
						"dateUpdated": 1698796800000
					}
				},
				"categories": [
					{
						"name": "Home Facts",
						"subCategories": [
							{
								"fields": [
									{
										"key": "Beds",
										"value": "3"
									},
									{
										"key": "Baths",
										"value": "1.8"
									},
									{
										"key": "Total Finished SqFt",
										"value": "1,120 SqFt"
									},
									{
										"key": "Above Grade Finished SqFt",
										"value": "1,120 SqFt"
									},
									{
										"key": "Stories",
										"value": "1"
									},
									{
										"key": "Lot Size",
										"value": "6,098 SqFt"
									},
									{
										"key": "Style",
										"value": "Single Family Residence"
									},
									{
										"key": "Year Built",
										"value": "1972"
									},
									{
										"key": "Year Renovated",
										"value": "1974"
									},
									{
										"key": "Zoning",
										"value": "R1"
									},
									{
										"key": "County",
										"value": "RIVERSIDE"
									},
									{
										"key": "APN",
										"value": "437-323-010"
									},
									{
										"key": "Fireplace Type",
										"value": "Has Fireplace"
									}
								]
							}
						]
					}
				]
			},
			"totalParkingSpaces": 2,
			"waterfrontYN": false,
			"seniorCommunityYN": false,
			"view": [
				"None"
			]
		},
		"media": [
			{
				"category": 0,
				"thumbnailUrl": "https://www.compass.com/m/81af313e58150aa4fcd69861d2e03b1e38dfbc77_img_0_9dae9/165x165.jpg",
				"originalUrl": "https://www.compass.com/m/81af313e58150aa4fcd69861d2e03b1e38dfbc77_img_0_9dae9/origin.jpg",
				"width": 1024,
				"height": 768
			},
			{
				"category": 0,
				"thumbnailUrl": "https://www.compass.com/m/81af313e58150aa4fcd69861d2e03b1e38dfbc77_img_1_4fc81/165x165.jpg",
				"originalUrl": "https://www.compass.com/m/81af313e58150aa4fcd69861d2e03b1e38dfbc77_img_1_4fc81/origin.jpg",
				"width": 1024,
				"height": 768,
				"description": "Staged Photo"
			},
			...
		],
		"dealInfo": {
			"transactionType": 1,
			"courtesyOf": "Listing Courtesy of OPENDOOR BROKERAGE INC., MELISSA WESTFALL, DRE #01879498"
		},
		"isConsumerSearchable": true,
		"isOffMLS": false,
		"userListingCompliance": {
			"descriptionCompliance": 0
		},
		"parcelNumber": "437-323-010",
		"externalId": "IV24253932",
		"databaseSource": {
			"externalSourceName": "la_crmls_rets",
			"sourceDisplayName": "CRMLS",
			"contributingDatasetList": [
				"la_crmls_rets",
				"la_claw_v2",
				"san_diego_sandicor"
			]
		},
		"pageLink": "/listing/723-miramar-avenue-south-san-jacinto-ca-92583/1739939710866521817/",
		"navigationPageLink": "/listing/723-miramar-avenue-south-san-jacinto-ca-92583/1739939710866521817/",
		"canonicalPageLink": "/listing/723-miramar-avenue-south-san-jacinto-ca-92583/1739939710866521817/",
		"editable": true,
		"externalListingSha": "81af313e58150aa4fcd69861d2e03b1e38dfbc77",
		"similarType": "active"		// Can be ACTIVE or SOLD
	},
	...
]
```

**Get Listing** returns:

```
{
	"url": "https://www.compass.com/listing/439-jonnie-way-san-jacinto-ca-92583/1069570036775508905/#publicFacts",
	"summary": [
		{
			"type": [
				"SingleFamilyResidence",
				"Product",
				"RealEstateListing"
			],
			"id": "https://www.compass.com/listing/439-jonnie-way-san-jacinto-ca-92583/1069570036775508905/",
			"mpn": "1069570036775508905",
			"brand": {
				"id": "https://www.compass.com"
			},
			"url": "https://www.compass.com/listing/439-jonnie-way-san-jacinto-ca-92583/1069570036775508905/",
			"amenityFeature": [
				{
					"id": "https://www.compass.com/listing/439-jonnie-way-san-jacinto-ca-92583/1069570036775508905/#LocationFeatureSpecification",
					"type": "LocationFeatureSpecification",
					"name": "Washer / Dryer in Unit"
				},
				{
					"id": "https://www.compass.com/listing/439-jonnie-way-san-jacinto-ca-92583/1069570036775508905/#LocationFeatureSpecification",
					"type": "LocationFeatureSpecification",
					"name": "Air Conditioning"
				},
				{
					"id": "https://www.compass.com/listing/439-jonnie-way-san-jacinto-ca-92583/1069570036775508905/#LocationFeatureSpecification",
					"type": "LocationFeatureSpecification",
					"name": "Parking Included"
				},
				{
					"id": "https://www.compass.com/listing/439-jonnie-way-san-jacinto-ca-92583/1069570036775508905/#LocationFeatureSpecification",
					"type": "LocationFeatureSpecification",
					"name": "RV Parking"
				}
			],
			"containedInPlace": {
				"type": "Place",
				"id": "https://www.compass.com/listing/439-jonnie-way-san-jacinto-ca-92583/1069570036775508905/#place",
				"url": "https://www.compass.com/listing/439-jonnie-way-san-jacinto-ca-92583/1069570036775508905/#place",
				"name": "439 Jonnie Way San Jacinto, CA 92583",
				"address": {
					"type": "PostalAddress",
					"id": "https://www.compass.com/listing/439-jonnie-way-san-jacinto-ca-92583/1069570036775508905/#postalAddress",
					"streetAddress": "439 Jonnie Way",
					"addressLocality": "California",
					"addressRegion": "CA",
					"postalCode": "92583",
					"addressCountry": "US"
				}
			},
			"description": "This 3 Bedroom, 2-bath home is located in central San Jacinto. It offers an open floor plan with a pool-size backyard perfect for RV parking.",
			"floorSize": [
				{
					"type": "QuantitativeValue",
					"unitCode": "FTK",
					"value": "1,540 ",
					"id": "https://www.compass.com/listing/439-jonnie-way-san-jacinto-ca-92583/1069570036775508905/#QuantitativeValue"
				}
			],
			"image": [
				{
					"id": "https://www.compass.com/listing/439-jonnie-way-san-jacinto-ca-92583/1069570036775508905/#image-0",
					"type": "ImageObject",
					"url": "https://www.compass.com/m/49ef3169626751cb505296851d6672a58ef39961_img_0_25e75/origin.jpg"
				},
				{
					"id": "https://www.compass.com/listing/439-jonnie-way-san-jacinto-ca-92583/1069570036775508905/#image-1",
					"type": "ImageObject",
					"url": "https://www.compass.com/m/49ef3169626751cb505296851d6672a58ef39961_img_1_262a0/origin.jpg"
				},
				{
					"id": "https://www.compass.com/listing/439-jonnie-way-san-jacinto-ca-92583/1069570036775508905/#image-2",
					"type": "ImageObject",
					"url": "https://www.compass.com/m/49ef3169626751cb505296851d6672a58ef39961_img_2_88378/origin.jpg"
				},
				{
					"id": "https://www.compass.com/listing/439-jonnie-way-san-jacinto-ca-92583/1069570036775508905/#image-3",
					"type": "ImageObject",
					"url": "https://www.compass.com/m/49ef3169626751cb505296851d6672a58ef39961_img_3_ee52b/origin.jpg"
				},
				{
					"id": "https://www.compass.com/listing/439-jonnie-way-san-jacinto-ca-92583/1069570036775508905/#image-4",
					"type": "ImageObject",
					"url": "https://www.compass.com/m/49ef3169626751cb505296851d6672a58ef39961_img_4_679e6/origin.jpg"
				}
			],
			"name": "439 Jonnie Way San Jacinto, CA 92583",
			"numberOfRooms": "3",
			"offers": {
				"type": "Offer",
				"id": "https://www.compass.com/listing/439-jonnie-way-san-jacinto-ca-92583/1069570036775508905/#offer",
				"name": "439 Jonnie Way San Jacinto, CA 92583",
				"url": "https://www.compass.com/listing/439-jonnie-way-san-jacinto-ca-92583/1069570036775508905/",
				"price": 439000,
				"priceCurrency": "USD",
				"itemOffered": "https://www.compass.com/listing/439-jonnie-way-san-jacinto-ca-92583/1069570036775508905/",
				"offeredBy": {
					"url": "https://www.compass.com",
					"telephone": "951-522-2538",
					"type": "Person",
					"name": "NORMA FISCHER",
					"email": "norma.jns@outlook.com",
					"id": "https://www.compass.com/listing/439-jonnie-way-san-jacinto-ca-92583/1069570036775508905/#PersonOrOrganization",
					"potentialAction": {
						"type": "Action",
						"agent": {
							"id": "https://www.compass.com/listing/439-jonnie-way-san-jacinto-ca-92583/1069570036775508905/"
						},
						"name": "CommunicateAction",
						"url": "https://www.compass.com/listing/439-jonnie-way-san-jacinto-ca-92583/1069570036775508905/norma.jns@outlook.com",
						"id": "https://www.compass.com/listing/439-jonnie-way-san-jacinto-ca-92583/1069570036775508905/#Action"
					},
					"address": {
						"type": "PostalAddress",
						"id": "https://www.compass.com/listing/439-jonnie-way-san-jacinto-ca-92583/1069570036775508905/#postalAddress",
						"streetAddress": "439 Jonnie Way",
						"addressLocality": "California",
						"addressRegion": "CA",
						"postalCode": "92583",
						"addressCountry": "US"
					}
				},
				"seller": {
					"type": "Organization",
					"url": "https://www.compass.com/",
					"name": "Compass",
					"sameAs": [
						"https://twitter.com/compass",
						"https://www.facebook.com/compass",
						"https://www.instagram.com/compass/"
					],
					"description": "A revolutionizing real estate brokerage with unparalleled agents. ",
					"logo": "https://www.compass.com/static/img/compass_logo_black.svg",
					"telephone": "+1-212-913-9058",
					"id": "https://www.compass.com/"
				}
			},
			"potentialAction": {
				"id": "https://www.compass.com/listing/439-jonnie-way-san-jacinto-ca-92583/1069570036775508905/#Action"
			},
			"address": {
				"type": "PostalAddress",
				"id": "https://www.compass.com/listing/439-jonnie-way-san-jacinto-ca-92583/1069570036775508905/#postalAddress",
				"streetAddress": "439 Jonnie Way",
				"addressLocality": "California",
				"addressRegion": "CA",
				"postalCode": "92583",
				"addressCountry": "US"
			},
			"accommodationFloorPlan": {
				"type": "FloorPlan",
				"name": "439 Jonnie Way San Jacinto, CA 92583",
				"floorSize": [
					{
						"type": "QuantitativeValue",
						"unitCode": "FTK",
						"value": "1,540 ",
						"id": "https://www.compass.com/listing/439-jonnie-way-san-jacinto-ca-92583/1069570036775508905/#QuantitativeValue"
					}
				],
				"description": "This 3 Bedroom, 2-bath home is located in central San Jacinto. It offers an open floor plan with a pool-size backyard perfect for RV parking.",
				"numberOfBathroomsTotal": 2,
				"numberOfFullBathrooms": 2,
				"numberOfPartialBathrooms": 0,
				"numberOfBedrooms": 3,
				"petsAllowed": false,
				"url": "https://www.compass.com/listing/439-jonnie-way-san-jacinto-ca-92583/1069570036775508905/"
			},
			"speakable": "This 3 Bedroom, 2-bath home is located in central San Jacinto. It offers an open floor plan with a pool-size backyard perfect for RV parking."
		}
	],
	"rawDetails": object	// More details about the property
}
```

### Support

Always use a proxy!

Open a new issue for bugs, please share your Run URL and Input 🎈

# Actor input Schema

## `operation` (type: `string`):

No description

## `format` (type: `string`):

See Information tab!

## `location` (type: `string`):

Location for Search. URL for Get.

## `locationType` (type: `string`):

Only for Search. See Information tab!

## `price` (type: `string`):

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

## `sortOrder` (type: `string`):

No description

## `sort` (type: `string`):

No description

## `beds` (type: `string`):

Min-max. Set 0 for studios.

## `baths` (type: `integer`):

A maximum of 6 will include 6+ bathrooms.

## `propertyType` (type: `string`):

Type of property

## `listingType` (type: `string`):

Type of listing

## `status` (type: `string`):

No description

## `soldDate` (type: `string`):

Only relevant when Listing Status is set to Sold.

## `daysOnMarket` (type: `integer`):

A maximum of 180 will include 180+ days.

## `openHouse` (type: `string`):

No description

## `sqft` (type: `string`):

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

## `built` (type: `string`):

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

## `lotSize` (type: `string`):

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

## `stories` (type: `string`):

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

## `hoa` (type: `integer`):

No description

## `greatSchoolsRating` (type: `integer`):

No description

## `schoolLevel` (type: `string`):

Only when GreatSchools rating is enabled.

## `includeUnratedSchools` (type: `boolean`):

Whether to include unrated schools

## `parkingSpaces` (type: `integer`):

A maximum of 5 will include 5+ parking spaces.

## `hasWasher` (type: `boolean`):

Whether the property has a washer

## `hasOutdoor` (type: `boolean`):

Whether the property has outdoor space

## `hasBasement` (type: `boolean`):

Whether the property has a basement

## `hasGarage` (type: `boolean`):

Whether the property has a garage

## `hasAC` (type: `boolean`):

Whether the property has air conditioning

## `hasWaterfront` (type: `boolean`):

Whether the property has waterfront

## `hasElevator` (type: `boolean`):

Whether the property has an elevator

## `hasPool` (type: `boolean`):

Whether the property has a pool

## `hasDoorman` (type: `boolean`):

Whether the property has a doorman

## `delay` (type: `integer`):

Waiting time between requests.

## `proxy` (type: `object`):

Select proxies to be used by your crawler.

## Actor input object example

```json
{
  "operation": "se",
  "format": "simplified",
  "location": "downtown los angeles",
  "locationType": "first",
  "price": "300000-3750000",
  "sortOrder": "asc",
  "sort": "price",
  "beds": "1-4",
  "baths": 1,
  "propertyType": "all",
  "listingType": "all",
  "status": "9",
  "soldDate": "6months",
  "daysOnMarket": 0,
  "openHouse": "exclude",
  "sqft": "500-8000",
  "built": "",
  "lotSize": "2000-",
  "stories": "",
  "hoa": 0,
  "greatSchoolsRating": 0,
  "schoolLevel": "all",
  "includeUnratedSchools": false,
  "parkingSpaces": 1,
  "hasWasher": false,
  "hasOutdoor": false,
  "hasBasement": false,
  "hasGarage": false,
  "hasAC": false,
  "hasWaterfront": false,
  "hasElevator": false,
  "hasPool": false,
  "hasDoorman": false,
  "delay": 2,
  "proxy": {
    "useApifyProxy": true
  }
}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "proxy": {
        "useApifyProxy": true
    }
};

// Run the Actor and wait for it to finish
const run = await client.actor("canadesk/compass-properties").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = { "proxy": { "useApifyProxy": True } }

# Run the Actor and wait for it to finish
run = client.actor("canadesk/compass-properties").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "proxy": {
    "useApifyProxy": true
  }
}' |
apify call canadesk/compass-properties --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,canadesk/compass-properties"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/EoCx2vbsfG4S59PN3/builds/Wn3MZZiZaTLoWy0Wo/openapi.json