{ "openapi": "3.0.1", "info": { "title": "Apartments.com Rentals Scraper — No Login Required", "description": "Extract rental listings from Apartments.com by city, neighborhood, ZIP, or search URL. No login or cookies needed. Supports bedroom, rent, pet-friendly, property-type, pagination, phone, exact-city filtering, Smart Scrape, and diagnostics.", "version": "0.1", "x-build-id": "Wt6TNx8wc2ouxEyB4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crowdpull~apartments-com-rentals-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crowdpull-apartments-com-rentals-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/crowdpull~apartments-com-rentals-scraper/runs": { "post": { "operationId": "runs-sync-crowdpull-apartments-com-rentals-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/crowdpull~apartments-com-rentals-scraper/run-sync": { "post": { "operationId": "run-sync-crowdpull-apartments-com-rentals-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": { "searches": { "title": "Searches", "type": "array", "description": "Run one or more structured Apartments.com searches. Each search can override location, slug, filters, pagination, and result limits.", "items": { "type": "object" } }, "startUrls": { "title": "Apartments.com Search URLs", "type": "array", "description": "Optional direct Apartments.com search URLs. Pagination and extraction options still apply. Do not use contact, apply, request-tour, or phone/tel URLs.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL", "description": "Apartments.com search/filter URL." } } } }, "locations": { "title": "Locations", "type": "array", "description": "City, neighborhood, or ZIP inputs. Examples: Austin, TX; 78704; Manhattan, New York, NY. For uncommon neighborhoods, prefer searches[].locationSlug.", "items": { "type": "string" } }, "location": { "title": "Location", "type": "string", "description": "Default city, neighborhood, or ZIP. City inputs should include a state, such as Austin, TX.", "default": "Austin, TX" }, "locationSlug": { "title": "Location Slug", "type": "string", "description": "Optional Apartments.com geo slug, such as austin-tx, austin-tx-78704, or east-austin-austin-tx. Use this for neighborhoods that do not slugify cleanly." }, "scope": { "title": "Location Scope", "enum": [ "city", "neighborhood", "zip", "slug" ], "type": "string", "description": "How the location should be interpreted when constructing a canonical URL.", "default": "city" }, "state": { "title": "State", "type": "string", "description": "Two-letter US state abbreviation. Used for canonical slugs and out-of-state sponsored listing filtering." }, "zipCode": { "title": "ZIP Code", "pattern": "^\\d{5}$", "type": "string", "description": "Optional ZIP code. If scope is ZIP, the actor resolves the ZIP to a city/state slug when needed." }, "propertyType": { "title": "Property Type", "enum": [ "apartments", "houses", "townhomes", "condos" ], "type": "string", "description": "Apartments.com property type filter.", "default": "apartments" }, "bedrooms": { "title": "Bedrooms", "enum": [ "any", "studio", "1", "2", "3", "4", "5+" ], "type": "string", "description": "Bedroom filter. Studio uses studios or studios-under-price. Numeric bedroom-plus-rent-plus-pet filters are combined into Apartments.com's current canonical segment, such as min-N-bedrooms-under-price-pet-friendly.", "default": "any" }, "maxRent": { "title": "Maximum Rent", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum monthly rent in USD. Apartments.com's URL layer supports max-only rent filters." }, "petFriendly": { "title": "Pet Friendly", "type": "boolean", "description": "Only include searches using the Apartments.com pet-friendly filter.", "default": false }, "modifiers": { "title": "Style / Quality Modifiers", "type": "array", "description": "Optional canonical modifiers that can stack: luxury, cheap, new, short-term.", "items": { "type": "string" } }, "filterOutOfStateAds": { "title": "Filter Out-of-State Placards", "type": "boolean", "description": "Drop sponsored or ad-pinned placards when their parsed state differs from the requested state.", "default": true }, "filterToRequestedCity": { "title": "Filter To Requested City", "type": "boolean", "description": "Drop rows whose parsed city differs from the requested city. Leave off for borough, neighborhood, metro, and Apartments.com nearby-result behavior.", "default": false }, "browserEngine": { "title": "Browser Engine", "enum": [ "playwright", "patchright" ], "type": "string", "description": "Chromium engine used for rendered search pages. Playwright is the default; Patchright is available for hosted A/B diagnostics.", "default": "playwright" }, "maxPages": { "title": "Max Pages Per Search", "minimum": 1, "maximum": 28, "type": "integer", "description": "Maximum result pages to open for each search. Apartments.com usually caps pagination around 28 pages.", "default": 1 }, "maxResultsPerSearch": { "title": "Max Results Per Search", "minimum": 1, "maximum": 700, "type": "integer", "description": "Maximum listing rows emitted for each search before pagination stops.", "default": 25 }, "maxAttemptsPerPage": { "title": "Max Attempts Per Page", "minimum": 1, "maximum": 5, "type": "integer", "description": "Retry blocked, rewritten, or empty pages with a fresh browser/proxy session.", "default": 3 }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 3, "type": "integer", "description": "Number of Apartments.com pages processed in parallel. Keep low because this actor is browser-bound and proxy-sensitive.", "default": 1 }, "delayMs": { "title": "Delay Between Pages", "minimum": 0, "maximum": 60000, "type": "integer", "description": "Base delay between page loads in milliseconds.", "default": 2500 }, "navigationTimeoutSecs": { "title": "Navigation Timeout Seconds", "minimum": 15, "maximum": 180, "type": "integer", "description": "Per-page browser navigation timeout.", "default": 60 }, "onlyNew": { "title": "Smart Scrape Only New / Changed", "type": "boolean", "description": "Emit only listings whose material fields are new or changed in the named Smart Scrape cache.", "default": false }, "cacheName": { "title": "Smart Scrape Cache Name", "type": "string", "description": "Named key-value store used by onlyNew. Defaults to apartments-com-rentals-smart-cache.", "default": "apartments-com-rentals-smart-cache" }, "saveDebugHtml": { "title": "Save Debug HTML", "type": "boolean", "description": "Save failed, blocked, rewritten, or no-result page HTML and screenshots to the default key-value store.", "default": false }, "proxyConfig": { "title": "Proxy Configuration", "type": "object", "description": "US residential proxies are strongly recommended. Apartments.com search pages are Akamai-protected and direct datacenter fetches commonly fail.", "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 } } } } } } } } } }