{ "openapi": "3.0.1", "info": { "title": "Apartment List Scraper", "description": "[💰 $2 / 1K] Extract US apartment and rental listings from ApartmentList.com — search any city or paste URLs. Get rent prices, floorplans and units (beds/baths/sqft/availability), amenities, pet policy, fees, photos, GPS, and nearby schools. Filter by price, bedrooms, move-in date, and pets.", "version": "1.0", "x-build-id": "U3yde1vfIA3fudLkh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/solidcode~apartmentlist-com-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-solidcode-apartmentlist-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/solidcode~apartmentlist-com-scraper/runs": { "post": { "operationId": "runs-sync-solidcode-apartmentlist-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/solidcode~apartmentlist-com-scraper/run-sync": { "post": { "operationId": "run-sync-solidcode-apartmentlist-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": { "location": { "title": "Locations", "type": "array", "description": "Cities or areas to search, one per line, e.g. 'Austin, TX', 'New York, NY', 'San Francisco, CA'. Each location is searched separately. Ignored when Start URLs are provided.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Power-user input. Paste ApartmentList city search-result URLs (e.g. https://www.apartmentlist.com/tx/austin) or individual property URLs, copied from your browser after applying filters. Neighborhood-only URLs (…/neighborhoods/…) are not supported — use the parent city URL instead. When provided, these override the Locations and Filters settings above.", "items": { "type": "string" } }, "bedrooms": { "title": "Bedrooms", "uniqueItems": true, "type": "array", "description": "Only include properties offering these bedroom counts. Select any combination. Leave empty for no bedroom filter.", "items": { "type": "string", "enum": [ "studio", "1", "2", "3", "4" ], "enumTitles": [ "Studio", "1 Bedroom", "2 Bedrooms", "3 Bedrooms", "4+ Bedrooms" ] }, "default": [] }, "bathroomsMin": { "title": "Minimum Bathrooms", "minimum": 1, "maximum": 5, "type": "integer", "description": "Only include properties offering a unit with at least this many bathrooms. The exact minimum is confirmed against each property's units, so this works best with Include Full Property Details turned on. Leave empty for no bathroom filter." }, "priceMin": { "title": "Minimum Rent (USD / month)", "minimum": 0, "type": "integer", "description": "Only include listings at or above this monthly rent in US dollars. Leave empty for no minimum." }, "priceMax": { "title": "Maximum Rent (USD / month)", "minimum": 0, "type": "integer", "description": "Only include listings at or below this monthly rent in US dollars. Leave empty for no maximum." }, "moveInDate": { "title": "Move-in Date", "type": "string", "description": "Only include properties with at least one unit ready to move into on or before this date (YYYY-MM-DD). Leave empty for any availability. Applied to each unit's availability, so it works best with Include Full Property Details turned on." }, "petPolicy": { "title": "Pet Policy", "enum": [ "any", "cats", "dogs", "cats-and-dogs" ], "type": "string", "description": "Only include properties allowing the selected pets.", "default": "any" }, "amenities": { "title": "Required Amenities", "uniqueItems": true, "type": "array", "description": "Only include properties that offer all of these amenities. Leave empty for no amenity filter.", "items": { "type": "string", "enum": [ "in_unit_laundry", "laundry_facilities", "air_conditioning", "parking", "pool", "gym", "dishwasher", "balcony", "hardwood_floors", "elevator", "wheelchair_accessible" ], "enumTitles": [ "In-unit laundry", "Laundry facilities", "Air conditioning", "Parking", "Pool", "Gym / fitness center", "Dishwasher", "Balcony / patio", "Hardwood floors", "Elevator", "Wheelchair accessible" ] }, "default": [] }, "includeDetails": { "title": "Include Full Property Details", "type": "boolean", "description": "Open each property's own page to add the full unit/floorplan list (beds, baths, sqft, price, availability), all amenities, nearby schools, fee and lease details, and the complete photo set. Turn off for faster, cheaper runs that return only what's on the search card. Slower when on: it makes one extra request per property.", "default": true }, "maxResults": { "title": "Max Results", "minimum": 0, "type": "integer", "description": "Maximum number of properties to collect across all locations and URLs combined. Set to 0 for unlimited (an internal upper limit of 50,000 properties per run still applies). Note: each property can contain many individual units — this cap counts properties, not units. Results are collected in full pages, so the final page may overshoot this cap by a few records.", "default": 100 } } }, "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 } } } } } } } } } }