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

Compass.com

canadesk/compass-properties

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!

You can access the Compass.com programmatically from your own applications by using the Apify API. You can choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in Integrations settings in Apify Console.

1{
2  "openapi": "3.0.1",
3  "info": {
4    "version": "1.4",
5    "x-build-id": "eb26kJiE2Z4ra4ELV"
6  },
7  "servers": [
8    {
9      "url": "https://api.apify.com/v2"
10    }
11  ],
12  "paths": {
13    "/acts/canadesk~compass-properties/run-sync-get-dataset-items": {
14      "post": {
15        "operationId": "run-sync-get-dataset-items-canadesk-compass-properties",
16        "x-openai-isConsequential": false,
17        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
18        "tags": [
19          "Run Actor"
20        ],
21        "requestBody": {
22          "required": true,
23          "content": {
24            "application/json": {
25              "schema": {
26                "$ref": "#/components/schemas/inputSchema"
27              }
28            }
29          }
30        },
31        "parameters": [
32          {
33            "name": "token",
34            "in": "query",
35            "required": true,
36            "schema": {
37              "type": "string"
38            },
39            "description": "Enter your Apify token here"
40          }
41        ],
42        "responses": {
43          "200": {
44            "description": "OK"
45          }
46        }
47      }
48    },
49    "/acts/canadesk~compass-properties/runs": {
50      "post": {
51        "operationId": "runs-sync-canadesk-compass-properties",
52        "x-openai-isConsequential": false,
53        "summary": "Executes an Actor and returns information about the initiated run in response.",
54        "tags": [
55          "Run Actor"
56        ],
57        "requestBody": {
58          "required": true,
59          "content": {
60            "application/json": {
61              "schema": {
62                "$ref": "#/components/schemas/inputSchema"
63              }
64            }
65          }
66        },
67        "parameters": [
68          {
69            "name": "token",
70            "in": "query",
71            "required": true,
72            "schema": {
73              "type": "string"
74            },
75            "description": "Enter your Apify token here"
76          }
77        ],
78        "responses": {
79          "200": {
80            "description": "OK",
81            "content": {
82              "application/json": {
83                "schema": {
84                  "$ref": "#/components/schemas/runsResponseSchema"
85                }
86              }
87            }
88          }
89        }
90      }
91    },
92    "/acts/canadesk~compass-properties/run-sync": {
93      "post": {
94        "operationId": "run-sync-canadesk-compass-properties",
95        "x-openai-isConsequential": false,
96        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
97        "tags": [
98          "Run Actor"
99        ],
100        "requestBody": {
101          "required": true,
102          "content": {
103            "application/json": {
104              "schema": {
105                "$ref": "#/components/schemas/inputSchema"
106              }
107            }
108          }
109        },
110        "parameters": [
111          {
112            "name": "token",
113            "in": "query",
114            "required": true,
115            "schema": {
116              "type": "string"
117            },
118            "description": "Enter your Apify token here"
119          }
120        ],
121        "responses": {
122          "200": {
123            "description": "OK"
124          }
125        }
126      }
127    }
128  },
129  "components": {
130    "schemas": {
131      "inputSchema": {
132        "type": "object",
133        "required": [
134          "location"
135        ],
136        "properties": {
137          "operation": {
138            "title": "Operation",
139            "enum": [
140              "se",
141              "gl",
142              "gs"
143            ],
144            "type": "string",
145            "description": "",
146            "default": "se"
147          },
148          "format": {
149            "title": "Format",
150            "enum": [
151              "raw",
152              "simplified"
153            ],
154            "type": "string",
155            "description": "See Information tab!",
156            "default": "simplified"
157          },
158          "location": {
159            "title": "Location or URL",
160            "type": "string",
161            "description": "Location for Search. URL for Get.",
162            "default": "downtown los angeles"
163          },
164          "locationType": {
165            "title": "Location Type",
166            "enum": [
167              "first",
168              "5",
169              "2"
170            ],
171            "type": "string",
172            "description": "Only for Search. See Information tab!",
173            "default": "first"
174          },
175          "price": {
176            "title": "Price Range",
177            "type": "string",
178            "description": "Min-max. Leave empty for all. See Information tab!",
179            "default": "300000-3750000"
180          },
181          "sortOrder": {
182            "title": "Sort Order",
183            "enum": [
184              "asc",
185              "desc"
186            ],
187            "type": "string",
188            "description": "",
189            "default": "asc"
190          },
191          "sort": {
192            "title": "Sort By",
193            "enum": [
194              "price",
195              "recommended",
196              "beds",
197              "baths",
198              "sqft",
199              "ppsf",
200              "dom",
201              "addr",
202              "loc"
203            ],
204            "type": "string",
205            "description": "",
206            "default": "price"
207          },
208          "beds": {
209            "title": "Bedrooms",
210            "type": "string",
211            "description": "Min-max. Set 0 for studios.",
212            "default": "1-4"
213          },
214          "baths": {
215            "title": "Minimum Bathrooms",
216            "minimum": 1,
217            "maximum": 6,
218            "type": "integer",
219            "description": "A maximum of 6 will include 6+ bathrooms.",
220            "default": 1
221          },
222          "propertyType": {
223            "title": "Property Type",
224            "enum": [
225              "all",
226              "Single Family",
227              "Condo",
228              "Townhouse",
229              "Co-op",
230              "Land",
231              "Multi Family"
232            ],
233            "type": "string",
234            "description": "Type of property",
235            "default": "all"
236          },
237          "listingType": {
238            "title": "Listing Type",
239            "enum": [
240              "all",
241              "0-2",
242              "3",
243              "4",
244              "5"
245            ],
246            "type": "string",
247            "description": "Type of listing",
248            "default": "all"
249          },
250          "status": {
251            "title": "Listing Status",
252            "enum": [
253              "all",
254              "12",
255              "9",
256              "2-3-11",
257              "8"
258            ],
259            "type": "string",
260            "description": "",
261            "default": "9"
262          },
263          "soldDate": {
264            "title": "Sold Date",
265            "enum": [
266              "7days",
267              "30days",
268              "90days",
269              "6months",
270              "1year",
271              "2years",
272              "3years",
273              "anytime"
274            ],
275            "type": "string",
276            "description": "Only relevant when Listing Status is set to Sold.",
277            "default": "6months"
278          },
279          "daysOnMarket": {
280            "title": "On Market Since (days)",
281            "minimum": 0,
282            "maximum": 180,
283            "type": "integer",
284            "description": "A maximum of 180 will include 180+ days.",
285            "default": 0
286          },
287          "openHouse": {
288            "title": "Open House",
289            "enum": [
290              "exclude",
291              "thisweekend",
292              "anytime"
293            ],
294            "type": "string",
295            "description": "",
296            "default": "exclude"
297          },
298          "sqft": {
299            "title": "Square Footage",
300            "type": "string",
301            "description": "Min-max. Leave empty for all. See Information tab!",
302            "default": "500-8000"
303          },
304          "built": {
305            "title": "Year Built",
306            "type": "string",
307            "description": "Min-max. Leave empty for all. See Information tab!",
308            "default": ""
309          },
310          "lotSize": {
311            "title": "Lot Size",
312            "type": "string",
313            "description": "Min-max. Leave empty for all. See Information tab!",
314            "default": "2000-"
315          },
316          "stories": {
317            "title": "Stories",
318            "type": "string",
319            "description": "Min-max. Leave empty for all. See Information tab!",
320            "default": ""
321          },
322          "hoa": {
323            "title": "Maximum HOA Fees (/m)",
324            "minimum": 0,
325            "maximum": 1000,
326            "type": "integer",
327            "description": "",
328            "default": 0
329          },
330          "greatSchoolsRating": {
331            "title": "GreatSchools Rating",
332            "minimum": 0,
333            "maximum": 10,
334            "type": "integer",
335            "description": "",
336            "default": 0
337          },
338          "schoolLevel": {
339            "title": "School Level",
340            "enum": [
341              "all",
342              "0",
343              "1",
344              "2"
345            ],
346            "type": "string",
347            "description": "Only when GreatSchools rating is enabled.",
348            "default": "all"
349          },
350          "includeUnratedSchools": {
351            "title": "Include Unrated Schools",
352            "type": "boolean",
353            "description": "Whether to include unrated schools",
354            "default": false
355          },
356          "parkingSpaces": {
357            "title": "Minimum Parking Spaces",
358            "minimum": 0,
359            "maximum": 5,
360            "type": "integer",
361            "description": "A maximum of 5 will include 5+ parking spaces.",
362            "default": 1
363          },
364          "hasWasher": {
365            "title": "Has Washer",
366            "type": "boolean",
367            "description": "Whether the property has a washer",
368            "default": false
369          },
370          "hasOutdoor": {
371            "title": "Has Outdoor Space",
372            "type": "boolean",
373            "description": "Whether the property has outdoor space",
374            "default": false
375          },
376          "hasBasement": {
377            "title": "Has Basement",
378            "type": "boolean",
379            "description": "Whether the property has a basement",
380            "default": false
381          },
382          "hasGarage": {
383            "title": "Has Garage",
384            "type": "boolean",
385            "description": "Whether the property has a garage",
386            "default": false
387          },
388          "hasAC": {
389            "title": "Has Air Conditioning",
390            "type": "boolean",
391            "description": "Whether the property has air conditioning",
392            "default": false
393          },
394          "hasWaterfront": {
395            "title": "Has Waterfront",
396            "type": "boolean",
397            "description": "Whether the property has waterfront",
398            "default": false
399          },
400          "hasElevator": {
401            "title": "Has Elevator",
402            "type": "boolean",
403            "description": "Whether the property has an elevator",
404            "default": false
405          },
406          "hasPool": {
407            "title": "Has Pool",
408            "type": "boolean",
409            "description": "Whether the property has a pool",
410            "default": false
411          },
412          "hasDoorman": {
413            "title": "Has Doorman",
414            "type": "boolean",
415            "description": "Whether the property has a doorman",
416            "default": false
417          },
418          "delay": {
419            "title": "Delay",
420            "minimum": 1,
421            "maximum": 30,
422            "type": "integer",
423            "description": "Waiting time between requests.",
424            "default": 2
425          },
426          "proxy": {
427            "title": "Proxy configuration",
428            "type": "object",
429            "description": "Select proxies to be used by your crawler."
430          }
431        }
432      },
433      "runsResponseSchema": {
434        "type": "object",
435        "properties": {
436          "data": {
437            "type": "object",
438            "properties": {
439              "id": {
440                "type": "string"
441              },
442              "actId": {
443                "type": "string"
444              },
445              "userId": {
446                "type": "string"
447              },
448              "startedAt": {
449                "type": "string",
450                "format": "date-time",
451                "example": "2025-01-08T00:00:00.000Z"
452              },
453              "finishedAt": {
454                "type": "string",
455                "format": "date-time",
456                "example": "2025-01-08T00:00:00.000Z"
457              },
458              "status": {
459                "type": "string",
460                "example": "READY"
461              },
462              "meta": {
463                "type": "object",
464                "properties": {
465                  "origin": {
466                    "type": "string",
467                    "example": "API"
468                  },
469                  "userAgent": {
470                    "type": "string"
471                  }
472                }
473              },
474              "stats": {
475                "type": "object",
476                "properties": {
477                  "inputBodyLen": {
478                    "type": "integer",
479                    "example": 2000
480                  },
481                  "rebootCount": {
482                    "type": "integer",
483                    "example": 0
484                  },
485                  "restartCount": {
486                    "type": "integer",
487                    "example": 0
488                  },
489                  "resurrectCount": {
490                    "type": "integer",
491                    "example": 0
492                  },
493                  "computeUnits": {
494                    "type": "integer",
495                    "example": 0
496                  }
497                }
498              },
499              "options": {
500                "type": "object",
501                "properties": {
502                  "build": {
503                    "type": "string",
504                    "example": "latest"
505                  },
506                  "timeoutSecs": {
507                    "type": "integer",
508                    "example": 300
509                  },
510                  "memoryMbytes": {
511                    "type": "integer",
512                    "example": 1024
513                  },
514                  "diskMbytes": {
515                    "type": "integer",
516                    "example": 2048
517                  }
518                }
519              },
520              "buildId": {
521                "type": "string"
522              },
523              "defaultKeyValueStoreId": {
524                "type": "string"
525              },
526              "defaultDatasetId": {
527                "type": "string"
528              },
529              "defaultRequestQueueId": {
530                "type": "string"
531              },
532              "buildNumber": {
533                "type": "string",
534                "example": "1.0.0"
535              },
536              "containerUrl": {
537                "type": "string"
538              },
539              "usage": {
540                "type": "object",
541                "properties": {
542                  "ACTOR_COMPUTE_UNITS": {
543                    "type": "integer",
544                    "example": 0
545                  },
546                  "DATASET_READS": {
547                    "type": "integer",
548                    "example": 0
549                  },
550                  "DATASET_WRITES": {
551                    "type": "integer",
552                    "example": 0
553                  },
554                  "KEY_VALUE_STORE_READS": {
555                    "type": "integer",
556                    "example": 0
557                  },
558                  "KEY_VALUE_STORE_WRITES": {
559                    "type": "integer",
560                    "example": 1
561                  },
562                  "KEY_VALUE_STORE_LISTS": {
563                    "type": "integer",
564                    "example": 0
565                  },
566                  "REQUEST_QUEUE_READS": {
567                    "type": "integer",
568                    "example": 0
569                  },
570                  "REQUEST_QUEUE_WRITES": {
571                    "type": "integer",
572                    "example": 0
573                  },
574                  "DATA_TRANSFER_INTERNAL_GBYTES": {
575                    "type": "integer",
576                    "example": 0
577                  },
578                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
579                    "type": "integer",
580                    "example": 0
581                  },
582                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
583                    "type": "integer",
584                    "example": 0
585                  },
586                  "PROXY_SERPS": {
587                    "type": "integer",
588                    "example": 0
589                  }
590                }
591              },
592              "usageTotalUsd": {
593                "type": "number",
594                "example": 0.00005
595              },
596              "usageUsd": {
597                "type": "object",
598                "properties": {
599                  "ACTOR_COMPUTE_UNITS": {
600                    "type": "integer",
601                    "example": 0
602                  },
603                  "DATASET_READS": {
604                    "type": "integer",
605                    "example": 0
606                  },
607                  "DATASET_WRITES": {
608                    "type": "integer",
609                    "example": 0
610                  },
611                  "KEY_VALUE_STORE_READS": {
612                    "type": "integer",
613                    "example": 0
614                  },
615                  "KEY_VALUE_STORE_WRITES": {
616                    "type": "number",
617                    "example": 0.00005
618                  },
619                  "KEY_VALUE_STORE_LISTS": {
620                    "type": "integer",
621                    "example": 0
622                  },
623                  "REQUEST_QUEUE_READS": {
624                    "type": "integer",
625                    "example": 0
626                  },
627                  "REQUEST_QUEUE_WRITES": {
628                    "type": "integer",
629                    "example": 0
630                  },
631                  "DATA_TRANSFER_INTERNAL_GBYTES": {
632                    "type": "integer",
633                    "example": 0
634                  },
635                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
636                    "type": "integer",
637                    "example": 0
638                  },
639                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
640                    "type": "integer",
641                    "example": 0
642                  },
643                  "PROXY_SERPS": {
644                    "type": "integer",
645                    "example": 0
646                  }
647                }
648              }
649            }
650          }
651        }
652      }
653    }
654  }
655}

