{
  "openapi": "3.0.1",
  "info": {
    "title": "Realtor.ca Scraper - Canada Real Estate, Agents & Leads",
    "description": "Scrape Realtor.ca for-sale & for-rent homes across Canada: price, beds/baths, size, address & geo, photos, remarks, MLS#, plus listing agent & brokerage leads. Search by city, map URL or MLS number. New-listing & price-drop monitoring. No login, key or browser.",
    "version": "0.1",
    "x-build-id": "lBuHpHM60AS0CJf6h"
  },
  "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 (with the listing agent & brokerage embedded). `Agents` = the same search, but output deduplicated **agent / brokerage leads** (name, phone, brokerage, cities covered, active-listing count, 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",
            "type": "array",
            "description": "Canadian cities to scrape (e.g. `Toronto`, `Vancouver`, `Calgary`, `Ottawa`, `Montreal`, `Halifax`). 55+ major metros are built in. For any other area, use **Bounding boxes**, **Center points**, or a **Realtor.ca map URL** below.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Realtor.ca map URLs",
            "type": "array",
            "description": "Optional. Open [realtor.ca](https://www.realtor.ca/map), search your area, apply any filters, then copy the `https://www.realtor.ca/map#...` URL from your address bar. The map's bounding box is read straight from the URL — works for any neighbourhood, town or region.",
            "items": {
              "type": "string"
            }
          },
          "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 bounding 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 Realtor.ca MLS® number (e.g. `A2321763`, `C12363977`).",
            "items": {
              "type": "string"
            }
          },
          "propertyType": {
            "title": "Property type",
            "enum": [
              "any",
              "residential",
              "condo",
              "recreational",
              "vacant-land",
              "multi-family",
              "agriculture",
              "parking"
            ],
            "type": "string",
            "description": "Limit to a Realtor.ca property bucket.",
            "default": "any"
          },
          "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. Leave empty for no filter."
          },
          "priceMax": {
            "title": "Maximum price / rent",
            "minimum": 0,
            "type": "integer",
            "description": "Only keep listings priced at most this much (CAD). 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."
          },
          "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 request (e.g. `{ \"BuildingTypeId\": 1 }`). For power users who know the API."
          },
          "enrichDetails": {
            "title": "Enrich full property details",
            "type": "boolean",
            "description": "Fetch each listing's full Realtor.ca detail record (complete public remarks, room/building details, land, history). The grid already carries most fields, so enrichment mainly fills in the full description. Adds one API call per listing (and the per-detail charge). Leave off for a fast, cheap grid run.",
            "default": false
          },
          "subdivideLargeAreas": {
            "title": "Subdivide large areas",
            "type": "boolean",
            "description": "Realtor.ca returns at most 500 listings per query. When an area has more, automatically split it into smaller map tiles to capture them all. Turn off to take only the first ~500 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 = 4× more tiles). 2 covers very large metros; raise for exhaustive coverage of a whole city.",
            "default": 2
          },
          "maxResults": {
            "title": "Max results (whole run)",
            "minimum": 1,
            "maximum": 200000,
            "type": "integer",
            "description": "Global cap on the total number of records emitted in this run.",
            "default": 200
          },
          "maxResultsPerArea": {
            "title": "Max results per area",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "Cap per city / box / point. Combine with subdivision for deep coverage of large markets.",
            "default": 500
          },
          "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). Perfect for new-listing alerts and price-drop tracking. Pairs with Apify Schedules.",
            "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"
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 8,
            "type": "integer",
            "description": "Maximum parallel detail requests. Keep moderate — Realtor.ca's edge rate-challenges bursts, and the actor already rotates a fresh proxy session per request.",
            "default": 4
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Proxy settings. Realtor.ca sits behind Imperva Incapsula, which rate-blocks datacenter and single IPs, so **Canadian residential proxies are the default and recommended** setting. Datacenter proxies will fail with blocks.",
            "default": {
              "useApifyProxy": true,
              "apifyProxyGroups": [
                "RESIDENTIAL"
              ],
              "apifyProxyCountry": "CA"
            }
          },
          "urlsFromFile": {
            "title": "Import URLs from a file",
            "type": "string",
            "description": "Paste a list of URLs (one per line), OR one link to a .txt/.csv file, Google Sheet or Google Drive file containing them. Lets you import many Start URLs at once instead of typing each. Google Sheet/Drive share links are handled automatically."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}