{
  "openapi": "3.0.1",
  "info": {
    "title": "HouseSigma Scraper",
    "description": "Scrape HouseSigma for-sale and for-lease listings with filters or map/search start URLs. Returns listing cards and optional full detail payloads.",
    "version": "1.0",
    "x-build-id": "CAt5gnCJqrBQuTeGY"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/rigelbytes~housesigma-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-rigelbytes-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/rigelbytes~housesigma-scraper/runs": {
      "post": {
        "operationId": "runs-sync-rigelbytes-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/rigelbytes~housesigma-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-rigelbytes-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": {
          "searchQueries": {
            "title": "Search Queries",
            "type": "array",
            "description": "Location or place searches such as \"Toronto\", \"Danforth\", or \"Oshawa\". Resolved via HouseSigma suggest to a municipality / map area. Example: [\"Toronto\"].",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Start URLs",
            "type": "array",
            "description": "Optional HouseSigma map/search URLs (e.g. https://housesigma.com/on/toronto-real-estate/map/?municipality=10343&status=for-sale). Municipality, status, map center, zoom, and page are read from the URL and merged with the filters below.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "province": {
            "title": "Province",
            "enum": [
              "ON",
              "AB",
              "BC",
              "MB",
              "NB",
              "NL",
              "NS",
              "NT",
              "NU",
              "PE",
              "QC",
              "SK",
              "YT"
            ],
            "type": "string",
            "description": "Province code used by HouseSigma APIs.",
            "default": "ON"
          },
          "listStatus": {
            "title": "Listing Status",
            "enum": [
              "for-sale",
              "for-lease",
              "sold",
              "leased",
              "sale-de-listed",
              "lease-de-listed"
            ],
            "type": "string",
            "description": "For sale, for lease, sold, leased, or de-listed.",
            "default": "for-sale"
          },
          "houseTypes": {
            "title": "Property Types",
            "type": "array",
            "description": "Property types to include. Leave as All property types or pick one or more types.",
            "items": {
              "type": "string",
              "enum": [
                "all",
                "D.",
                "S.",
                "A.",
                "T.",
                "C.",
                "L.",
                "M.",
                "V.",
                "O."
              ],
              "enumTitles": [
                "All property types",
                "Detached",
                "Semi-Detached",
                "Freehold Townhouse",
                "Condo Townhouse",
                "Condo Apt",
                "Link",
                "Multiplex",
                "Vacant Land",
                "Other"
              ]
            },
            "default": [
              "all"
            ]
          },
          "priceMin": {
            "title": "Minimum Price",
            "minimum": 0,
            "type": "integer",
            "description": "Minimum list price (sale default currency CAD). For lease searches this is monthly rent.",
            "default": 0
          },
          "priceMax": {
            "title": "Maximum Price",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum list price. Defaults to 6000000 for sale and 10000 for lease when omitted in API defaults; set explicitly to override."
          },
          "listingDays": {
            "title": "Listing Date",
            "enum": [
              "0",
              "1",
              "3",
              "7",
              "30",
              "90",
              "-15",
              "-30",
              "-60",
              "-90"
            ],
            "type": "string",
            "description": "Active listing date filter. Positive = listed within N days; 0 = all; negative = more than N days (e.g. -90).",
            "default": "0"
          },
          "soldDays": {
            "title": "Sold Within Days",
            "minimum": 0,
            "type": "integer",
            "description": "Used when listing status is Sold. Number of days (or omit for default 90).",
            "default": 90
          },
          "deListDays": {
            "title": "De-Listed Within Days",
            "minimum": 0,
            "type": "integer",
            "description": "Used when listing status is de-listed. Number of days (default 90).",
            "default": 90
          },
          "bedrooms": {
            "title": "Bedrooms",
            "type": "array",
            "description": "Bedroom filter values. 0 = all, -10 = 0 bedrooms, 5 = 5+.",
            "items": {
              "type": "string",
              "enum": [
                "0",
                "-10",
                "1",
                "2",
                "3",
                "4",
                "5"
              ],
              "enumTitles": [
                "All",
                "0",
                "1",
                "2",
                "3",
                "4",
                "5+"
              ]
            },
            "default": [
              "0"
            ]
          },
          "bathroomMin": {
            "title": "Bathrooms",
            "enum": [
              "0",
              "1",
              "2",
              "3",
              "4",
              "5"
            ],
            "type": "string",
            "description": "Minimum bathrooms (0 = all, otherwise N+).",
            "default": "0"
          },
          "garageMin": {
            "title": "Garage",
            "enum": [
              "0",
              "1",
              "2",
              "3",
              "4",
              "5"
            ],
            "type": "string",
            "description": "Minimum garage spaces (0 = all, otherwise N+).",
            "default": "0"
          },
          "basement": {
            "title": "Basement",
            "type": "array",
            "description": "Basement features. Empty means any.",
            "items": {
              "type": "string",
              "enum": [
                "finished",
                "separate",
                "walkout"
              ],
              "enumTitles": [
                "Finished",
                "Separate Entrance",
                "Walk-out"
              ]
            },
            "default": []
          },
          "openHouseDate": {
            "title": "Open House",
            "enum": [
              "0",
              "1",
              "2",
              "7",
              "999"
            ],
            "type": "string",
            "description": "Open house filter.",
            "default": "0"
          },
          "listingType": {
            "title": "Listing Type",
            "enum": [
              "all",
              "resale",
              "assignment"
            ],
            "type": "string",
            "description": "Resale vs exclusive assignment.",
            "default": "all"
          },
          "lotSizeMin": {
            "title": "Lot Size Min (sqft)",
            "minimum": 0,
            "type": "integer",
            "description": "Minimum lot size in square feet (0 = unspecified).",
            "default": 0
          },
          "lotSizeMax": {
            "title": "Lot Size Max (sqft)",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum lot size in square feet (10000000 = max).",
            "default": 10000000
          },
          "frontFeetMin": {
            "title": "Lot Front Min (ft)",
            "minimum": 0,
            "type": "integer",
            "description": "Minimum lot frontage in feet.",
            "default": 0
          },
          "frontFeetMax": {
            "title": "Lot Front Max (ft)",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum lot frontage in feet.",
            "default": 100
          },
          "squareFootageMin": {
            "title": "Square Footage Min",
            "minimum": 0,
            "type": "integer",
            "description": "Minimum interior square footage.",
            "default": 0
          },
          "squareFootageMax": {
            "title": "Square Footage Max",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum interior square footage.",
            "default": 4000
          },
          "schoolScoreMin": {
            "title": "School Score Min",
            "minimum": 0,
            "maximum": 10,
            "type": "number",
            "description": "Minimum school score (0–10).",
            "default": 0
          },
          "schoolScoreMax": {
            "title": "School Score Max",
            "minimum": 0,
            "maximum": 10,
            "type": "number",
            "description": "Maximum school score (0–10).",
            "default": 10
          },
          "rentalYieldMin": {
            "title": "Rental Yield Min",
            "minimum": 0,
            "maximum": 0.1,
            "type": "number",
            "description": "Minimum rental yield as a fraction (0.05 = 5%).",
            "default": 0
          },
          "rentalYieldMax": {
            "title": "Rental Yield Max",
            "minimum": 0,
            "maximum": 0.1,
            "type": "number",
            "description": "Maximum rental yield as a fraction (0.1 = max).",
            "default": 0.1
          },
          "municipalityId": {
            "title": "Municipality ID",
            "minimum": 1,
            "type": "integer",
            "description": "Optional HouseSigma municipality id (e.g. 10343 for Toronto). Also read from start URL query municipality=."
          },
          "scrapeDetails": {
            "title": "Scrape Listing Details",
            "type": "boolean",
            "description": "When enabled, fetch full detail for each listing (photos, schools, history, estimates). Charges the listing-details event per successful detail. When disabled, only list-card fields are returned.",
            "default": true
          },
          "detailConcurrency": {
            "title": "Detail Concurrency",
            "minimum": 1,
            "maximum": 25,
            "type": "integer",
            "description": "How many listing-detail requests to run in parallel (1–25). Higher is faster; pair with residential proxy rotation.",
            "default": 8
          },
          "sortType": {
            "title": "Sort Type",
            "minimum": 0,
            "type": "integer",
            "description": "HouseSigma list sort_type integer (0 = site default).",
            "default": 0
          },
          "maxItems": {
            "title": "Max Items",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum number of listings to scrape (0 = unlimited).",
            "default": 50
          },
          "proxyConfiguration": {
            "title": "Proxy Configuration",
            "type": "object",
            "description": "Apify Proxy settings. Residential is recommended.",
            "default": {
              "useApifyProxy": true,
              "apifyProxyGroups": [
                "RESIDENTIAL"
              ]
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}