{ "openapi": "3.0.1", "info": { "title": "Apartment List Scraper - US Rentals, Rents & Floor Plans", "description": "Apartment List scraper for US rental listings: give it a city slug, City ST notation or filtered search URL and get one row per property with rent range, beds, baths, floor plans, amenities, coordinates and leasing phone. For renters, landlords and rental market research.", "version": "0.2", "x-build-id": "gUXj2yuyHKVVAcbgi" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/s-r~apartmentlist-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-s-r-apartmentlist-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/s-r~apartmentlist-scraper/runs": { "post": { "operationId": "runs-sync-s-r-apartmentlist-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/s-r~apartmentlist-scraper/run-sync": { "post": { "operationId": "run-sync-s-r-apartmentlist-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": { "search": { "title": "Cities or search URLs", "type": "array", "description": "One per line. A city as state/city (tx/austin) or as City, ST (Austin, TX), or a full apartmentlist.com search URL with filters already applied.", "items": { "type": "string" } }, "listingUrls": { "title": "Property URLs", "type": "array", "description": "Optional. Individual property pages to read, one per line, for example https://www.apartmentlist.com/tx/austin/sona--2. These rows carry the description, year built, pet policy and website as well.", "items": { "type": "string" } }, "beds": { "title": "Bedrooms", "minimum": 0, "maximum": 6, "type": "integer", "description": "Optional. Query filter sent to the site (?beds=N). 0 or empty: no filter. Nothing is filtered client-side." }, "baths": { "title": "Bathrooms", "minimum": 1, "maximum": 5, "type": "integer", "description": "Optional. Query filter sent to the site (?baths=N). 0 or empty: no filter." }, "maxRent": { "title": "Maximum rent (USD per month)", "minimum": 100, "maximum": 50000, "type": "integer", "description": "Optional. Query filter sent to the site (?price_max=N). 0 or empty: no filter." }, "maxItems": { "title": "Maximum listings", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Across all cities. Result pages hold sixteen to twenty properties each, so this trims the last page rather than shortening it.", "default": 50 }, "maxPages": { "title": "Maximum pages per city", "minimum": 1, "maximum": 100, "type": "integer", "description": "The safety rail on a large city. Austin alone has over a hundred pages.", "default": 10 }, "cursor": { "title": "Cursor", "type": "string", "description": "Optional. Opaque next_cursor from a previous response to resume a long run. Leave the rest of the input unchanged. Empty: start from the beginning." } } }, "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 } } } } } } } } } }