{
  "openapi": "3.0.1",
  "info": {
    "title": "Padmapper Scraper - Apartment Rentals & Rent Data",
    "description": "Scrape Padmapper apartment rentals across US/CA cities: rent, beds, baths, sqft, location, photos, source-site links, availability. Monitoring (NEW, UPDATED, REAPPEARED, EXPIRED), incremental runs, resume, MCP export.",
    "version": "0.1",
    "x-build-id": "Cw5VklIeos3W8B47A"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/abotapi~padmapper-rental-listings-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-abotapi-padmapper-rental-listings-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/abotapi~padmapper-rental-listings-scraper/runs": {
      "post": {
        "operationId": "runs-sync-abotapi-padmapper-rental-listings-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/abotapi~padmapper-rental-listings-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-abotapi-padmapper-rental-listings-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",
        "required": [
          "mode"
        ],
        "properties": {
          "mode": {
            "title": "Mode",
            "enum": [
              "search",
              "url"
            ],
            "type": "string",
            "description": "Search finds rental listings in one or more cities with filters. URL mode reads specific listings or buildings you name.",
            "default": "search"
          },
          "locations": {
            "title": "Cities",
            "type": "array",
            "description": "Where to search: one entry per city. Use 'City, ST' (Austin, TX, New York, NY) or a full city name (Toronto, Ontario). The source covers cities across the US and Canada.",
            "items": {
              "type": "string"
            }
          },
          "minPrice": {
            "title": "Min rent ($/mo)",
            "type": "integer",
            "description": "Search mode: only listings whose rent is at least this much per month."
          },
          "maxPrice": {
            "title": "Max rent ($/mo)",
            "type": "integer",
            "description": "Search mode: only listings whose rent is at most this much per month."
          },
          "bedrooms": {
            "title": "Bedrooms",
            "type": "array",
            "description": "Search mode: bedroom counts to keep. Studio means 0. Leave empty for all bedroom counts.",
            "items": {
              "type": "string",
              "enum": [
                "0",
                "1",
                "2",
                "3",
                "4",
                "5"
              ],
              "enumTitles": [
                "Studio",
                "1",
                "2",
                "3",
                "4",
                "5+"
              ]
            }
          },
          "bathrooms": {
            "title": "Min bathrooms",
            "type": "integer",
            "description": "Search mode: only listings with at least this many bathrooms."
          },
          "catsOk": {
            "title": "Cats allowed",
            "type": "boolean",
            "description": "Search mode: keep only listings that allow cats."
          },
          "dogsOk": {
            "title": "Dogs allowed",
            "type": "boolean",
            "description": "Search mode: keep only listings that allow dogs."
          },
          "propertyType": {
            "title": "Property type",
            "enum": [
              "",
              "apartment",
              "house",
              "room",
              "other"
            ],
            "type": "string",
            "description": "Search mode: keep only one kind of property. Leave empty for all kinds."
          },
          "minBeds": {
            "title": "Min bedrooms",
            "minimum": 0,
            "type": "integer",
            "description": "Search mode: shortcut for a bedroom range (0 = studio). Combined with Max bedrooms it picks every bedroom count in between; it narrows the Bedrooms list when both are set."
          },
          "maxBeds": {
            "title": "Max bedrooms",
            "minimum": 0,
            "type": "integer",
            "description": "Search mode: upper end of the bedroom range (5 means 5 or more)."
          },
          "sortBy": {
            "title": "Sort by",
            "enum": [
              "",
              "newest",
              "priceAsc",
              "priceDesc"
            ],
            "type": "string",
            "description": "Search mode: order of the walk inside each city. Matters most when Max items is smaller than the city inventory."
          },
          "listingInputs": {
            "title": "Listing or building links",
            "type": "array",
            "description": "URL mode: city-search links (www.padmapper.com/apartments/austin-tx, optionally with /2-beds, /studios, /pet-friendly, /under-1500, ?max-price=, ?min-price=, ?page=), listing links (/rentals/...), building links (/buildings/...), or bare numeric listing ids. Multi-value supported. A building link returns every listing in that building; links with a p-number or without a slug are resolved through the building page.",
            "default": [
              "https://www.padmapper.com/apartments/austin-tx",
              "https://www.padmapper.com/apartments/toronto-on",
              "https://www.padmapper.com/apartments/austin-tx?max-price=2000",
              "https://www.padmapper.com/apartments/austin-tx?property-categories=house",
              "https://www.padmapper.com/apartments/austin-tx?page=2",
              "https://www.padmapper.com/apartments/austin-tx/2-beds",
              "https://www.padmapper.com/apartments/austin-tx/pet-friendly",
              "https://www.padmapper.com/apartments/austin-tx/under-1500",
              "https://www.padmapper.com/rentals/58574913",
              "https://www.padmapper.com/buildings/p12116/waller-creekside-apartments-at-105-w-51st-st-austin-tx-78751",
              "https://www.padmapper.com/buildings/1717500/blueground-san-francisco-apartments-at-149-san-francisco-new-montgomery-st-san-francisco-ca-94105"
            ],
            "items": {
              "type": "string"
            }
          },
          "urls": {
            "title": "Listing or building links (alias)",
            "type": "array",
            "description": "Alias for Listing or building links, accepted under the name other Apify actors use for URL mode. Each entry is a listing link, a building link, or a numeric listing id; entries are read in order. Pre-filled with the same examples as Listing or building links; if you send only this field, your entries replace the examples.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "maxItems": {
            "title": "Max items",
            "minimum": 0,
            "type": "integer",
            "description": "Stop after this many records (0 = no limit; the run then stops when listings run out).",
            "default": 20
          },
          "currencyHint": {
            "title": "Currency hint (optional)",
            "enum": [
              "USD",
              "CAD"
            ],
            "type": "string",
            "description": "Optional. Fill the currency field of listing records with USD or CAD instead of deriving it from each listing's ZIP or postal code (US-style numeric ZIPs are USD, Canadian alphanumeric postal codes are CAD)."
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Apify Proxy settings. The source refuses datacenter exits on its inventory routes, so the prefilled default uses the residential pool; a plan that includes residential proxy is required."
          },
          "resumeFromRunId": {
            "title": "Resume from a previous run",
            "type": "string",
            "description": "Paste a previous run ID or dataset ID to continue a large pull without returning items already collected there."
          },
          "incrementalMode": {
            "title": "Incremental changes for scheduled runs",
            "type": "boolean",
            "description": "Turn this on for daily or recurring monitoring. The first run returns every matching listing as NEW. Later runs normally return only NEW, UPDATED and REAPPEARED listings. A listing is UPDATED when any returned field changes (rent, availability, bedrooms, address, description, amenities, photos and so on; list order does not count); changedFields names them. updatedAt, isFeatured and the source's own refresh timestamp never count as a change, and neither does anything you list under Ignore fields. Turn on Emit unchanged or Emit expired only when you also want those rows returned (and billed). State is kept separately for each city, filter and link setup; use State key to name or deliberately share a monitoring campaign.",
            "default": false
          },
          "stateKey": {
            "title": "State key (optional, incremental mode only)",
            "type": "string",
            "description": "Optional. Name this monitoring campaign to keep its state stable, or deliberately share state across differently configured runs. Leave empty to let the actor derive a key automatically from the cities and filter settings."
          },
          "emitUnchanged": {
            "title": "Emit unchanged records (incremental mode only)",
            "type": "boolean",
            "description": "Off by default. Turn on to also return listings that have not changed since the last run, marked UNCHANGED. This returns, and bills, extra rows you already have.",
            "default": false
          },
          "emitExpired": {
            "title": "Emit expired records (incremental mode only)",
            "type": "boolean",
            "description": "Off by default. Turn on to also return listings that were present in a previous run but are no longer found, marked EXPIRED. Only produced once a run has fully scanned the tracked search.",
            "default": false
          },
          "ignoreFieldsForChanges": {
            "title": "Ignore fields when detecting changes (incremental mode only)",
            "type": "array",
            "description": "Field names that never count as a change in incremental mode, for example price changes you do not care about. A name matches that field at any depth, and a dotted path such as raw.modified_on matches one exact path. Ignored fields stay in the output and are added to the built-in ignore list (updatedAt, isFeatured and the source's refresh stamp), which is always applied.",
            "items": {
              "type": "string"
            }
          },
          "mcpConnectors": {
            "title": "Pipe results into your apps (optional)",
            "type": "array",
            "description": "Optionally send results into the apps you already use, via Model Context Protocol (MCP) connectors. Authorize one under Apify, Settings, API & Integrations, then select it here. Notion gets a rich page-per-item export; other connectors get a best-effort write or digest. Leave empty to skip; never changes the dataset output.",
            "items": {
              "type": "string"
            }
          },
          "notionParentPageUrl": {
            "title": "Notion parent page (Notion connector only)",
            "type": "string",
            "description": "URL or id of the Notion page under which item pages are created. Required to enable the Notion export; ignored by other connectors."
          },
          "maxNotifyListings": {
            "title": "Max items to export per connector",
            "minimum": 1,
            "maximum": 1000,
            "type": "integer",
            "description": "Cap on items written to each connector per run. Does not affect the dataset.",
            "default": 50
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}