{ "openapi": "3.0.1", "info": { "title": "Homes.com Scraper ā€” US Property Data, Agents & KPIs", "description": "The Homes.com API and scraper for your PropTech stack. Pull US for-sale, for-rent and sold listings by location, ZIP, coordinates or URL ā€” with agent contacts, license data, public records and market KPIs (median price, price per sqft, city breakdowns). Clean JSON or CSV.", "version": "1.0", "x-build-id": "ynEsrMnEqF0Ixdcjd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/sian.agency~homes-com-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-sian.agency-homes-com-property-scraper", "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/sian.agency~homes-com-property-scraper/runs": { "post": { "operationId": "runs-sync-sian.agency-homes-com-property-scraper", "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/sian.agency~homes-com-property-scraper/run-sync": { "post": { "operationId": "run-sync-sian.agency-homes-com-property-scraper", "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", "properties": { "operation": { "title": "šŸ§­ Operation", "enum": [ "searchByLocation", "searchByZip", "searchByCoordinates", "searchByUrl", "detailsById", "detailsByUrl", "agentSearch", "agentDetails", "autocomplete" ], "type": "string", "description": "What to pull from Homes.com.\n\n**Search (listing rows):**\nā€¢ **searchByLocation** ā€” city / state / neighborhood / ZIP / free text (paginated)\nā€¢ **searchByZip** ā€” exact 5-digit ZIP (paginated)\nā€¢ **searchByCoordinates** ā€” lat/long + radius (paginated)\nā€¢ **searchByUrl** ā€” paste a Homes.com search URL (paginated)\n\n**Property detail (single rich listing):**\nā€¢ **detailsById** / **detailsByUrl** ā€” full detail with public records, 90+ features, MLS number, price/sqft, listing agents & photo gallery\n\n**Agents:**\nā€¢ **agentSearch** ā€” find agents by name\nā€¢ **agentDetails** ā€” full agent profile (office, phone, license, bio, active listings, sold count)\n\n**Helper:**\nā€¢ **autocomplete** ā€” resolve a location string to canonical places + coordinates", "default": "searchByLocation" }, "location": { "title": "šŸ“ Location", "type": "string", "description": "For **searchByLocation** / **autocomplete** ā€” a city/state, neighborhood, ZIP or free text, e.g. `Charlotte, NC`, `90210`, `Austin, TX`.", "default": "Charlotte, NC" }, "zipCode": { "title": "šŸ·ļø ZIP Code", "type": "string", "description": "For **searchByZip** ā€” a 5-digit US ZIP, e.g. `90210`." }, "latitude": { "title": "šŸŒ Latitude", "type": "string", "description": "For **searchByCoordinates** ā€” center latitude, e.g. `40.7128`." }, "longitude": { "title": "šŸŒ Longitude", "type": "string", "description": "For **searchByCoordinates** ā€” center longitude, e.g. `-74.0060`." }, "radius": { "title": "šŸ“ Radius (miles)", "minimum": 1, "maximum": 100, "type": "integer", "description": "For **searchByCoordinates** ā€” search radius in miles around the point (default 5)." }, "url": { "title": "šŸ”— Homes.com URL", "type": "string", "description": "For **searchByUrl** ā€” a Homes.com search page, e.g. `https://www.homes.com/charlotte-nc/`. For **detailsByUrl** ā€” a property page. For **agentDetails** ā€” an agent profile page (`https://www.homes.com/real-estate-agents/.../`)." }, "id": { "title": "šŸ†” Property ID", "type": "string", "description": "For **detailsById** ā€” the property key from a search row (`propertyId`) or the last path segment of a Homes.com property URL, e.g. `k3hx8dgz27xf3`." }, "name": { "title": "šŸ‘¤ Agent Name", "type": "string", "description": "For **agentSearch** ā€” an agent name to search, e.g. `John Smith`." }, "agentId": { "title": "šŸŖŖ Agent ID", "type": "string", "description": "For **agentDetails** ā€” the agent key from an agentSearch result (e.g. `w9enbmj`). Alternatively paste the agent profile URL into the URL field." }, "searchType": { "title": "šŸ”– Listing Status", "enum": [ "For_Sale", "For_Rent", "Sold" ], "type": "string", "description": "For the search operations ā€” which listings to return.", "default": "For_Sale" }, "propertyType": { "title": "šŸ˜ļø Property Type", "type": "array", "description": "Property type(s) to filter. Leave empty for any.", "items": { "type": "string", "enum": [ "House", "Townhouse", "Condo", "MultiFamily", "Land", "Mobile", "Commercial" ], "enumTitles": [ "House", "Townhouse", "Condo", "Multi-Family", "Land", "Mobile", "Commercial" ] } }, "sortOrder": { "title": "ā†•ļø Sort Order", "enum": [ "Recommended", "Price_Low_to_High", "Price_High_to_Low", "Most_Homes" ], "type": "string", "description": "Result ordering for the search operations.", "default": "Recommended" }, "priceMin": { "title": "šŸ’µ Min Price (USD)", "minimum": 0, "type": "integer", "description": "Minimum listing price filter." }, "priceMax": { "title": "šŸ’µ Max Price (USD)", "minimum": 0, "type": "integer", "description": "Maximum listing price filter." }, "bedsMin": { "title": "šŸ›ļø Min Beds", "minimum": 0, "type": "integer", "description": "Minimum bedrooms filter." }, "bedsMax": { "title": "šŸ›ļø Max Beds", "minimum": 0, "type": "integer", "description": "Maximum bedrooms filter." }, "bathsMin": { "title": "šŸ› Min Baths", "minimum": 0, "type": "integer", "description": "Minimum bathrooms filter." }, "bathsMax": { "title": "šŸ› Max Baths", "minimum": 0, "type": "integer", "description": "Maximum bathrooms filter." }, "maxResults": { "title": "šŸ”¢ Max Results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum rows to collect for paginated / list operations (also caps autocomplete + agentSearch). FREE tier is capped at 60.", "default": 50 } } }, "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 } } } } } } } } } }