{ "openapi": "3.0.1", "info": { "title": "Apartments.com Scraper $1/1KšŸ’° | Rent Listings | US Rental Data", "description": "Extract US rental listings from Apartments.com without an official API key. Get rent prices, beds/baths, square footage, addresses and leasing-office phones for rent comps, rental market research and apartment price monitoring.", "version": "0.0", "x-build-id": "qryE19tzobLVxwjaz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ahmed_jasarevic~apartments-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ahmed_jasarevic-apartments-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/ahmed_jasarevic~apartments-scraper/runs": { "post": { "operationId": "runs-sync-ahmed_jasarevic-apartments-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/ahmed_jasarevic~apartments-scraper/run-sync": { "post": { "operationId": "run-sync-ahmed_jasarevic-apartments-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": "Apartments.com search result pages (e.g. https://www.apartments.com/charlotte-nc/) or individual listing pages (e.g. https://www.apartments.com/the-artisan-charlotte-nc/pe3k5kr/). You can paste filtered search URLs from the site ā€” all filters are carried through.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "search": { "title": "Search location", "type": "string", "description": "Alternative to startUrls ā€” a city, state or ZIP to search, e.g. 'charlotte nc', 'brooklyn ny' or '10001'. Builds the search URL automatically." }, "maxItems": { "title": "Maximum listings", "minimum": 1, "maximum": 720, "type": "integer", "description": "Maximum number of listings to return per run. Search pages are fetched automatically (~40 listings per page, fetched in parallel) until this budget is reached. Apartments.com caps a single search at ~720 listings (18 pages).", "default": 50 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apartments.com is protected by Akamai Bot Manager. The scraper rotates fresh IPs automatically when a session is flagged. Use the 'Apify proxy pool' selector below to switch pools (RESIDENTIAL recommended).", "default": { "useApifyProxy": true } }, "maxProxyRotations": { "title": "Max proxy IP rotations", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many fresh proxy sessions to try per request when Akamai returns a block shell. Each session is retried on the same IP first. Page 1 gets double this budget since it faces the worst WAF pressure. Higher = better odds of finding a clean IP, but slower and uses more proxy bandwidth. Default 8.", "default": 8 }, "maxConcurrentRotations": { "title": "Concurrent proxy rotations", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many fresh proxy IPs to try IN PARALLEL per batch when a page is blocked. Each session is a distinct IP, so parallelism just collapses the anti-bot wait time ā€” it is the single biggest speed lever. Lower = gentler on the pool (helps if Akamai throttles fast bursts); higher = faster recovery on blocked pages. Default 4.", "default": 4 }, "browser": { "title": "Browser fingerprint", "enum": [ "firefox", "firefox144", "firefox135", "firefox133", "firefox128", "chrome", "chrome142", "chrome136", "chrome131", "chrome124" ], "type": "string", "description": "TLS/browser fingerprint used to impersonate a real browser via impit. Akamai vendors the pool per fingerprint; 'firefox' (Firefox 144 TLS) tends to clear Apartments.com better than Chrome on residential proxies. Options: firefox, firefox144, chrome, chrome142, or any impit browser identifier.", "default": "firefox144" }, "proxyGroup": { "title": "Apify proxy pool", "enum": [ "AUTO", "RESIDENTIAL", "DATACENTER" ], "type": "string", "description": "Which Apify proxy pool to use. AUTO = let Apify pick the best (most reliable for pages 1). RESIDENTIAL also works but some residential IPs are flagged by Akamai. DATACENTER is not available on all plans.", "default": "AUTO" }, "proxyCountry": { "title": "Proxy country", "type": "string", "description": "Apify proxy country to pin. Apartments.com cards pass more often on US residential IPs, so the default is 'US'. Leave empty to use the proxy pool's default rotation.", "default": "US" }, "proxyUrls": { "title": "Custom proxy URLs (own provider)", "type": "array", "description": "Optional. Paste your own residential proxy URLs to use INSTEAD of the Apify proxy ā€” useful to test a different proxy pool (e.g. Bright Data, Oxylabs, IPRoyal). Format per entry: http://user:pass@host:port. One URL = one sticky IP; multiple URLs rotate. Leave empty to use the Apify proxy above.", "items": { "type": "string" } }, "browserSeed": { "title": "Browser seed for page 1", "type": "boolean", "description": "If page 1 stays blocked after the HTTP IP hunt, load it with a real Playwright/Firefox browser to mint a trusted session (cookies + IP), then reuse that session over cheap HTTP for pages 2+. NOTE: it only helps when the block is a TLS/fingerprint block ā€” it cannot bypass Akamai WAF 'Access Denied' IP-level blocks. Adds ~15s and 1024 MB for the first page. OFF by default to keep costs low.", "default": false }, "browserSelfTest": { "title": "Browser self-test (advanced)", "type": "boolean", "description": "DEBUG TOOL ā€” launches a real Playwright/Firefox browser against the first URL and exits. Confirms whether the browser can get through Akamai on your current proxy IP. Useful when page 1 keeps getting blocked. Leaves no data in the dataset.", "default": false } } }, "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 } } } } } } } } } }