{ "openapi": "3.0.1", "info": { "title": "Housesigma.com Scraper", "description": "Scrape property listings from HouseSigma - including Canadian sales and rental data: prices, dates, addresses, and price per square foot. Ideal for real estate market analysis, trend tracking, and valuation. Fast, structured, and customizable extraction.", "version": "1.0", "x-build-id": "wEQsbkkPBpUBDr2Yo" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lexis-solutions~housesigma/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lexis-solutions-housesigma", "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/lexis-solutions~housesigma/runs": { "post": { "operationId": "runs-sync-lexis-solutions-housesigma", "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/lexis-solutions~housesigma/run-sync": { "post": { "operationId": "run-sync-lexis-solutions-housesigma", "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": [ "startUrls", "maxItems" ], "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "URLs to start with.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Maximum number of items", "type": "integer", "description": "Maximum number of items per original URL.", "default": 10 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Your proxy configuration from Apify", "default": { "useApifyProxy": true, "apifyProxyGroups": [] } }, "debugMode": { "title": "Debug Mode", "type": "boolean", "description": "Activate to see detailed logs", "default": false }, "query": { "title": "Query", "type": "string", "description": "Query to search for" }, "listType": { "title": "List Type", "enum": [ "1", "2" ], "type": "string", "description": "List Type" }, "houseType": { "title": "House Type", "type": "array", "description": "House Type", "items": { "type": "string", "enum": [ "all", "D.", "S.", "A.", "T.", "C.", "L.", "M.", "V.", "O." ], "enumTitles": [ "All", "Detached", "Semi-Detached", "Freehold Townhouse", "Condo Townhouse", "Condo Apt", "Link", "Multiplex", "Vacant Land", "Other" ] } }, "priceMin": { "title": "Price Min", "minimum": 0, "maximum": 5999999, "type": "integer", "description": "Price Min" }, "priceMax": { "title": "Price Max", "minimum": 1, "maximum": 6000000, "type": "integer", "description": "Price Max" }, "listingDays": { "title": "Listing Days", "type": "array", "description": "Listing Days", "items": { "type": "string", "enum": [ "0", "1", "3", "7", "30", "90", "-15", "-30", "-60", "-90" ], "enumTitles": [ "Listing date - All", "Last 1 days", "Last 3 days", "Last 7 days", "Last 30 days", "Last 90 days", "More than 15 days ago", "More than 30 days ago", "More than 60 days ago", "More than 90 days ago" ] } }, "polygonId": { "title": "Polygon ID", "type": "string", "description": "Add your watched area polygon id found from here `https://housesigma.com/user/watched/areas-summary`" }, "mapZoom": { "title": "Map Zoom", "type": "integer", "description": "Map zoom value", "default": 13 }, "token": { "title": "Token (not required)", "type": "string", "description": "Token for extracting data that requires auth (watched areas)" }, "cookies": { "title": "Cookies (not required)", "type": "array", "description": "1. Install the Cookie-Editor Chrome extension.\n2. Go to https://housesigma.com and log in.\n3. Open the Cookie-Editor extension and export cookies as JSON.\n4. Paste the exported cookie contents here.", "default": [] } } }, "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 } } } } } } } } } }