{
  "openapi": "3.0.1",
  "info": {
    "title": "Realtor.ca Scraper - Canada Real Estate, Agents & Leads",
    "description": "Scrape Realtor.ca homes for sale & rent across Canada: price, beds/baths, size, address & geo, full description, all photos, MLS#, plus listing agent & brokerage leads. Any city, map URL or MLS number. New-listing & price-drop alerts. Independent tool, not affiliated with CREA.",
    "version": "0.1",
    "x-build-id": "ieaqm7CuhVcYk48dF"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrapesage~realtor-ca-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrapesage-realtor-ca-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/scrapesage~realtor-ca-scraper/runs": {
      "post": {
        "operationId": "runs-sync-scrapesage-realtor-ca-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/scrapesage~realtor-ca-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-scrapesage-realtor-ca-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": {
          "mode": {
            "title": "Mode",
            "enum": [
              "properties",
              "agents"
            ],
            "type": "string",
            "description": "`Properties` = one rich record per listing (full description, every photo, the listing agent & brokerage embedded). `Agents` = the same search, but output deduplicated **agent / brokerage leads** (name, phone, brokerage, cities covered, active-listing count, price range, lead score) instead of listings.",
            "default": "properties"
          },
          "transactionType": {
            "title": "Transaction type",
            "enum": [
              "sale",
              "rent",
              "all"
            ],
            "type": "string",
            "description": "Scrape homes `For sale`, `For rent`, or both.",
            "default": "sale"
          },
          "searchCities": {
            "title": "Cities or places",
            "type": "array",
            "description": "Any Canadian city, town, district or neighbourhood (e.g. `Toronto`, `Canmore`, `North Vancouver`, `Muskoka`, `Le Plateau-Mont-Royal`). 55+ major metros use a built-in metro-area box; every other name is looked up on Realtor.ca and searched inside its exact boundary. Add the province to an ambiguous name (`Springfield, MB`).",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Realtor.ca map or listing URLs",
            "type": "array",
            "description": "Optional. A Realtor.ca map search (open [realtor.ca/map](https://www.realtor.ca/map), search your area, set any filters, copy the `https://www.realtor.ca/map#...` address: the area AND the map's own filters are used), or listing pages (`https://www.realtor.ca/real-estate/...`) to scrape those exact listings.",
            "items": {
              "type": "string"
            }
          },
          "urlsFromFile": {
            "title": "Import URLs from a file",
            "type": "string",
            "description": "Paste a list of Realtor.ca map or listing URLs (one per line), OR one link to a .txt/.csv file, Google Sheet or Google Drive file containing them. Google Sheet/Drive share links are handled automatically."
          },
          "boundingBoxes": {
            "title": "Bounding boxes",
            "type": "array",
            "description": "Optional. Explicit map rectangles as `latMin,lngMin,latMax,lngMax` (e.g. `43.58,-79.64,43.86,-79.12` for Toronto). Each box is searched directly.",
            "items": {
              "type": "string"
            }
          },
          "centerPoints": {
            "title": "Center points (lat,lng,radiusKm)",
            "type": "array",
            "description": "Optional. A point + radius as `lat,lng,radiusKm` (e.g. `43.6532,-79.3832,8`). A box is built around the point. Handy for a custom catchment around an address.",
            "items": {
              "type": "string"
            }
          },
          "mlsNumbers": {
            "title": "MLS numbers",
            "type": "array",
            "description": "Optional. Look up specific listings directly by their MLS® number (e.g. `W13874426`, `A2321763`).",
            "items": {
              "type": "string"
            }
          },
          "propertyType": {
            "title": "Property type",
            "enum": [
              "any",
              "residential",
              "condo",
              "recreational",
              "vacant-land",
              "multi-family",
              "agriculture",
              "parking"
            ],
            "type": "string",
            "description": "Limit to one of Realtor.ca's own property categories (its Condo / Strata category also holds co-op and co-ownership apartments).",
            "default": "any"
          },
          "buildingType": {
            "title": "Building type",
            "enum": [
              "house",
              "row-townhouse",
              "apartment",
              "duplex",
              "triplex",
              "fourplex",
              "multi-family",
              "mobile-home",
              "residential-commercial-mix",
              "recreational",
              "offices",
              "retail",
              "warehouse",
              "special-purpose",
              "no-building"
            ],
            "type": "string",
            "description": "Only one building type (Realtor.ca accepts one per search). Leave empty for all."
          },
          "ownershipType": {
            "title": "Ownership",
            "enum": [
              "freehold",
              "condo",
              "timeshare-life-lease",
              "leasehold"
            ],
            "type": "string",
            "description": "Freehold, condominium/strata, timeshare/life lease or leasehold. Leave empty for all."
          },
          "priceMin": {
            "title": "Minimum price / rent",
            "minimum": 0,
            "type": "integer",
            "description": "Only keep listings priced at least this much (CAD). For rentals this is the minimum monthly rent (with `Sale + rent`, sales and rentals are each filtered by their own price). Leave empty for no filter."
          },
          "priceMax": {
            "title": "Maximum price / rent",
            "minimum": 0,
            "type": "integer",
            "description": "Only keep listings priced at most this much (CAD; monthly rent for rentals). Leave empty for no filter."
          },
          "bedsMin": {
            "title": "Minimum bedrooms",
            "minimum": 0,
            "maximum": 10,
            "type": "integer",
            "description": "Minimum number of bedrooms. Leave empty for no filter."
          },
          "bathsMin": {
            "title": "Minimum bathrooms",
            "minimum": 0,
            "maximum": 10,
            "type": "integer",
            "description": "Minimum number of bathrooms. Leave empty for no filter."
          },
          "keywords": {
            "title": "Keywords in the description",
            "type": "string",
            "description": "Only listings whose description or listed features mention these words, e.g. `pool, waterfront`. Words separated by commas match ANY of them; words separated by spaces match that exact phrase (`basement apartment`)."
          },
          "listedSinceDays": {
            "title": "Listed in the last N days",
            "minimum": 1,
            "maximum": 365,
            "type": "integer",
            "description": "Only listings added to Realtor.ca in the last N days (1 = today's new listings). Leave empty for all."
          },
          "openHouseOnly": {
            "title": "Open houses only",
            "type": "boolean",
            "description": "Only listings with an open house scheduled in the next 30 days (the dates are in each record's `openHouses`).",
            "default": false
          },
          "sort": {
            "title": "Sort by",
            "enum": [
              "newest",
              "oldest",
              "price-high-low",
              "price-low-high"
            ],
            "type": "string",
            "description": "Order listings are pulled in (also controls which appear first when capped). 'Newest' is best for monitoring.",
            "default": "newest"
          },
          "customSearchParams": {
            "title": "Custom search params (advanced)",
            "type": "object",
            "description": "Optional. Extra Realtor.ca `PropertySearch_Post` parameters merged verbatim into the search (e.g. `{ \"ParkingSpaceRange\": \"2-0\" }`). For power users who know the API."
          },
          "enrichDetails": {
            "title": "Enrich full property details",
            "type": "boolean",
            "description": "Every listing already comes with its full description, all photos, building age, community and neighbourhood. Turn this on to add the full property facts as well: property tax, condo/maintenance fee (+ what it includes), management company, every room with its level and size, appliances, heating & fuel, cooling, basement, fireplace, exterior, flooring, foundation, construction style, water, sewer, utilities, features, view, cross streets, lot depth and the listing board (charged as one extra 'Property detail' event per listing).",
            "default": false
          },
          "maxResults": {
            "title": "Max results (whole run)",
            "minimum": 1,
            "maximum": 200000,
            "type": "integer",
            "description": "Total number of records emitted in this run. With several cities or areas, each gets a fair share and any share an area cannot fill goes to the others.",
            "default": 200
          },
          "maxResultsPerArea": {
            "title": "Max results per area",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "Cap per city / box / point / map URL (in Agents mode: how many listings are scanned for agents in each area).",
            "default": 500
          },
          "subdivideLargeAreas": {
            "title": "Subdivide large areas",
            "type": "boolean",
            "description": "Realtor.ca returns at most 600 listings per search. When an area has more, it is split into smaller map tiles automatically to reach them. Turn off to take only the first ~600 of each area.",
            "default": true
          },
          "maxSubdivisionDepth": {
            "title": "Max subdivision depth",
            "minimum": 0,
            "maximum": 4,
            "type": "integer",
            "description": "How many times a busy area may be split (each level = 4x more tiles). 2 covers most cities; raise it for exhaustive coverage of a large metro.",
            "default": 2
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 16,
            "type": "integer",
            "description": "How many listings are completed in parallel. The default suits almost every run.",
            "default": 6
          },
          "monitorMode": {
            "title": "Monitoring mode - only new & changed",
            "type": "boolean",
            "description": "Remember listings already returned and emit ONLY listings that are **new** or whose **price/status changed** since the last run (tagged `changeType`: new / price_drop / price_increase / status_change). The first run returns the current listings (up to Max results); later runs return only what is new or changed since then. Perfect for new-listing alerts and price-drop tracking. Pairs with Apify Schedules. Applies to Properties mode.",
            "default": false
          },
          "monitorStoreName": {
            "title": "Monitor store name",
            "type": "string",
            "description": "Named key-value store that holds the 'already seen' listings for monitoring mode. Use a different name per tracked market to keep histories separate (lowercase letters, digits and hyphens).",
            "default": "realtor-ca-monitor"
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Leave on the default (Apify proxy, automatic): the actor uses datacenter proxies and switches to Canadian residential proxies on its own whenever Realtor.ca refuses a request. Any other setting (a proxy group, your own proxies, no proxy) is used exactly as given.",
            "default": {
              "useApifyProxy": true
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}