{
  "openapi": "3.0.1",
  "info": {
    "title": "Apartments.com Scraper & Floor Plan Units",
    "description": "🏢 Apartments.com Scraper (apartments-com-scraper) pulls apartment listings, prices, amenities, and availability from Apartments.com fast. 🚀 Perfect for real estate research, lead gen & market analysis—organized, export-ready data. ✅",
    "version": "0.1",
    "x-build-id": "KRib6ZP030rTJtHIc"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/simpleapi~apartments-com-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-simpleapi-apartments-com-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/simpleapi~apartments-com-scraper/runs": {
      "post": {
        "operationId": "runs-sync-simpleapi-apartments-com-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/simpleapi~apartments-com-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-simpleapi-apartments-com-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": {
          "propertyUrls": {
            "title": "🏢 Property or search URLs",
            "type": "array",
            "description": "Apartments.com URLs in bulk. Property pages (e.g. `https://www.apartments.com/forte-at-1440-beacon-brookline-ma/wqc416h/`) are scraped directly; city / neighbourhood / map URLs (e.g. `https://www.apartments.com/brookline-ma/`) are crawled and every property on them is scraped. Either fill this or 📍 Location below.",
            "items": {
              "type": "string"
            }
          },
          "locationSearch": {
            "title": "📍 Location (city, neighbourhood or ZIP)",
            "type": "string",
            "description": "Free-text location instead of a URL — e.g. `Brookline MA`, `Miami Beach FL`, `10001`. Converted into an Apartments.com search URL and crawled like any other start URL."
          },
          "maxProperties": {
            "title": "🔢 Maximum properties",
            "minimum": 0,
            "maximum": 10000,
            "type": "integer",
            "description": "Caps PROPERTY rows only. Unit and floor-plan rows are additional and capped separately below. Example: maxProperties=5 + maxUnitsPerProperty=20 → up to 5 property rows and up to 100 unit rows. 0 = unlimited.",
            "default": 5
          },
          "lastSearchPage": {
            "title": "📚 Last search page to crawl",
            "minimum": 0,
            "maximum": 28,
            "type": "integer",
            "description": "Stop paginating a search URL after this page (40 properties per page). 0 = crawl until Apartments.com runs out of results, which is at most 28 pages per search.",
            "default": 0
          },
          "includeUnits": {
            "title": "🛏️ Collect individual units",
            "type": "boolean",
            "description": "Emit one child row per individually-listed unit — unit number, exact rent, beds, baths, sqft, price per sqft, move-in date and the external application link. Live coverage: units are published on 9/9 sampled properties.",
            "default": true
          },
          "maxUnitsPerProperty": {
            "title": "🔢 Maximum units per property",
            "minimum": 0,
            "maximum": 500,
            "type": "integer",
            "description": "Caps how many unit child rows each property emits. Large communities really do list 79+ distinct units, so leave a cap on unless you want everything. 0 = unlimited.",
            "default": 25
          },
          "includeFloorPlans": {
            "title": "📐 Collect floor-plan models",
            "type": "boolean",
            "description": "Emit one child row per floor-plan model — plan name, beds/baths, sqft range, plan rent band, pricing model and the plan image URL. Plan images come from the listing DOM; a plan with no published image returns `null` rather than a placeholder.",
            "default": true
          },
          "maxFloorPlansPerProperty": {
            "title": "🔢 Maximum floor plans per property",
            "minimum": 0,
            "maximum": 500,
            "type": "integer",
            "description": "Caps how many floor-plan child rows each property emits. 0 = unlimited.",
            "default": 25
          },
          "availabilityFilter": {
            "title": "📅 Availability filter",
            "enum": [
              "any",
              "now",
              "future"
            ],
            "type": "string",
            "description": "Which units to keep. `Available now` keeps only units Apartments.com marks \"Now\"; `Future move-in` keeps only dated units. The property row's availability profile is calculated from the units that survive this filter.",
            "default": "any"
          },
          "minUnitRent": {
            "title": "💵 Minimum unit rent (USD)",
            "minimum": 0,
            "maximum": 100000,
            "type": "integer",
            "description": "Drop units renting below this amount. Applied to the exact per-unit rent, not the property's advertised band. 0 = no minimum.",
            "default": 0
          },
          "maxUnitRent": {
            "title": "💰 Maximum unit rent (USD)",
            "minimum": 0,
            "maximum": 100000,
            "type": "integer",
            "description": "Drop units renting above this amount. Example: minUnitRent=2000 + maxUnitRent=3500 → only units between $2,000 and $3,500. 0 = no maximum.",
            "default": 0
          },
          "includeAllImages": {
            "title": "🖼️ Include the photo gallery",
            "type": "boolean",
            "description": "Add an `images` array of every gallery photo URL published for the property (28–159 photos on the sampled properties). Off by default because it makes rows considerably larger.",
            "default": false
          },
          "includeVirtualTours": {
            "title": "🎥 Include video & 3D tours",
            "type": "boolean",
            "description": "Add a `virtualTours` array of video tours (content / embed / thumbnail URLs, upload date) and 3D tour links. Not every property publishes tours — those return an empty array.",
            "default": false
          },
          "requestDelay": {
            "title": "⏱️ Delay between page loads (seconds)",
            "minimum": 0,
            "maximum": 30,
            "type": "number",
            "description": "Pause before each page load, plus a small random jitter. Raising it makes a run slower but gentler on the exit IP. Default is 1.0.",
            "default": 1
          },
          "proxyConfiguration": {
            "title": "🛡️ Proxy configuration",
            "type": "object",
            "description": "Apify **US Residential** is used by default and is required for Apartments.com — datacenter and direct traffic is challenged. Paste custom proxy URLs here to use your own residential provider instead.",
            "default": {
              "useApifyProxy": true,
              "apifyProxyGroups": [
                "RESIDENTIAL"
              ]
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}