{ "openapi": "3.0.1", "info": { "title": "HouseSigma Scraper", "description": "[💰 $1.3 / 1K] Extract Ontario, BC, and Alberta real estate from HouseSigma — for-sale, sold, and lease listings with list prices, the HouseSigma AI estimate on for-sale homes, MLS numbers, beds/baths, square footage, taxes, photos, and GPS. Search by city or paste URLs.", "version": "1.0", "x-build-id": "Kdlp6Pbh0STIV09aR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/solidcode~housesigma-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-solidcode-housesigma-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/solidcode~housesigma-scraper/runs": { "post": { "operationId": "runs-sync-solidcode-housesigma-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/solidcode~housesigma-scraper/run-sync": { "post": { "operationId": "run-sync-solidcode-housesigma-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": { "startUrls": { "title": "Start URLs", "type": "array", "description": "Paste HouseSigma URLs directly — a regional search page or a single property page. The scraper auto-detects which kind it is. From a search URL it reads the province and the municipality, and a sold or for-lease page (for example /on/listings/just-sold/) also sets the Listing Status for you. Everything else — Property Type, Max Results, and Listing Status on URLs that do not carry one — still comes from the settings below, so set them to match your URL.", "items": { "type": "string" } }, "searchLocations": { "title": "Search Locations", "type": "array", "description": "Search by city, region, or neighbourhood — for example 'Toronto', 'Mississauga, ON', 'Vancouver, BC', or 'Calgary'. HouseSigma lists Ontario, British Columbia, and Alberta; a city outside those is reported in the run log rather than returning nothing. No need to build URLs manually.", "items": { "type": "string" } }, "listingStatus": { "title": "Listing Status", "enum": [ "for_sale", "sold", "for_lease" ], "type": "string", "description": "Which listings to find. Applies to Search Locations, and to any Start URL that does not already carry a status — HouseSigma's sold and for-lease pages do.", "default": "for_sale" }, "propertyType": { "title": "Property Type", "enum": [ "all", "detached", "semi_detached", "townhouse", "condo_apt", "condo_townhouse", "multiplex", "land" ], "type": "string", "description": "Filter by property type. Applies to Search Locations and to Start URLs alike — a type baked into a URL is not read, so set this to match the URL you paste.", "default": "all" }, "maxResults": { "title": "Max Results", "minimum": 0, "type": "integer", "description": "Maximum number of listings to collect across all URLs and searches. Set to 0 for unlimited. Tip: start with 10-50 to test, then increase. Note: HouseSigma returns at most 4,000 listings per individual search; to go beyond that for one area, split the search by neighbourhood, property type, or price range.", "default": 100 }, "includeDetails": { "title": "Include Full Listing Details", "type": "boolean", "description": "Fetch the full detail page for each listing (description, price history, HouseSigma estimate, lot size, square footage, taxes). Slower but much richer data. When off, only the listing summary fields are returned.", "default": true }, "includePhotos": { "title": "Include Photo Gallery", "type": "boolean", "description": "Include the full photo gallery (image URLs) for each listing. Disable for the fastest, lightest runs.", "default": false } } }, "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 } } } } } } } } } }