{ "openapi": "3.0.1", "info": { "title": "Apartments.com Scraper", "description": "Scrape apartment listings from Apartments.com with prices, phone numbers, addresses, bedrooms, amenities, and special offers. Supports multiple city searches, pagination, rotating impersonation, and residential proxies for lower block rates.", "version": "0.0", "x-build-id": "vScPZMbwZRBBv29Pu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/moving_beacon-owner1~apartments-com-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-moving_beacon-owner1-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/moving_beacon-owner1~apartments-com-scraper/runs": { "post": { "operationId": "runs-sync-moving_beacon-owner1-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/moving_beacon-owner1~apartments-com-scraper/run-sync": { "post": { "operationId": "run-sync-moving_beacon-owner1-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", "required": [ "cities" ], "properties": { "cities": { "title": "Cities", "type": "array", "description": "Select one or more cities to scrape. Values are apartments.com URL slugs.", "items": { "type": "string", "enum": [ "albuquerque-nm", "anaheim-ca", "anchorage-ak", "arlington-tx", "atlanta-ga", "aurora-co", "austin-tx", "bakersfield-ca", "baltimore-md", "baton-rouge-la", "boise-id", "boston-ma", "buffalo-ny", "chandler-az", "charlotte-nc", "chesapeake-va", "chicago-il", "chula-vista-ca", "cincinnati-oh", "cleveland-oh", "colorado-springs-co", "columbus-oh", "corpus-christi-tx", "dallas-tx", "denver-co", "detroit-mi", "durham-nc", "el-paso-tx", "fort-wayne-in", "fort-worth-tx", "fremont-ca", "fresno-ca", "garland-tx", "gilbert-az", "glendale-az", "greensboro-nc", "henderson-nv", "hialeah-fl", "honolulu-hi", "houston-tx", "indianapolis-in", "irvine-ca", "irving-tx", "jacksonville-fl", "jersey-city-nj", "kansas-city-mo", "laredo-tx", "las-vegas-nv", "lexington-ky", "lincoln-ne", "long-beach-ca", "los-angeles-ca", "louisville-ky", "lubbock-tx", "madison-wi", "memphis-tn", "mesa-az", "miami-fl", "milwaukee-wi", "minneapolis-mn", "nashville-tn", "new-orleans-la", "new-york-ny", "newark-nj", "norfolk-va", "north-las-vegas-nv", "oakland-ca", "oklahoma-city-ok", "omaha-ne", "orlando-fl", "philadelphia-pa", "phoenix-az", "pittsburgh-pa", "plano-tx", "portland-or", "raleigh-nc", "reno-nv", "richmond-va", "riverside-ca", "sacramento-ca", "san-antonio-tx", "san-diego-ca", "san-francisco-ca", "san-jose-ca", "santa-ana-ca", "scottsdale-az", "seattle-wa", "spokane-wa", "st-louis-mo", "st-paul-mn", "st-petersburg-fl", "stockton-ca", "tampa-fl", "toledo-oh", "tucson-az", "tulsa-ok", "virginia-beach-va", "washington-dc", "wichita-ks", "winston-salem-nc" ], "enumTitles": [ "Albuquerque, NM", "Anaheim, CA", "Anchorage, AK", "Arlington, TX", "Atlanta, GA", "Aurora, CO", "Austin, TX", "Bakersfield, CA", "Baltimore, MD", "Baton Rouge, LA", "Boise, ID", "Boston, MA", "Buffalo, NY", "Chandler, AZ", "Charlotte, NC", "Chesapeake, VA", "Chicago, IL", "Chula Vista, CA", "Cincinnati, OH", "Cleveland, OH", "Colorado Springs, CO", "Columbus, OH", "Corpus Christi, TX", "Dallas, TX", "Denver, CO", "Detroit, MI", "Durham, NC", "El Paso, TX", "Fort Wayne, IN", "Fort Worth, TX", "Fremont, CA", "Fresno, CA", "Garland, TX", "Gilbert, AZ", "Glendale, AZ", "Greensboro, NC", "Henderson, NV", "Hialeah, FL", "Honolulu, HI", "Houston, TX", "Indianapolis, IN", "Irvine, CA", "Irving, TX", "Jacksonville, FL", "Jersey City, NJ", "Kansas City, MO", "Laredo, TX", "Las Vegas, NV", "Lexington, KY", "Lincoln, NE", "Long Beach, CA", "Los Angeles, CA", "Louisville, KY", "Lubbock, TX", "Madison, WI", "Memphis, TN", "Mesa, AZ", "Miami, FL", "Milwaukee, WI", "Minneapolis, MN", "Nashville, TN", "New Orleans, LA", "New York, NY", "Newark, NJ", "Norfolk, VA", "North Las Vegas, NV", "Oakland, CA", "Oklahoma City, OK", "Omaha, NE", "Orlando, FL", "Philadelphia, PA", "Phoenix, AZ", "Pittsburgh, PA", "Plano, TX", "Portland, OR", "Raleigh, NC", "Reno, NV", "Richmond, VA", "Riverside, CA", "Sacramento, CA", "San Antonio, TX", "San Diego, CA", "San Francisco, CA", "San Jose, CA", "Santa Ana, CA", "Scottsdale, AZ", "Seattle, WA", "Spokane, WA", "St. Louis, MO", "St. Paul, MN", "St. Petersburg, FL", "Stockton, CA", "Tampa, FL", "Toledo, OH", "Tucson, AZ", "Tulsa, OK", "Virginia Beach, VA", "Washington, DC", "Wichita, KS", "Winston Salem, NC" ] } }, "maxPages": { "title": "Max pages per city", "minimum": 1, "maximum": 28, "type": "integer", "description": "How many result pages to scrape per city. Apartments.com paginates roughly 25 listings per page.", "default": 1 }, "concurrency": { "title": "Concurrent cities", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many cities to scrape at once. Each city runs its own stealth browser, so this is memory-hungry — keep it low (1-3) unless you have raised the actor's memory.", "default": 2 }, "blockResources": { "title": "Block images/CSS/fonts", "type": "boolean", "description": "Abort image, media, font and stylesheet requests in the browser. Keeps the JS that anti-bot needs, but cuts residential-proxy bandwidth (and cost) substantially. Recommended on.", "default": true }, "minDelayMs": { "title": "Min delay between page fetches (ms)", "minimum": 0, "type": "integer", "description": "Lower bound of the random delay between page navigations.", "default": 600 }, "maxDelayMs": { "title": "Max delay between page fetches (ms)", "minimum": 0, "type": "integer", "description": "Upper bound of the random delay between page navigations.", "default": 1800 }, "maxAttemptsPerCity": { "title": "Max attempts per city", "minimum": 1, "maximum": 15, "type": "integer", "description": "How many times to retry a city (with a fresh proxy session each time) before giving up.", "default": 4 }, "blockedBackoffMinSec": { "title": "Blocked backoff min (sec)", "minimum": 0, "type": "integer", "description": "Lower bound of the sleep after an anti-bot block, before rotating the session.", "default": 5 }, "blockedBackoffMaxSec": { "title": "Blocked backoff max (sec)", "minimum": 0, "type": "integer", "description": "Upper bound of the sleep after an anti-bot block, before rotating the session.", "default": 20 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Defaults to Apify US residential proxies (recommended for Apartments.com). Override to change proxy group, country, or use custom proxies. Residential proxies are a paid Apify feature.", "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 } } } } } } } } } }