{ "openapi": "3.0.1", "info": { "title": "HomeLight Scraper - Top Real Estate Agents & Licenses", "description": "Scrape HomeLight's curated top real estate agents for any US city: name, brokerage, state license number, lifetime transaction count, years of experience, average price point, rating, review count, awards, achievements, bio and photo. No login. HomeLight publishes no agent email or phone.", "version": "0.1", "x-build-id": "ckNTLGuOM3nn2Er2t" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapersdelight~homelight-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapersdelight-homelight-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/scrapersdelight~homelight-scraper/runs": { "post": { "operationId": "runs-sync-scrapersdelight-homelight-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/scrapersdelight~homelight-scraper/run-sync": { "post": { "operationId": "run-sync-scrapersdelight-homelight-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": { "cities": { "title": "Cities", "type": "array", "description": "HomeLight city slugs, e.g. 'austin-tx', 'miami-fl', 'new-york-ny'. 'Austin, TX' and a full city URL also work. City level only — neighbourhood sub-paths (e.g. austin-tx/zilker) carry no agent list on HomeLight and are skipped.", "items": { "type": "string" } }, "startUrls": { "title": "City page URLs (optional)", "type": "array", "description": "Paste HomeLight city directory URLs directly, e.g. https://www.homelight.com/denver-co/top-real-estate-agents", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxAgents": { "title": "Max agents", "minimum": 0, "type": "integer", "description": "Stop after this many agents in total (0 = no limit). A HomeLight city page lists up to ~40 agents and has no pagination." }, "includeAgentDetails": { "title": "Include agent profile details", "type": "boolean", "description": "Fetch each agent's profile page for state license number, lifetime transaction count, years of experience, average price point, education, awards, achievements, certifications and full bio. One extra request per agent.", "default": true }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Attach the agent's client reviews (author, rating, relationship, date, body). Requires agent profile details.", "default": false }, "maxReviewsPerAgent": { "title": "Max reviews per agent", "minimum": 0, "maximum": 100, "type": "integer", "description": "Cap on reviews attached to each agent when reviews are enabled.", "default": 20 }, "includeMarketContext": { "title": "Include city market context", "type": "boolean", "description": "Attach HomeLight's city-level market stats to every row: agents in city, curated agents, average commission rate, best month to sell, top vs average days on market and sell-to-list ratio, top neighbourhoods.", "default": false }, "expandNearbyCities": { "title": "Also scrape nearby cities", "type": "boolean", "description": "Queue the nearby-city slugs HomeLight lists on each city page, so one seed city fans out across its metro. Combine with 'Max agents' to keep runs bounded.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Proxy settings. Apify auto (datacenter) proxy is the measured-good default; the actor escalates to RESIDENTIAL automatically on a blocked retry.", "default": { "useApifyProxy": true } }, "requestConcurrency": { "title": "Request concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Max parallel profile requests. Keep modest to respect the site.", "default": 5 } } }, "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 } } } } } } } } } }