{ "openapi": "3.0.1", "info": { "title": "Apartments Properties and Details Scraper", "description": "Permission-gated Apartments.com rental-listing parser. It makes no source requests unless prior written authorization is confirmed.", "version": "0.0", "x-build-id": "rxLRmdanEzVbQ9J8s" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/realestateapi~apartments-properties-and-details-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-realestateapi-apartments-properties-and-details-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/realestateapi~apartments-properties-and-details-scraper/runs": { "post": { "operationId": "runs-sync-realestateapi-apartments-properties-and-details-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/realestateapi~apartments-properties-and-details-scraper/run-sync": { "post": { "operationId": "run-sync-realestateapi-apartments-properties-and-details-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": { "authorizationConfirmed": { "title": "Written permission confirmed", "type": "boolean", "description": "Set true only if current written permission covers automated collection and copying of Apartments.com materials. This checkbox is an operator attestation and does not grant permission.", "default": false }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Official HTTPS Apartments.com listing, search, or property-detail URLs.", "items": { "type": "object", "properties": { "url": { "title": "Official URL", "description": "Absolute HTTPS Apartments.com URL.", "type": "string", "pattern": "^https://(?:www\\.)?apartments\\.com(?:/|$)" } }, "required": [ "url" ], "additionalProperties": false } }, "urls": { "title": "Source URL aliases", "type": "array", "description": "Backward-compatible alternative to startUrls. Use official HTTPS Apartments.com URLs only.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "title": "Official URL", "description": "Absolute HTTPS Apartments.com URL.", "type": "string", "pattern": "^https://(?:www\\.)?apartments\\.com(?:/|$)" } }, "additionalProperties": false } }, "start_urls": { "title": "Legacy source URL alias", "type": "array", "description": "Backward-compatible alternative to startUrls. Use official HTTPS Apartments.com URLs only.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "title": "Official URL", "description": "Absolute HTTPS Apartments.com URL.", "type": "string", "pattern": "^https://(?:www\\.)?apartments\\.com(?:/|$)" } }, "additionalProperties": false } }, "url": { "title": "Single source URL alias", "pattern": "^https://(?:www\\.)?apartments\\.com(?:/|$)", "type": "string", "description": "Backward-compatible single-URL alternative to startUrls. Use an official HTTPS Apartments.com URL." }, "location": { "title": "Location fallback", "type": "string", "description": "Apartments.com path slug used when startUrls is empty, such as chicago-il.", "default": "chicago-il" }, "zip": { "title": "ZIP query", "type": "string", "description": "Optional ZIP query retained as run provenance when a start URL is supplied." }, "query": { "title": "Query", "type": "string", "description": "Optional search text retained as run provenance." }, "includeDetails": { "title": "Include public details", "type": "boolean", "description": "Fetch each source-linked public property detail URL directly when it is exposed.", "default": true }, "includeReviews": { "title": "Include public reviews", "type": "boolean", "description": "Retain review objects exposed in public HTML or JSON-LD.", "default": false }, "maxReviews": { "title": "Maximum reviews", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum review objects retained per property.", "default": 20 }, "maxItems": { "title": "Maximum listings", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum source-backed property records to emit.", "default": 50 }, "maxPages": { "title": "Maximum pages", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum direct public listing pages to follow per start URL.", "default": 5 }, "minPrice": { "title": "Minimum monthly price", "minimum": 0, "maximum": 1000000, "type": "number", "description": "Optional minimum monthly price filter based on the public range." }, "maxPrice": { "title": "Maximum monthly price", "minimum": 0, "maximum": 1000000, "type": "number", "description": "Optional maximum monthly price filter based on the public range." }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "maximum": 20, "type": "number", "description": "Optional minimum public bedroom range." }, "maxBedrooms": { "title": "Maximum bedrooms", "minimum": 0, "maximum": 20, "type": "number", "description": "Optional maximum public bedroom range." }, "requestDelayMs": { "title": "Request delay milliseconds", "minimum": 250, "maximum": 5000, "type": "integer", "description": "Bounded pacing delay between direct public requests.", "default": 250 }, "timeoutSecs": { "title": "Request timeout seconds", "minimum": 5, "maximum": 180, "type": "integer", "description": "Timeout for each direct public HTTPS request.", "default": 45 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }