{
  "openapi": "3.0.1",
  "info": {
    "title": "Apartments.com Scraper - US Rental Listings",
    "description": "Extract US rental listings from Apartments.com with rents, addresses, contact details, and optional floorplan, unit, and review rows. Pay per delivered row plus a run start fee.",
    "version": "0.6",
    "x-build-id": "MIew9zcVBeuCPndNU"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/lentic_clockss~apartments-com-rental-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-lentic_clockss-apartments-com-rental-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/lentic_clockss~apartments-com-rental-scraper/runs": {
      "post": {
        "operationId": "runs-sync-lentic_clockss-apartments-com-rental-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/lentic_clockss~apartments-com-rental-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-lentic_clockss-apartments-com-rental-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": "Enter one US city and state, such as Austin, TX. Start URLs take priority when both fields are supplied."
          },
          "startUrls": {
            "title": "Start URLs",
            "type": "array",
            "description": "Enter Apartments.com search, listing, or sitemap URLs, including URLs on its subdomains. These are used instead of Location.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "maxItems": {
            "title": "Maximum rows per location or URL",
            "minimum": 1,
            "maximum": 200,
            "type": "integer",
            "description": "Maximum rows per location or Start URL, from 1 to 200; default 70. Listings, floorplans, units, and reviews count together, subject to your total cost limit and the free-plan limit of 200 rows per run and 10 runs.",
            "default": 70
          },
          "propertyType": {
            "title": "Property type",
            "enum": [
              "apartments",
              "houses",
              "condos",
              "townhomes",
              "all"
            ],
            "type": "string",
            "description": "Choose apartments or all rentals for normal searches. House, condo, and townhome filters are not applied; those values can return all rental types, with propertyTypeFilter set to not_applied in RUN_SUMMARY.",
            "default": "apartments"
          },
          "maxPages": {
            "title": "Maximum search pages",
            "minimum": 1,
            "maximum": 18,
            "type": "integer",
            "description": "Optional page limit from 1 to 18. Leave at the default for normal runs; increasing this does not increase the row allowance.",
            "default": 1
          },
          "scrapeDetails": {
            "title": "Apply detail-failure threshold",
            "type": "boolean",
            "description": "Basic listing details are already requested in normal runs. Enable this to apply maxDetailFailRatio after at least two detail attempts.",
            "default": false
          },
          "includeUnits": {
            "title": "Include floorplans and available units",
            "type": "boolean",
            "description": "Add separate floorplan and available unit rows with parent listing identity and location. Each row is billed and counts toward maxItems.",
            "default": false
          },
          "rowLayout": {
            "title": "Row layout",
            "enum": [
              "rows",
              "legacy"
            ],
            "type": "string",
            "description": "This Actor always returns one entity per row. Keep rows selected; nested output is not available.",
            "default": "rows"
          },
          "maxDetailFailRatio": {
            "title": "Maximum detail failure ratio",
            "minimum": 0,
            "maximum": 1,
            "type": "number",
            "description": "With scrapeDetails enabled, fail if failed detail attempts divided by all detail attempts exceeds this value, after at least two attempts. Use a value from 0 to 1.",
            "default": 0.5
          },
          "requestDelayMillis": {
            "title": "Pause between requests (milliseconds)",
            "minimum": 0,
            "maximum": 10000,
            "type": "integer",
            "description": "Pause between listing requests, from 0 to 10000 milliseconds. The default is 500.",
            "default": 500
          },
          "blockImages": {
            "title": "Reduce image loading",
            "type": "boolean",
            "description": "Leave at the default for normal runs. Use includePhotos to request image information in the output.",
            "default": true
          },
          "deepCoverage": {
            "title": "Broader area coverage",
            "type": "boolean",
            "description": "Request broader coverage when a large area has more listings than a normal search returns. This can take longer and does not guarantee complete inventory.",
            "default": false
          },
          "optionMask": {
            "title": "Advanced search filter",
            "type": "integer",
            "description": "Optional numeric search-filter value. Leave empty unless you know the Apartments.com value needed for your search."
          },
          "sitemapSince": {
            "title": "Earliest sitemap modification date",
            "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
            "type": "string",
            "description": "For sitemap Start URLs, keep entries whose reported modification date is on or after this date. Use YYYY-MM-DD; this is not the rental availability date."
          },
          "includePhotos": {
            "title": "Include photos and additional listing information",
            "type": "boolean",
            "description": "Request listing photos and available neighborhood, language, and other listing information. Some listings may not provide these fields.",
            "default": false
          },
          "includeFees": {
            "title": "Include fees",
            "type": "boolean",
            "description": "Request property, floorplan, and unit fees when available. Also enables available floorplan and unit rows, each billed and counted toward maxItems.",
            "default": false
          },
          "includeWalkscore": {
            "title": "Include walking, transit, and cycling scores",
            "type": "boolean",
            "description": "Request available walking, transit, and cycling scores and their descriptions.",
            "default": false
          },
          "includeReviews": {
            "title": "Include review rows",
            "type": "boolean",
            "description": "Add separate review rows with parent listing identity and location. Each review row is billed and counts toward maxItems.",
            "default": false
          },
          "includeFeatures": {
            "title": "Include property and unit features",
            "type": "boolean",
            "description": "Request available community and unit feature lists.",
            "default": false
          },
          "includePropertyMap": {
            "title": "Include property-map information",
            "type": "boolean",
            "description": "Request available property-map information. Not every listing supplies a map.",
            "default": false
          },
          "includeRentCalendar": {
            "title": "Include rent calendars",
            "type": "boolean",
            "description": "Request available move-in rent-calendar information for up to rentCalendarMaxUnits units per listing. Also enables floorplan and unit rows, each billed and counted toward maxItems.",
            "default": false
          },
          "includeSubmarket": {
            "title": "Include submarket information",
            "type": "boolean",
            "description": "Request available submarket names, identifiers, and geographic information.",
            "default": false
          },
          "includeTours": {
            "title": "Include tour information",
            "type": "boolean",
            "description": "Request available tour types, settings, dates, and unit virtual-tour links. Also enables floorplan and unit rows, each billed and counted toward maxItems.",
            "default": false
          },
          "rentCalendarMaxUnits": {
            "title": "Maximum units for rent calendars",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "Maximum units per listing to request rent-calendar information for, from 1 to 10. Only applies when rent calendars are requested.",
            "default": 3
          },
          "fields": {
            "title": "Output fields",
            "type": "array",
            "description": "Optional output field names, such as propertyName, telephone, and walkScore; requested fields can enable additional data requests. Leave empty or use [\"*\"] for all available fields; required row identifiers are retained."
          },
          "commute": {
            "title": "Approximate commute area",
            "type": "object",
            "description": "Optional object with latitude, longitude, commuteMinutes, and transportationMethod (1 car, 2 transit, 3 bicycle, 4 walking). Filtering uses an enclosing area rather than an exact travel-time boundary, and listings without coordinates can remain."
          },
          "geog": {
            "title": "Advanced geographic search",
            "type": "object",
            "description": "Optional Apartments.com geographic object with type, id, box, and c values. Leave empty to search by Location or Start URLs."
          },
          "geogSlice": {
            "title": "Developer test setting",
            "type": "string",
            "description": "Leave empty. Used only by the developer for testing."
          },
          "harvestSeeds": {
            "title": "Developer test collection setting",
            "type": "boolean",
            "description": "Leave disabled. Used only by the developer for testing.",
            "default": false
          },
          "sort": {
            "title": "Sort order",
            "type": "string",
            "description": "Optional Apartments.com sort value, such as price or rating. Leave empty for the source order."
          },
          "workerBaseUrl": {
            "title": "Developer test URL",
            "type": "string",
            "description": "Leave empty. Used only by the developer for testing."
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}