# HouseSigma Listing URL Scraper (`bovi/housesigma-scraper`) Actor

Collect verified HouseSigma listing IDs and route fields from the public listing sitemap or supplied listing URLs.

- **URL**: https://apify.com/bovi/housesigma-scraper.md
- **Developed by:** [Vitalii Bondarev](https://apify.com/bovi) (community)
- **Categories:** Real estate
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $1.20 / 1,000 housesigma listing url scrapers

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

## HouseSigma Listing URL Scraper

Collect listing URLs from HouseSigma's public listing sitemap, or submit specific HouseSigma listing URLs. Each dataset item contains the listing ID, canonical URL, province code, municipality slug, and address slug. The actor reads only values present in the sitemap route. It does not invent prices, full street addresses, bedroom counts, or other fields that were not available with a verified listing-to-record mapping.

### Input

| Field | Type | Default | Description |
| --- | --- | --- | --- |
| `province` | string | `ON` | Province to include: `ON`, `BC`, or `AB`. |
| `urls` | string array | `[]` | Optional listing URLs containing `/home/<listing-id>/`. If empty, the actor reads the public active-listing sitemap. |
| `maxResults` | integer | `50` | Maximum number of dataset records to return. |
| `proxyConfiguration` | object | Proxy disabled | Optional Apify Proxy settings. The actor uses a proxy only when `useApifyProxy` is true. |

### Example output

```json
{
  "id_listing": "N0A9X3jLnpayvgxV",
  "url": "https://housesigma.com/on/centre-wellington-real-estate/52-pine-ridge-rd/home/N0A9X3jLnpayvgxV/",
  "province_code": "on",
  "municipality_slug": "centre-wellington-real-estate",
  "address_slug": "52-pine-ridge-rd"
}
```

When `urls` is empty, the actor follows the listing sitemap index advertised by HouseSigma's `robots.txt`, selects listing routes for the chosen province, and stops at `maxResults`. Supplied URLs are accepted only when their host is HouseSigma and their path contains a listing ID. The default run uses no proxy and does not require sign-in.

The public pages inspected for this build returned a JavaScript shell. The detail API redirected without a listing record, and preview data did not match the supplied canonical URL paths, so those fields are deliberately excluded. The dataset schema describes only the route fields this actor can verify directly.

### Price per result

Actor event price: **$0.00 per result**. This actor does not call `Actor.charge`; standard Apify compute and storage charges may still apply.

# Actor input Schema

## `province` (type: `string`):

Canadian province to include: Ontario (ON), British Columbia (BC), or Alberta (AB).

## `urls` (type: `array`):

Optional HouseSigma listing URLs containing /home/<listing-id>/. Leave empty to use the public listing sitemap.

## `maxResults` (type: `integer`):

Maximum number of listing URL records to return.

## `proxyConfiguration` (type: `object`):

Optional Apify Proxy configuration. Proxy use is disabled by default.

## Actor input object example

```json
{
  "province": "ON",
  "urls": [],
  "maxResults": 50,
  "proxyConfiguration": {
    "useApifyProxy": true,
    "apifyProxyGroups": [
      "RESIDENTIAL"
    ]
  }
}
```

# Actor output Schema

## `results` (type: `string`):

Dataset with the scraped records.

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "province": "ON",
    "urls": [],
    "maxResults": 50,
    "proxyConfiguration": {
        "useApifyProxy": true,
        "apifyProxyGroups": [
            "RESIDENTIAL"
        ]
    }
};

// Run the Actor and wait for it to finish
const run = await client.actor("bovi/housesigma-scraper").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "province": "ON",
    "urls": [],
    "maxResults": 50,
    "proxyConfiguration": {
        "useApifyProxy": True,
        "apifyProxyGroups": ["RESIDENTIAL"],
    },
}

# Run the Actor and wait for it to finish
run = client.actor("bovi/housesigma-scraper").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "province": "ON",
  "urls": [],
  "maxResults": 50,
  "proxyConfiguration": {
    "useApifyProxy": true,
    "apifyProxyGroups": [
      "RESIDENTIAL"
    ]
  }
}' |
apify call bovi/housesigma-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,bovi/housesigma-scraper"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/aC0XB1ptcH0R5Vn88/builds/enmvXY32UeLaCN7bK/openapi.json