{
  "openapi": "3.0.1",
  "info": {
    "title": "Apartments.com Scraper — Rentals, Fees, Reviews & Media",
    "description": "Scrape US rental listings from Apartments.com at scale — rent, beds/baths, per-unit availability, fees, amenities, leasing phone, ratings, reviews, walk scores and 3D tours — as structured JSON. Runs on the official mobile API for reliability. Pay only for the results you get.",
    "version": "1.0",
    "x-build-id": "nle7vL481J3vOVIGs"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/axlymxp~apartments-com-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-axlymxp-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/axlymxp~apartments-com-scraper/runs": {
      "post": {
        "operationId": "runs-sync-axlymxp-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/axlymxp~apartments-com-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-axlymxp-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": {
          "location": {
            "title": "Location",
            "type": "string",
            "description": "Free-text location to search: a city (\"Austin, TX\"), a ZIP code, or a neighborhood. Resolved automatically to the matching geography."
          },
          "startUrls": {
            "title": "Start URLs (optional)",
            "type": "array",
            "description": "Apartments.com search-results or property URLs. Property URLs are scraped directly; search URLs are resolved to their location. Use instead of, or alongside, Location.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "listingKeys": {
            "title": "Listing keys (optional)",
            "type": "array",
            "description": "Explicit 7-character Apartments.com listing keys (e.g. \"s286zb6\"), the trailing segment of a property URL. Scrapes exactly these properties.",
            "items": {
              "type": "string"
            }
          },
          "coordinates": {
            "title": "Coordinate search (optional)",
            "type": "object",
            "description": "Point search around a GPS coordinate: {\"lat\": 30.27, \"lng\": -97.74, \"radiusMiles\": 5}."
          },
          "maxItems": {
            "title": "Max listings",
            "minimum": 1,
            "type": "integer",
            "description": "Stop after this many listings (properties). Each listing is one dataset row.",
            "default": 100
          },
          "minPrice": {
            "title": "Min rent ($/month)",
            "minimum": 0,
            "type": "integer",
            "description": "Only listings with rent at or above this monthly price."
          },
          "maxPrice": {
            "title": "Max rent ($/month)",
            "minimum": 0,
            "type": "integer",
            "description": "Only listings with rent at or below this monthly price."
          },
          "minBeds": {
            "title": "Min bedrooms",
            "minimum": 0,
            "type": "integer",
            "description": "Minimum bedroom count (0 = studio)."
          },
          "maxBeds": {
            "title": "Max bedrooms",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum bedroom count."
          },
          "minBaths": {
            "title": "Min bathrooms",
            "minimum": 0,
            "type": "integer",
            "description": "Minimum bathroom count."
          },
          "maxBaths": {
            "title": "Max bathrooms",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum bathroom count."
          },
          "minSqft": {
            "title": "Min square feet",
            "minimum": 0,
            "type": "integer",
            "description": "Minimum unit area in square feet."
          },
          "maxSqft": {
            "title": "Max square feet",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum unit area in square feet."
          },
          "propertyType": {
            "title": "Property type",
            "uniqueItems": true,
            "type": "array",
            "description": "Restrict to one or more property types. Leave empty for all.",
            "items": {
              "type": "string",
              "enum": [
                "apartments",
                "condos",
                "houses",
                "townhomes"
              ],
              "enumTitles": [
                "Apartments",
                "Condos",
                "Houses",
                "Townhomes"
              ]
            }
          },
          "petPolicy": {
            "title": "Pet policy",
            "enum": [
              "any",
              "cats",
              "dogs"
            ],
            "type": "string",
            "description": "Filter by pet-friendliness."
          },
          "minRating": {
            "title": "Minimum rating",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "Only listings with at least this star rating (1–5)."
          },
          "keywords": {
            "title": "Keywords",
            "type": "string",
            "description": "Free-text keyword filter (e.g. \"pool\", \"loft\")."
          },
          "sortBy": {
            "title": "Sort order",
            "enum": [
              "best_match",
              "price_low",
              "price_high",
              "newest"
            ],
            "type": "string",
            "description": "Order in which listings are returned.",
            "default": "best_match"
          },
          "includeDetails": {
            "title": "Include full property detail",
            "type": "boolean",
            "description": "Fetch per-unit availability & rent, one-time and recurring fees, lease terms, amenities, pet & parking policies, schools and transit for each listing.",
            "default": true
          },
          "includeReviews": {
            "title": "Include renter reviews",
            "type": "boolean",
            "description": "Fetch renter reviews (title, text, rating, date) for each listing.",
            "default": false
          },
          "includeWalkScore": {
            "title": "Include walk / transit / bike scores",
            "type": "boolean",
            "description": "Fetch Walk Score, Transit Score and Bike Score for each listing.",
            "default": true
          },
          "includeMedia": {
            "title": "Include media gallery",
            "type": "boolean",
            "description": "Fetch the full media gallery: photos, videos and 3D tour links.",
            "default": false
          },
          "proxyConfiguration": {
            "title": "Proxy configuration",
            "type": "object",
            "description": "Proxy used for API calls. Apify Residential (US) is recommended for large runs.",
            "default": {
              "useApifyProxy": true,
              "apifyProxyGroups": [
                "RESIDENTIAL"
              ],
              "apifyProxyCountry": "US"
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}