{ "openapi": "3.0.1", "info": { "title": "HomeStars Scraper | Canadian Contractor Phones", "description": "Collect Canadian HomeStars contractors by city, trade, or public profile. Export names, available phones, websites, ratings, and optional reviews. Pay per delivered row plus a start fee.", "version": "0.1", "x-build-id": "IQkcEjeQywG2YzTZt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~homestars-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-homestars-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/lentic_clockss~homestars-scraper/runs": { "post": { "operationId": "runs-sync-lentic_clockss-homestars-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/lentic_clockss~homestars-scraper/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-homestars-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": { "searchType": { "title": "Search type", "enum": [ "city-list", "trade-city", "national-trade", "profile", "all-cities", "all-trades", "privacy", "about", "home", "search", "map", "login", "quote", "contact" ], "type": "string", "description": "What to collect. Fill the matching field below: a city slug for city lists, trade plus city for trade lists, a profile slug or profile URLs for profiles. The last five types are not available on HomeStars and return an explanation instead of rows.", "default": "city-list" }, "city": { "title": "City slug", "type": "string", "description": "City slug exactly as in the HomeStars address, such as calgary-alberta or edmonton (from www.homestars.com/find-professionals/). A bare calgary is a hub page with no contractors." }, "detailUrls": { "title": "Detail URLs", "type": "array", "description": "www.homestars.com addresses of city lists, trade lists, profiles or the privacy page. Each address is its own input with its own Max results. Other sites are not accepted." }, "profileSlug": { "title": "Profile slug", "type": "string", "description": "Profile slug exactly as in the HomeStars address, such as deo-tech or 2592882-a-action-furnace-inc (from www.homestars.com/profile/). Used when Search type is Contractor profile." }, "cluster": { "title": "Content cluster", "type": "string", "description": "First part of a trade address, such as electricity, heating or roofing (www.homestars.com//-pros).", "default": "electricity" }, "trade": { "title": "Trade slug", "type": "string", "description": "Trade slug without -pros, such as electrician (www.homestars.com/electricity/electrician-pros).", "default": "electrician" }, "market": { "title": "Market", "enum": [ "ca" ], "type": "string", "description": "Only Canada (www.homestars.com) is available.", "default": "ca" }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 200, "type": "integer", "description": "Maximum rows for each city, trade list or profile address. Contractor rows and review rows (Include reviews) share this limit. The whole run is still capped by the free-plan quota or your maximum charge limit.", "default": 70 }, "maxPages": { "title": "Max pages", "minimum": 1, "maximum": 50, "type": "integer", "description": "Directory pages to read per input (up to 50).", "default": 1 }, "enrichDetails": { "title": "Enrich details", "type": "boolean", "description": "Include available public profile phones and websites in contractor directory rows. Enabled by default; these contact fields are empty on directory cards alone.", "default": true }, "includeReviews": { "title": "Include reviews", "type": "boolean", "description": "Add each available review as a separate billed row linked to its contractor by parentId. Off by default; reviews share maxResults with contractor rows, so enabling this can yield fewer contractors.", "default": false }, "cursor": { "title": "Resume cursor", "type": "object", "description": "Continue an earlier run: paste the nextCursor object that run returned, with the same Search type and the same single input. Leave empty to start fresh." }, "workerBaseUrl": { "title": "Developer testing setting", "type": "string", "description": "Leave empty. Used only by the developer for testing." } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }