{ "openapi": "3.0.1", "info": { "title": "Homesnap Scraper - US For-Sale Listings, Prices & Property Data", "description": "Scrape Homesnap (Homes.com / CoStar) homes for sale: address, price, beds, baths, sqft, lot size, coordinates, MLS id, status, HOA, year built, and photos. Search by place, ZIP, URL, or bounding box; filter by price, beds, baths, size, and property type. HTTP-first, runs on proxies.", "version": "1.1", "x-build-id": "eJ2t0xatkTZP9Ge7m" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bujhmml~homesnap-real-estate-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bujhmml-homesnap-real-estate-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/bujhmml~homesnap-real-estate-scraper/runs": { "post": { "operationId": "runs-sync-bujhmml-homesnap-real-estate-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/bujhmml~homesnap-real-estate-scraper/run-sync": { "post": { "operationId": "run-sync-bujhmml-homesnap-real-estate-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": { "search": { "title": "Search (place or ZIP)", "maxItems": 200, "type": "array", "description": "One entry per location: a place name, neighborhood, or ZIP code, e.g. \"Austin, TX\" or \"10028\". Each entry is resolved to a Homesnap area and its listings are returned. Easiest way to start.", "items": { "type": "string" } }, "startUrls": { "title": "Homesnap city URLs", "maxItems": 200, "type": "array", "description": "Homesnap for-sale city URLs, e.g. https://www.homesnap.com/homes-for-sale/Washington/DC (paste what you see in the browser address bar). Choose For sale / Under contract / Sold with the Listing type option below.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "cities": { "title": "Cities (state + city)", "maxItems": 200, "type": "array", "description": "Alternative to search/startUrls: list of { state, city } objects, e.g. { \"state\": \"NY\", \"city\": \"New York\" }." }, "boundingBox": { "title": "Bounding box (advanced)", "type": "object", "description": "Optional raw map viewport instead of resolving a place. Object with numeric north, south, east, west (decimal degrees), e.g. { \"north\": 40.88, \"south\": 40.68, \"east\": -73.9, \"west\": -74.05 }." }, "listingType": { "title": "Listing type", "enum": [ "for_sale", "under_contract", "sold" ], "type": "string", "description": "Which listings to scrape.", "default": "for_sale" }, "propertyTypes": { "title": "Property types", "maxItems": 8, "type": "array", "description": "Keep only these property types. Codes: 1 single family, 2 condo, 3 townhouse, 4 co-op, 5 multi-family, 6 land, 7 manufactured, 8 commercial. Leave empty for all." }, "priceMin": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Keep only listings at or above this price (USD)." }, "priceMax": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Keep only listings at or below this price (USD)." }, "bedsMin": { "title": "Min beds", "minimum": 0, "type": "integer", "description": "Keep only listings with at least this many bedrooms." }, "bathsMin": { "title": "Min baths", "minimum": 0, "type": "integer", "description": "Keep only listings with at least this many bathrooms (half-baths count as 0.5)." }, "sqftMin": { "title": "Min square feet", "minimum": 0, "type": "integer", "description": "Keep only listings at or above this interior size." }, "sqftMax": { "title": "Max square feet", "minimum": 0, "type": "integer", "description": "Keep only listings at or below this interior size." }, "sortBy": { "title": "Sort results", "enum": [ "none", "price_asc", "price_desc", "newest", "beds_desc", "sqft_desc" ], "type": "string", "description": "Order results within each location before delivery.", "default": "none" }, "maxItems": { "title": "Max results", "minimum": 0, "type": "integer", "description": "Stop after this many results across all locations. 0 = no limit (capped at 500 per location by the Homesnap API).", "default": 100 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy. Use US RESIDENTIAL for full nationwide coverage; the Homesnap listing API serves degraded (empty) results to non-US / datacenter IPs.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } }, "impersonate": { "title": "Browser TLS fingerprint", "enum": [ "chrome", "chrome131", "chrome124", "safari17_0" ], "type": "string", "description": "curl_cffi impersonation target used for requests.", "default": "chrome" } } }, "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 } } } } } } } } } }