Compass.com OpenAPI definition

OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.

OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.

By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.

You can download the OpenAPI definitions for Compass.com from the options below:

OpenAPI.json

If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.

You can also check out our other API clients:

Compass.com API in Python

Compass.com API in JavaScript

Compass.com API through CLI

Compass.com API

Developer

Canadesk Support

Actor Metrics

1 monthly user
0 No stars yet
>99% runs succeeded
Created in Feb 2025
Modified 15 hours ago

Categories

Instagram Scraper

apify/instagram-scraper

Scrape and download Instagram posts, profiles, places, hashtags, photos, and comments. Get data from Instagram using one or more Instagram URLs or search queries. Export scraped data, run the scraper via API, schedule and monitor runs or integrate with other tools.

Apify

71.9k

941

📩📍 Google Maps Email Extractor

lukaskrivka/google-maps-with-contact-details

Extract Google Maps contact details. Scrape websites of Google Maps places for contact details and get email addresses, website, location, address, zipcode, phone number, social media links. Export scraped data, run the scraper via API, schedule and monitor runs or integrate with other tools.

Lukáš Křivka

14.4k

458

Facebook Posts Scraper

apify/facebook-posts-scraper

Extract data from hundreds of Facebook posts from one or multiple Facebook pages and profiles. Get post URL, post text, page or profile URL, timestamp, number of likes, shares, comments, and more. Download the data in JSON, CSV, and Excel and use it in apps, spreadsheets, and reports.

