{
  "openapi": "3.0.1",
  "info": {
    "title": "Apartments.com with Agents | $1 / 1k",
    "description": "Extract structured US rental listings from Apartments.com with pricing, addresses, contact data, amenities, media, and more. Built for enterprise-grade rental market intelligence, lead enrichment, inventory monitoring, and automated analytics pipelines.",
    "version": "0.0",
    "x-build-id": "vaFdjPQkd9VOdWCZT"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/fatihtahta~apartments-com-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-fatihtahta-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/fatihtahta~apartments-com-scraper/runs": {
      "post": {
        "operationId": "runs-sync-fatihtahta-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/fatihtahta~apartments-com-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-fatihtahta-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": "Choose Locations to Search",
            "type": "array",
            "description": "Add one or more locations, such as a city, neighborhood, or ZIP code. Each entry creates its own search so you can review the available listings for every area you care about.",
            "items": {
              "type": "string"
            }
          },
          "limit": {
            "title": "Set a Result Limit for Each Search",
            "minimum": 1,
            "type": "integer",
            "description": "Enter the maximum number of listings to keep for each location you search. Leave it empty if you want to collect as many matching listings as the search can find."
          },
          "min_price": {
            "title": "Set a Minimum Monthly Rent",
            "minimum": 1,
            "type": "integer",
            "description": "Show only listings priced at or above this monthly rent. Leave it empty if you do not want to set a minimum budget threshold."
          },
          "max_price": {
            "title": "Set a Maximum Monthly Rent",
            "minimum": 1,
            "type": "integer",
            "description": "Show only listings priced at or below this monthly rent. Leave it empty if you do not want to place a ceiling on the results."
          },
          "min_area": {
            "title": "Set a Minimum Square Footage",
            "minimum": 1,
            "type": "integer",
            "description": "Show only listings with at least this many square feet. Leave it empty if you do not want to exclude smaller spaces."
          },
          "max_area": {
            "title": "Set a Maximum Square Footage",
            "minimum": 1,
            "type": "integer",
            "description": "Show only listings with no more than this many square feet. Leave it empty if you want larger homes to remain in the results."
          },
          "min_bedroom": {
            "title": "Choose a Minimum Bedroom Count",
            "enum": [
              "studio",
              "1",
              "2",
              "3",
              "4+"
            ],
            "type": "string",
            "description": "Show only listings with at least this many bedrooms. Leave it empty if bedroom count should not set a lower boundary for the search."
          },
          "max_bedroom": {
            "title": "Choose a Maximum Bedroom Count",
            "enum": [
              "studio",
              "1",
              "2",
              "3",
              "4+"
            ],
            "type": "string",
            "description": "Show only listings with no more than this many bedrooms. Leave it empty if you do not want to set an upper bedroom limit."
          },
          "min_bathroom": {
            "title": "Choose a Minimum Bathroom Count",
            "enum": [
              "1+",
              "2+",
              "3+"
            ],
            "type": "string",
            "description": "Show only listings with at least this many bathrooms. Leave it empty if bathroom count should not narrow the search."
          },
          "property_type": {
            "title": "Select Property Types to Include",
            "uniqueItems": true,
            "type": "array",
            "description": "Choose one or more property categories, such as apartments, houses, condos, or townhomes. Leave it empty if you want all property types in the selected locations.",
            "items": {
              "type": "string",
              "enum": [
                "apartments",
                "houses",
                "condos",
                "townhomes"
              ],
              "enumTitles": [
                "Apartments",
                "Houses",
                "Condos",
                "Townhomes"
              ]
            }
          },
          "property_style": {
            "title": "Choose a Property Style",
            "enum": [
              "duplex",
              "new_construction",
              "under_50_units"
            ],
            "type": "string",
            "description": "Limit results to a specific style, such as duplexes, new construction, or properties with fewer than 50 units. Leave it empty if you want the full mix of styles."
          },
          "keyword": {
            "title": "Enter a Keyword to Match",
            "type": "string",
            "description": "Enter a word or short phrase, such as \"garage,\" \"washer dryer,\" or \"utilities included,\" to focus the results. Leave it empty if you want to keep the search broad."
          },
          "housing_type": {
            "title": "Choose a Specialized Housing Type",
            "enum": [
              "student",
              "senior",
              "military",
              "corporate",
              "none"
            ],
            "type": "string",
            "description": "Select a housing type such as student, senior, military, or corporate housing. Leave it empty, or choose None, if you do not want this filter to shape the results."
          },
          "short_term_duration": {
            "title": "Choose a Short-Term Lease Range",
            "enum": [
              "all_short_term",
              "1_2_months",
              "3_4_months",
              "5_6_months"
            ],
            "type": "string",
            "description": "Limit results to listings that advertise short-term availability within the selected duration range. Leave it empty if you want both standard and short-term listings to stay in view."
          },
          "move_in_date": {
            "title": "Choose Your Move-In Date",
            "type": "string",
            "description": "Choose the date you expect to move so the results can reflect that timeframe more closely. Leave it empty if you are still exploring and do not want timing to narrow the results."
          },
          "pet_friendly": {
            "title": "Choose a Pet-Friendly Policy",
            "enum": [
              "dog_friendly",
              "cat_friendly",
              "dog_and_cat_allowed"
            ],
            "type": "string",
            "description": "Limit results to listings that allow dogs, cats, or both. Leave it empty if pet rules are not important for this search."
          },
          "min_renter_rating": {
            "title": "Choose the Lowest Renter Rating to Allow",
            "uniqueItems": true,
            "type": "array",
            "description": "Choose the minimum rating threshold you want listings to meet, such as 4 or 5. Leave it empty if renter ratings should not be used to narrow the results.",
            "items": {
              "type": "string",
              "enum": [
                "4",
                "5"
              ],
              "enumTitles": [
                "4",
                "5"
              ]
            }
          },
          "is_income_restricted": {
            "title": "Include Only Income-Restricted Listings",
            "type": "boolean",
            "description": "Turn this on to keep only listings marked as income restricted. Leave it off if you want both income-restricted and standard listings in the same results."
          },
          "is_accepting_online_applications": {
            "title": "Include Only Listings Accepting Online Applications",
            "type": "boolean",
            "description": "Turn this on to limit results to listings that accept online applications. Leave it off if the application method is not part of your decision criteria."
          },
          "has_move_in_specials": {
            "title": "Include Only Listings with Move-In Specials",
            "type": "boolean",
            "description": "Turn this on to show only listings that mention move-in specials or introductory offers. Leave it off to keep both promotional and standard listings in the results."
          },
          "is_for_rent_by_owner": {
            "title": "Include Only For-Rent-by-Owner Listings",
            "type": "boolean",
            "description": "Turn this on to keep only listings marked as for rent by owner. Leave it off if you want owner-listed and professionally managed homes to appear together."
          },
          "is_room_for_rent": {
            "title": "Include Only Rooms for Rent in Shared Living Spaces",
            "type": "boolean",
            "description": "Turn this on to show listings for individual rooms in shared living spaces rather than full apartments or houses. Leave it off if you want complete units and room rentals to appear together."
          },
          "maximize_coverage": {
            "title": "Collect More Listings That Match Your Criteria",
            "type": "boolean",
            "description": "Keep this enabled to work around result-window limits on large Apartments.com searches. The actor does not loosen your location, price, bedroom, property, pet, lease, or other selected filters; it uses them as the boundary for collecting more matching listings. Turn it off for quick samples or small filtered searches where the standard result set is enough.",
            "default": true
          },
          "proxyConfiguration": {
            "title": "Set Up Proxy and Connection Options",
            "type": "object",
            "description": "Choose proxy settings if you want to improve access stability or search from a different network perspective. Leave the defaults in place if you want a balanced setup for most searches.",
            "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}