{ "openapi": "3.0.1", "info": { "title": "Craigslist Apartments Scraper - Housing, Cars, Jobs & For Sale", "description": "Craigslist apartments and listings scraper: pick cities and categories (apartments, rooms, cars, jobs, for sale) and get each listing with price, bedrooms, sqft, odometer, salary, employer, neighborhood, GPS, photos and posted date. New-listings monitor, no login.", "version": "1.0", "x-build-id": "l2YtEBoBrIQvPMhrZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kamerozkan~craigslist-apartments-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kamerozkan-craigslist-apartments-listings-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/kamerozkan~craigslist-apartments-listings-scraper/runs": { "post": { "operationId": "runs-sync-kamerozkan-craigslist-apartments-listings-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/kamerozkan~craigslist-apartments-listings-scraper/run-sync": { "post": { "operationId": "run-sync-kamerozkan-craigslist-apartments-listings-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": { "searches": { "title": "Cities or Craigslist search URLs", "type": "array", "description": "One per line: a Craigslist city (newyork, sfbay, losangeles, chicago, seattle, austin, or a city name like 'New York'), or a full search URL copied from your browser (https://newyork.craigslist.org/search/apa?min_price=2000&max_bedrooms=2). A URL keeps its own category and filters; plain cities use the category and filters below.", "default": [ "newyork" ], "items": { "type": "string" } }, "category": { "title": "Category", "enum": [ "apa", "roo", "sub", "rea", "hhh", "cta", "cto", "ctd", "mca", "rva", "boo", "sss", "fua", "ela", "zip", "jjj", "ggg", "bbb" ], "type": "string", "description": "Used for plain city entries. Apartments / housing for rent is the default.", "default": "apa" }, "query": { "title": "Keyword", "type": "string", "description": "Optional search words, for example 'studio', 'no fee', 'toyota tacoma' or 'warehouse'." }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Lowest price or rent in the local currency." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Highest price or rent in the local currency." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "maximum": 8, "type": "integer", "description": "Housing categories only." }, "maxBedrooms": { "title": "Max bedrooms", "minimum": 0, "maximum": 8, "type": "integer", "description": "Housing categories only." }, "hasImage": { "title": "Only listings with photos", "type": "boolean", "description": "Skip listings without pictures.", "default": false }, "postedToday": { "title": "Posted today", "type": "boolean", "description": "Only listings posted today (Craigslist's own filter).", "default": false }, "postedAfter": { "title": "Posted after (YYYY-MM-DD)", "type": "string", "description": "Only listings posted on or after this date, for example 2026-10-01. Older listings are skipped and not charged." }, "maxListingsPerSearch": { "title": "Max listings per city or URL", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Newest first. Craigslist shows the newest 360 listings of a search; above that the scraper splits the search by price range to reach more (those rows come grouped by price band, and listings without a price are only in the first 360).", "default": 100 }, "maxItems": { "title": "Max listings in total", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many listings across all cities. You pay per listing, so this also caps the cost of the run.", "default": 1000 }, "onlyNewListings": { "title": "Only new listings since the last run (monitor)", "type": "boolean", "description": "Remembers the listings each search returned (in a named key-value store) and outputs only ones not seen before. Schedule the run every hour or day to get a feed of fresh listings; repeats are not charged.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Name of the key-value store that keeps the seen listings. Use a different name for each separate watchlist.", "default": "craigslist-monitor" }, "includeDetails": { "title": "Include listing details (description, attributes)", "type": "boolean", "description": "One extra page per listing adds the full description text, attributes (laundry, parking, pets, rent period, housing type, car condition, fuel, transmission, title status and more), bathrooms, updated date and place name. Slower; the price per listing is the same.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy (datacenter) spreads the requests. Switch to residential only if a run reports 403 or 429 errors.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }