Compass.com
Pricing
$12.00/month + usage
Go to Store
Compass.com
Search for US properties with advanced filters, or get details, offers and similar homes from the Compass URL. It's fast and costs little!
0.0 (0)
Pricing
$12.00/month + usage
2
Total users
5
Monthly users
3
Runs succeeded
>99%
Last modified
3 months ago
You can access the Compass.com programmatically from your own applications by using the Apify API. You can also 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.
{ "openapi": "3.0.1", "info": { "version": "1.4", "x-build-id": "eb26kJiE2Z4ra4ELV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/canadesk~compass-properties/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-canadesk-compass-properties", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/canadesk~compass-properties/runs": { "post": { "operationId": "runs-sync-canadesk-compass-properties", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/canadesk~compass-properties/run-sync": { "post": { "operationId": "run-sync-canadesk-compass-properties", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "location" ], "properties": { "operation": { "title": "Operation", "enum": [ "se", "gl", "gs" ], "type": "string", "description": "", "default": "se" }, "format": { "title": "Format", "enum": [ "raw", "simplified" ], "type": "string", "description": "See Information tab!", "default": "simplified" }, "location": { "title": "Location or URL", "type": "string", "description": "Location for Search. URL for Get.", "default": "downtown los angeles" }, "locationType": { "title": "Location Type", "enum": [ "first", "5", "2" ], "type": "string", "description": "Only for Search. See Information tab!", "default": "first" }, "price": { "title": "Price Range", "type": "string", "description": "Min-max. Leave empty for all. See Information tab!", "default": "300000-3750000" }, "sortOrder": { "title": "Sort Order", "enum": [ "asc", "desc" ], "type": "string", "description": "", "default": "asc" }, "sort": { "title": "Sort By", "enum": [ "price", "recommended", "beds", "baths", "sqft", "ppsf", "dom", "addr", "loc" ], "type": "string", "description": "", "default": "price" }, "beds": { "title": "Bedrooms", "type": "string", "description": "Min-max. Set 0 for studios.", "default": "1-4" }, "baths": { "title": "Minimum Bathrooms", "minimum": 1, "maximum": 6, "type": "integer", "description": "A maximum of 6 will include 6+ bathrooms.", "default": 1 }, "propertyType": { "title": "Property Type", "enum": [ "all", "Single Family", "Condo", "Townhouse", "Co-op", "Land", "Multi Family" ], "type": "string", "description": "Type of property", "default": "all" }, "listingType": { "title": "Listing Type", "enum": [ "all", "0-2", "3", "4", "5" ], "type": "string", "description": "Type of listing", "default": "all" }, "status": { "title": "Listing Status", "enum": [ "all", "12", "9", "2-3-11", "8" ], "type": "string", "description": "", "default": "9" }, "soldDate": { "title": "Sold Date", "enum": [ "7days", "30days", "90days", "6months", "1year", "2years", "3years", "anytime" ], "type": "string", "description": "Only relevant when Listing Status is set to Sold.", "default": "6months" }, "daysOnMarket": { "title": "On Market Since (days)", "minimum": 0, "maximum": 180, "type": "integer", "description": "A maximum of 180 will include 180+ days.", "default": 0 }, "openHouse": { "title": "Open House", "enum": [ "exclude", "thisweekend", "anytime" ], "type": "string", "description": "", "default": "exclude" }, "sqft": { "title": "Square Footage", "type": "string", "description": "Min-max. Leave empty for all. See Information tab!", "default": "500-8000" }, "built": { "title": "Year Built", "type": "string", "description": "Min-max. Leave empty for all. See Information tab!", "default": "" }, "lotSize": { "title": "Lot Size", "type": "string", "description": "Min-max. Leave empty for all. See Information tab!", "default": "2000-" }, "stories": { "title": "Stories", "type": "string", "description": "Min-max. Leave empty for all. See Information tab!", "default": "" }, "hoa": { "title": "Maximum HOA Fees (/m)", "minimum": 0, "maximum": 1000, "type": "integer", "description": "", "default": 0 }, "greatSchoolsRating": { "title": "GreatSchools Rating", "minimum": 0, "maximum": 10, "type": "integer", "description": "", "default": 0 }, "schoolLevel": { "title": "School Level", "enum": [ "all", "0", "1", "2" ], "type": "string", "description": "Only when GreatSchools rating is enabled.", "default": "all" }, "includeUnratedSchools": { "title": "Include Unrated Schools", "type": "boolean", "description": "Whether to include unrated schools", "default": false }, "parkingSpaces": { "title": "Minimum Parking Spaces", "minimum": 0, "maximum": 5, "type": "integer", "description": "A maximum of 5 will include 5+ parking spaces.", "default": 1 }, "hasWasher": { "title": "Has Washer", "type": "boolean", "description": "Whether the property has a washer", "default": false }, "hasOutdoor": { "title": "Has Outdoor Space", "type": "boolean", "description": "Whether the property has outdoor space", "default": false }, "hasBasement": { "title": "Has Basement", "type": "boolean", "description": "Whether the property has a basement", "default": false }, "hasGarage": { "title": "Has Garage", "type": "boolean", "description": "Whether the property has a garage", "default": false }, "hasAC": { "title": "Has Air Conditioning", "type": "boolean", "description": "Whether the property has air conditioning", "default": false }, "hasWaterfront": { "title": "Has Waterfront", "type": "boolean", "description": "Whether the property has waterfront", "default": false }, "hasElevator": { "title": "Has Elevator", "type": "boolean", "description": "Whether the property has an elevator", "default": false }, "hasPool": { "title": "Has Pool", "type": "boolean", "description": "Whether the property has a pool", "default": false }, "hasDoorman": { "title": "Has Doorman", "type": "boolean", "description": "Whether the property has a doorman", "default": false }, "delay": { "title": "Delay", "minimum": 1, "maximum": 30, "type": "integer", "description": "Waiting time between requests.", "default": 2 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Select proxies to be used by your crawler." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } }}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:
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:
