{ "openapi": "3.0.1", "info": { "title": "HomeFinder Real Estate Scraper", "description": "Scrape HomeFinder.com real estate listings - homes for sale, homes for rent, and search by city/state or ZIP code. Get price, beds/baths, sqft, address, coordinates, photos, agent/brokerage contact, and listing URLs.", "version": "1.0", "x-build-id": "wf7mVjtBCbFLRAhLr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~homefinder-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-homefinder-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/crawlerbros~homefinder-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-homefinder-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/crawlerbros~homefinder-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-homefinder-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", "required": [ "mode", "transactionType" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "byZip" ], "type": "string", "description": "How to locate listings.", "default": "search" }, "city": { "title": "City (mode=search)", "type": "string", "description": "City name, e.g. `New York`, `Austin`, `Phoenix`.", "default": "New York" }, "state": { "title": "State (mode=search)", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "type": "string", "description": "2-letter US state code, e.g. `NY`, `TX`, `AZ`.", "default": "NY" }, "zipCode": { "title": "ZIP code (mode=byZip)", "type": "string", "description": "5-digit US ZIP code, e.g. `10001`.", "default": "10001" }, "transactionType": { "title": "For sale or for rent", "enum": [ "for_sale", "for_rent" ], "type": "string", "description": "Whether to scrape sale listings or rental listings.", "default": "for_sale" }, "propertyType": { "title": "Property type", "enum": [ "any", "single_family", "condos", "coop", "multi_family", "townhomes", "mobile", "land", "apartment" ], "type": "string", "description": "Filter to a single property type. Leave as `Any` to include all types.", "default": "any" }, "priceMin": { "title": "Min price ($)", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Drop listings priced below this amount." }, "priceMax": { "title": "Max price ($)", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Drop listings priced above this amount." }, "bedroomsMin": { "title": "Min bedrooms", "enum": [ "0", "1", "2", "3", "4", "5", "6" ], "type": "string", "description": "Drop listings with fewer bedrooms than this.", "default": "0" }, "bathroomsMin": { "title": "Min bathrooms", "enum": [ "0", "1", "2", "3", "4", "5" ], "type": "string", "description": "Drop listings with fewer bathrooms than this.", "default": "0" }, "sqftMin": { "title": "Min square footage", "minimum": 0, "maximum": 50000, "type": "integer", "description": "Drop listings with fewer square feet than this." }, "sqftMax": { "title": "Max square footage", "minimum": 0, "maximum": 50000, "type": "integer", "description": "Drop listings with more square feet than this." }, "lotSqftMin": { "title": "Min lot size (sq ft, for-sale only)", "minimum": 0, "maximum": 5000000, "type": "integer", "description": "Drop listings with a smaller lot than this. Only applies when Transaction type = For sale (rentals have no lot data)." }, "lotSqftMax": { "title": "Max lot size (sq ft, for-sale only)", "minimum": 0, "maximum": 5000000, "type": "integer", "description": "Drop listings with a larger lot than this. Only applies when Transaction type = For sale (rentals have no lot data)." }, "sortOrder": { "title": "Sort order", "enum": [ "relevance", "price_asc", "price_desc", "newest" ], "type": "string", "description": "Order in which HomeFinder returns listings.", "default": "relevance" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on emitted records.", "default": 30 } } }, "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 } } } } } } } } } }