{ "openapi": "3.0.1", "info": { "title": "šŸ¢ Apartments.com Scraper", "description": "Apartments.com Scraper: Extract apartment listings with property names, addresses, prices, unit details, amenities, availability, ratings, contact information, and listing URLs. Build structured rental datasets for market research, price comparison, property analysis, and lead generation.", "version": "0.9", "x-build-id": "MqIZB8LiqPNL9cgi1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraper-engine~apartments-com-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraper-engine-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/scraper-engine~apartments-com-scraper/runs": { "post": { "operationId": "runs-sync-scraper-engine-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/scraper-engine~apartments-com-scraper/run-sync": { "post": { "operationId": "run-sync-scraper-engine-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": { "startUrls": { "title": "šŸŒ Apartments.com URLs", "type": "array", "description": "šŸ“‹ Optional. Paste Apartments.com URLs in bulk ā€” property URLs **OR** location-search / map URLs (with `?bb=ā€¦`). The actor auto-detects which is which and crawls accordingly. Fill this OR the **Search term** field below (or both).\n\n**Examples:**\nā€¢ `https://www.apartments.com/sobe-apartment-rentals-miami-beach-fl/26xc7jb/`\nā€¢ `https://www.apartments.com/brookline-ma/`\nā€¢ `https://www.apartments.com/brookline-ma/2-bedrooms/`", "items": { "type": "string" } }, "search": { "title": "šŸ”Ž Search term", "type": "string", "description": "Optional. A free-text query ā€” a city, neighborhood or ZIP code (e.g. `Brookline MA`, `Miami Beach FL`, `10001`). The actor converts it into an Apartments.com search URL and crawls it like any other start URL." }, "maxItems": { "title": "šŸ”¢ Maximum properties to scrape", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Cap the total number of property rows returned. Set to `0` for unlimited (up to whatever the page set contains). Default: `10`.", "default": 10 }, "endPage": { "title": "šŸ“š Search end page", "minimum": 0, "maximum": 28, "type": "integer", "description": "Optional. The last search-results page to crawl. `0` (default) means paginate until Apartments.com runs out of results, up to its own hard cap of **28 pages** per search. Set e.g. `3` to only crawl pages 1ā€“3. Each page holds up to 40 property cards.", "default": 0 }, "requestDelay": { "title": "ā±ļø Delay between page loads (seconds)", "minimum": 0, "maximum": 30, "type": "integer", "description": "Pause before each page load, in seconds, plus a small random jitter. Raise it if you see repeated bot challenges; lower it for speed. Default: `1`.", "default": 1 }, "proxyConfiguration": { "title": "šŸ›”ļø Proxy configuration", "type": "object", "description": "This actor runs on Apify **US Residential** proxy ā€” Apartments.com denies datacenter and direct traffic. If you paste **custom proxy URLs** here, those are used instead. The `Use Apify Proxy` toggle and group selection are ignored: US Residential is enforced.", "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 } } } } } } } } } }