{ "openapi": "3.0.1", "info": { "title": "šŸ¢ Apartments.com Scraper", "description": null, "version": "0.7", "x-build-id": "MgEqsozwV1xIF8nGn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraply~apartments-com-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraply-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/scraply~apartments-com-scraper/runs": { "post": { "operationId": "runs-sync-scraply-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/scraply~apartments-com-scraper/run-sync": { "post": { "operationId": "run-sync-scraply-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 ā€” listing URLs **OR** search / map URLs (with `?bb=ā€¦`). The actor auto-detects which is which and crawls accordingly. Either 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/?sk=ā€¦&bb=ā€¦`", "items": { "type": "string" } }, "search": { "title": "šŸ”Ž Search term", "type": "string", "description": "Optional. A free-text query for Apartments.com ā€” 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 just like any other start URL. Combine with `Apartments.com URLs` or use on its own." }, "maxItems": { "title": "šŸ”¢ Maximum properties to scrape", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Cap the total number of property records returned. Set to 0 for unlimited (up to whatever the page set contains).", "default": 10 }, "endPage": { "title": "šŸ“š Listing end page", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Optional. The page number that you want to end with. By default there is no end page ā€” pagination continues until Apartments.com runs out of results (its own hard cap is 28 pages per search). Set this to stop earlier, e.g. `endPage: 3` only scrapes pages 1ā€“3.", "default": 0 }, "includeAllImages": { "title": "šŸ–¼ļø Include all property images", "type": "boolean", "description": "Collect the full image gallery for each property (carousel photos, floor plans, amenities). When off, no image URLs are returned. āš ļø Image extraction is on the roadmap ā€” toggling this today reserves the flag for the upcoming release.", "default": false }, "includeVirtualTours": { "title": "šŸŽ„ Include virtual tour links", "type": "boolean", "description": "Collect 3D / video tour URLs when the listing exposes them. āš ļø Virtual-tour extraction is on the roadmap ā€” toggling this today reserves the flag for the upcoming release.", "default": false }, "proxyConfiguration": { "title": "šŸ›”ļø Proxy configuration", "type": "object", "description": "This actor **always** runs on Apify **Residential** proxy (3 retry rounds with IP refresh). Apartments.com is too aggressive for direct or datacenter traffic. If you paste **custom proxy URLs** here, those are tried first (3 retry rounds) before falling back to Residential. The `Use Apify Proxy` toggle and group selection are ignored ā€” 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 } } } } } } } } } }