{ "openapi": "3.0.1", "info": { "title": "Apartments.com Scraper", "description": "Scrape rental listings from Apartments.com — the largest US rental marketplace by CoStar Group. Extract rent prices, total monthly costs, floor plans, amenities, fees, pet policies, photos, phone numbers and availability. Filter by city, price range, bedrooms and property type.", "version": "0.0", "x-build-id": "TQRuxsF2VUN2c8ptz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/haketa~apartments-com-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-haketa-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/haketa~apartments-com-scraper/runs": { "post": { "operationId": "runs-sync-haketa-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/haketa~apartments-com-scraper/run-sync": { "post": { "operationId": "run-sync-haketa-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": { "searchUrls": { "title": "Search URLs", "type": "array", "description": "Direct Apartments.com search URLs. If provided, city inputs are ignored. Examples: 'https://www.apartments.com/austin-tx/', 'https://www.apartments.com/austin-tx/under-1000/', 'https://www.apartments.com/austin-tx/rent-specials/'.", "items": { "type": "string" } }, "cities": { "title": "Cities", "type": "array", "description": "City-state slugs matching Apartments.com URL format. Examples: 'austin-tx', 'new-york-ny', 'los-angeles-ca', 'chicago-il', 'miami-fl'. Ignored if searchUrls is provided.", "items": { "type": "string" } }, "propertyType": { "title": "Property Type", "enum": [ "all", "apartments", "houses", "condos", "townhomes" ], "type": "string", "description": "Type of property to search. Only used with cities input.", "default": "all" }, "maxPrice": { "title": "Max Price ($)", "minimum": 0, "type": "integer", "description": "Maximum monthly rent. Adds '/under-{price}/' filter to URL. 0 = no limit. Common values: 700, 1000, 1500, 2000.", "default": 0 }, "minBeds": { "title": "Min Bedrooms", "minimum": 0, "maximum": 5, "type": "integer", "description": "Minimum bedroom count. 0 = studio/any.", "default": 0 }, "rentSpecialsOnly": { "title": "Rent Specials Only", "type": "boolean", "description": "Only scrape listings with active promotions/deals. Adds '/rent-specials/' filter.", "default": false }, "scrapeDetails": { "title": "Scrape Detail Pages", "type": "boolean", "description": "Fetch each listing's detail page for JSON-LD data: floor plans, amenities, fees, pet policy, photos, coordinates, reviews. Increases run time and cost significantly.", "default": false }, "maxListings": { "title": "Max Listings", "minimum": 0, "type": "integer", "description": "Maximum total listings to scrape. Set 0 for unlimited.", "default": 100 }, "maxPages": { "title": "Max Pages per Search", "minimum": 1, "type": "integer", "description": "Maximum pages per city search. Each page has ~20-25 listings.", "default": 20 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings. Residential proxies recommended — CoStar has anti-bot protection." }, "requestDelay": { "title": "Request Delay (ms)", "minimum": 0, "maximum": 15000, "type": "integer", "description": "Delay between requests in milliseconds. Keep above 1500ms to avoid blocks.", "default": 1500 }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 5, "type": "integer", "description": "Parallel requests. Keep at 1-2 — CoStar rate limits aggressively.", "default": 1 } } }, "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 } } } } } } } } } }