{
  "openapi": "3.0.1",
  "info": {
    "title": "Zumper Scraper: Rental Listings, Rent Changes and Contacts",
    "description": "Zumper scraper for rental listings in any US or Canadian city: rent, beds, baths, square feet, address, photos, amenities, agent and phone. Search by city or paste a Zumper link, filter by rent and bedrooms, and schedule it for new listings and rent drops only. JSON, CSV, Excel.",
    "version": "0.0",
    "x-build-id": "pyOBMVE9ZxukV3vEJ"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/memo23~zumper-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-memo23-zumper-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/memo23~zumper-scraper/runs": {
      "post": {
        "operationId": "runs-sync-memo23-zumper-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/memo23~zumper-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-memo23-zumper-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": {
          "startUrls": {
            "title": "Zumper search or listing URLs",
            "type": "array",
            "description": "Paste any zumper.com page: a city or neighborhood search (filters in the address are kept, e.g. <code>/apartments-for-rent/chicago-il/2-beds/under-3000</code>), a building page or a single listing page. Leave empty if you use <b>Cities</b> below.",
            "items": {
              "type": "string"
            }
          },
          "locations": {
            "title": "Cities",
            "type": "array",
            "description": "Search by city instead of URL: <code>Chicago, IL</code>, <code>Austin TX</code> or <code>new-york-ny</code>. Each city is one search. The rent, bedroom and other filters below apply to it.",
            "items": {
              "type": "string"
            }
          },
          "maxItems": {
            "title": "Max listings per run",
            "minimum": 1,
            "type": "integer",
            "description": "Stop after this many listings. With change tracking on, this is how many search results are checked, so set it high enough to cover the whole search.",
            "default": 10
          },
          "minRent": {
            "title": "Min monthly rent ($)",
            "minimum": 0,
            "type": "integer",
            "description": "Leave out listings below this monthly rent. Applies to every search."
          },
          "maxRent": {
            "title": "Max monthly rent ($)",
            "minimum": 0,
            "type": "integer",
            "description": "Leave out listings above this monthly rent."
          },
          "minBedrooms": {
            "title": "Min bedrooms",
            "minimum": 0,
            "maximum": 10,
            "type": "integer",
            "description": "0 means studios are included."
          },
          "maxBedrooms": {
            "title": "Max bedrooms",
            "minimum": 0,
            "maximum": 10,
            "type": "integer",
            "description": "Highest bedroom count to keep."
          },
          "minBathrooms": {
            "title": "Min bathrooms",
            "minimum": 0,
            "maximum": 10,
            "type": "integer",
            "description": "Keep listings with at least this many bathrooms."
          },
          "minSquareFeet": {
            "title": "Min square feet",
            "minimum": 0,
            "type": "integer",
            "description": "Keep listings with at least this much floor space."
          },
          "maxSquareFeet": {
            "title": "Max square feet",
            "minimum": 0,
            "type": "integer",
            "description": "Keep listings with at most this much floor space."
          },
          "petFriendly": {
            "title": "Pet-friendly only",
            "type": "boolean",
            "description": "Keep only listings that accept pets.",
            "default": false
          },
          "trackChanges": {
            "title": "Compare with the previous run",
            "type": "boolean",
            "description": "Remember each listing's rent, and on the next run add <code>changeType</code> (<code>new</code>, <code>price_drop</code>, <code>price_increase</code> or <code>unchanged</code>), <code>previousMinPrice</code>, <code>previousMaxPrice</code>, <code>priceChange</code> and <code>firstSeenAt</code> to every row. Put the run on a schedule to follow new listings and rent cuts over time.",
            "default": false
          },
          "onlyChanges": {
            "title": "Only new or changed listings",
            "type": "boolean",
            "description": "Leave out listings whose rent did not change since the previous run of this monitor. They are not written to the dataset, so they are not billed. Turns on <b>Compare with the previous run</b> by itself.",
            "default": false
          },
          "monitorName": {
            "title": "Monitor name",
            "type": "string",
            "description": "Keeps separate watch lists apart: two schedules with different names never compare against each other. Use one name per city or saved search you track.",
            "default": "default"
          },
          "enrichEmails": {
            "title": "Find contact emails (experimental)",
            "type": "boolean",
            "description": "Look up a contact email for the property manager or brokerage behind each listing on its own website. Adds <code>contactEmail</code>, <code>contactWebsite</code> and an <code>emailEnrichment</code> object. Best-effort; billed only when an email is found.",
            "default": false
          },
          "storeName": {
            "title": "Skip listings saved in this store",
            "type": "string",
            "description": "Older de-duplication option. Name a key-value store (letters, numbers, hyphens) and every listing it has seen before is skipped on later runs. For rent changes as well as new listings, use the alerts section above instead."
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "Most pages fetched at the same time.",
            "default": 10
          },
          "minConcurrency": {
            "title": "Min concurrency",
            "minimum": 1,
            "type": "integer",
            "description": "Fewest pages fetched at the same time.",
            "default": 1
          },
          "maxRequestRetries": {
            "title": "Max retries per page",
            "minimum": 0,
            "type": "integer",
            "description": "How many times a page that failed to load is tried again.",
            "default": 10
          },
          "proxy": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Leave as is: the default works out of the box. Supply your own only if you need a specific country or provider.",
            "default": {}
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}