Apify

17.8k

276

Contact Details Scraper

vdrmota/contact-info-scraper

Free email extractor and lead scraper to extract and download emails, phone numbers, Facebook, Twitter, LinkedIn, and Instagram profiles from any website. Extract contact information at scale from lists of URLs and download the data as Excel, CSV, JSON, HTML, and XML.

Vojta Drmota

27.6k

308

Google Maps Extractor

compass/google-maps-extractor

Extract data from hundreds of places fast. Scrape Google Maps by keyword, category, location, URLs & other filters. Get addresses, contact info, opening hours, popular times, prices, menus & more. Export scraped data, run the scraper via API, schedule and monitor runs, or integrate with other tools.

Compass

28.2k

700

Facebook Groups Scraper

apify/facebook-groups-scraper

Extract data from one or multiple public Facebook groups. Get group and post URLs, post text, comments, timestamp, likes and comments count, and basic commentator info. Download the data in JSON, CSV, and Excel and use it in apps, spreadsheets, and reports.

Apify

8.2k

Instagram Post Scraper

apify/instagram-post-scraper

Scrape Instagram posts. Just add one or more Instagram usernames and get your data in seconds including text, hashtags, mentions, comments, images, URLs, likes, locations, and metadata. Export scraped data, run the scraper via API, schedule and monitor runs or integrate with other tools.

Apify

25.3k

254

Instagram Reel Scraper

apify/instagram-reel-scraper

Scrape data from Instagram reels. Just add one or more Instagram usernames and get your data in seconds including hashtags, mentions, comments, images, likes, locations, and metadata. Export scraped data, run the scraper via API, schedule and monitor runs or integrate with other tools.

Apify

7.5k

212

Instagram Profile Scraper

apify/instagram-profile-scraper

Scrape all Instagram profile info. Just add one or more Instagram usernames and extract number of followers&follows, URLs, bio, posts, likes, counts, related profiles, captions, highlight reels. Export scraped data, run the scraper via API, schedule and monitor runs or integrate with other tools.

Apify

42.3k

317

Facebook Comments Scraper

apify/facebook-comments-scraper

Extract data from hundreds of Facebook comments from one or multiple Facebook posts. Get comment text, timestamp, likes count and basic commenter info. Download the data in JSON, CSV, Excel and use it in apps, spreadsheets, and reports.

Apify

8.1k

102