{ "openapi": "3.0.1", "info": { "title": "Apartments.com Rental Listing & Floor Plan Scraper", "description": "Search Apartments.com rentals by city, bedroom count, price, property type, pet policy, and amenities, or scrape specific listing URLs directly. Returns rent ranges, per-unit floor plans, walkability scores, amenities, and leasing contact details.", "version": "2.0", "x-build-id": "p6YkqUxP9rFhfClUk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dataspryva~apartments-com-rental-listing-and-floor-plan/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dataspryva-apartments-com-rental-listing-and-floor-plan", "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/dataspryva~apartments-com-rental-listing-and-floor-plan/runs": { "post": { "operationId": "runs-sync-dataspryva-apartments-com-rental-listing-and-floor-plan", "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/dataspryva~apartments-com-rental-listing-and-floor-plan/run-sync": { "post": { "operationId": "run-sync-dataspryva-apartments-com-rental-listing-and-floor-plan", "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": { "mode": { "title": "Mode", "enum": [ "search", "urls", "listingKeys" ], "type": "string", "description": "How to find listings: `search` uses a city or ZIP plus filters; `urls` uses the Apartments.com URLs you paste; `listingKeys` looks up the listing keys you paste.", "default": "search" }, "searchLocation": { "title": "Search location", "type": "string", "description": "US city and state (`New York, NY`) or 5-digit ZIP (`10001`). Used only in search mode." }, "bedrooms": { "title": "Bedrooms", "enum": [ "any", "studio", "1", "2", "3", "4", "5plus" ], "type": "string", "description": "Match listings with at least one floor plan of this bedroom count.", "default": "any" }, "bathrooms": { "title": "Bathrooms", "enum": [ "any", "1plus", "2plus", "3plus" ], "type": "string", "description": "Match listings with a floor plan at or above this bathroom count.", "default": "any" }, "priceMin": { "title": "Minimum monthly rent ($)", "minimum": 0, "maximum": 50000, "type": "integer", "description": "Lowest monthly rent to include. Leave unset for no minimum." }, "priceMax": { "title": "Maximum monthly rent ($)", "minimum": 0, "maximum": 50000, "type": "integer", "description": "Highest monthly rent to include. Leave unset for no maximum." }, "sqftMin": { "title": "Minimum square feet", "minimum": 0, "maximum": 20000, "type": "integer", "description": "Smallest floor plan to include. Leave unset for no minimum." }, "sqftMax": { "title": "Maximum square feet", "minimum": 0, "maximum": 20000, "type": "integer", "description": "Largest floor plan to include. Leave unset for no maximum." }, "propertyType": { "title": "Property type", "enum": [ "any", "apartments", "houses", "condos", "townhomes" ], "type": "string", "description": "Restrict results to one property type.", "default": "any" }, "petPolicy": { "title": "Pet policy", "enum": [ "any", "dogs", "cats", "pets" ], "type": "string", "description": "Require listings that allow dogs, cats, or both.", "default": "any" }, "amenities": { "title": "Required amenities", "type": "array", "description": "Only return listings that publish every selected amenity.", "items": { "type": "string", "enum": [ "smoke-free", "washer-dryer", "dishwasher", "central-heating", "air-conditioning", "balcony", "fireplace", "furnished", "fitness-center", "pool", "tennis-court", "rooftop-deck", "basketball-court", "playground", "parking", "wheelchair-accessible", "high-speed-internet", "elevator", "washer-dryer-hookups", "laundry-facilities", "utilities-included", "lofts", "doorman", "gated", "concierge", "clubhouse", "controlled-access", "business-center", "garage", "patio", "hardwood-floors", "den", "office", "yard", "walk-in-closets", "basement", "ev-charging", "storage-units", "high-ceilings", "dog-park" ], "enumTitles": [ "Smoke-free", "In-unit washer/dryer", "Dishwasher", "Central heating", "Air conditioning", "Balcony", "Fireplace", "Furnished", "Fitness center", "Pool", "Tennis court", "Rooftop deck", "Basketball court", "Playground", "Parking", "Wheelchair accessible", "High-speed internet", "Elevator", "Washer/dryer hookups", "Laundry facilities", "Utilities included", "Lofts", "Doorman", "Gated", "Concierge", "Clubhouse", "Controlled access", "Business center", "Garage", "Patio", "Hardwood floors", "Den", "Office", "Yard", "Walk-in closets", "Basement", "EV charging", "Storage units", "High ceilings", "Dog park" ] }, "default": [] }, "rentSpecials": { "title": "Rent specials only", "type": "boolean", "description": "Only return listings advertising a current move-in deal.", "default": false }, "minRating": { "title": "Minimum rating", "enum": [ "any", "1", "2", "3", "4", "5" ], "type": "string", "description": "Only return listings rated at or above this score (1–5).", "default": "any" }, "moveInDate": { "title": "Move-in by date", "type": "string", "description": "Only return listings with a unit available on or before this date (YYYY-MM-DD)." }, "specialties": { "title": "Lifestyle / housing type", "type": "array", "description": "Return listings matching at least one selected lifestyle or housing program. Student and senior housing are the most consistently published; other values are applied when the source exposes them.", "items": { "type": "string", "enum": [ "student", "senior", "military", "corporate", "luxury", "affordable", "cheap" ], "enumTitles": [ "Student housing", "Senior housing", "Military housing", "Corporate housing", "Luxury", "Affordable housing", "Cheap" ] }, "default": [] }, "keywords": { "title": "Keywords", "type": "string", "description": "Keep listings whose name, description, amenities, neighborhood or floor-plan names contain this text. Requires scrapeDetails=true." }, "sortBy": { "title": "Sort order", "enum": [ "relevance", "priceAsc", "priceDesc", "bedsAsc", "bedsDesc", "newest" ], "type": "string", "description": "How to order returned listings.", "default": "relevance" }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Apartments.com city-search or property URLs. Used only in `urls` mode. A listing key is also accepted.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "listingKeys": { "title": "Listing keys", "type": "array", "description": "Apartments.com listing keys such as `d3pj6rk`. Used only in `listingKeys` mode.", "items": { "type": "string" } }, "maximizeCoverage": { "title": "Maximize coverage", "type": "boolean", "description": "When the public listing index cannot fill your request, automatically try the site's search page as a last resort. Off by default.", "default": false }, "scrapeDetails": { "title": "Fetch full details", "type": "boolean", "description": "Fetch floor plans, available units, fees, pets, parking, schools, office hours, manager, website and photos for each listing. Turn off for faster card-level results.", "default": true }, "maxItems": { "title": "Max listings", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum listings to return (1–5,000). Search mode also stops at the maxPages scan depth.", "default": 50 }, "maxPages": { "title": "Max search depth (pages)", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many 40-listing discovery pages to scan in search mode (1–20). Raise it when filters are narrow.", "default": 5 } } }, "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 } } } } } } } } } }