{ "openapi": "3.0.1", "info": { "title": "Craigslist Scraper: Listings, Prices, Housing & Jobs", "description": "Scrape Craigslist listings from any city and category (for sale, cars, housing, jobs, services, gigs): title, price, location, coordinates, images, date, link. Gets past the 360-result cap by splitting on price. Optional details: description, attributes, address, salary.", "version": "1.0", "x-build-id": "8TqMtbdaoz1OwMGiH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ksvan~craigslist-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ksvan-craigslist-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/ksvan~craigslist-scraper/runs": { "post": { "operationId": "runs-sync-ksvan-craigslist-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/ksvan~craigslist-scraper/run-sync": { "post": { "operationId": "run-sync-ksvan-craigslist-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": { "startUrls": { "title": "Craigslist URLs", "type": "array", "description": "Search URLs with any filters you set on Craigslist (https://sfbay.craigslist.org/search/cta?query=toyota&min_price=5000, https://newyork.craigslist.org/search/brk/apa) or single listing URLs.", "items": { "type": "string" } }, "cities": { "title": "Cities", "type": "array", "description": "Craigslist city subdomains: newyork, sfbay, losangeles, chicago, seattle, london, toronto... Used with the keywords and category below.", "items": { "type": "string" } }, "searchQueries": { "title": "Keywords", "type": "array", "description": "One search per keyword in every city. Leave empty to take the newest listings of the category.", "items": { "type": "string" } }, "category": { "title": "Category", "enum": [ "sss", "cta", "fua", "ela", "bia", "hhh", "apa", "roo", "sub", "rea", "jjj", "bbb", "ggg", "ccc", "eee" ], "type": "string", "description": "Applies to cities + keywords. For other categories paste a search URL.", "default": "sss" }, "filters": { "title": "Extra filters", "type": "object", "description": "Craigslist URL parameters added to every city search, e.g. {\"min_price\": 500, \"max_price\": 3000, \"postedToday\": 1, \"hasPic\": 1, \"search_distance\": 10, \"postal\": \"10001\"}." }, "maxItemsPerSearch": { "title": "Max listings per search", "minimum": 1, "type": "integer", "description": "Craigslist returns 360 listings per search; above that the actor splits the search into price ranges (listings with a price only).", "default": 100 }, "includeDetails": { "title": "Full listing details", "type": "boolean", "description": "Open every listing for the description, all attributes (condition, make, bedrooms, pets, employment type...), street address, update date and all images. Charged as a detailed listing.", "default": false }, "splitByPrice": { "title": "Split by price past 360 results", "type": "boolean", "description": "Turn off to stop at the first 360 listings of each search.", "default": true }, "maxItems": { "title": "Max listings in total", "minimum": 0, "type": "integer", "description": "0 = no limit.", "default": 0 }, "maxConcurrency": { "title": "Parallel detail pages", "minimum": 1, "maximum": 20, "type": "integer", "description": "Listing pages opened at the same time when details are on.", "default": 8 }, "maxRetries": { "title": "Max retries per request", "minimum": 2, "maximum": 10, "type": "integer", "description": "Each retry uses a new proxy IP.", "default": 6 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Leave the default: datacenter proxy with automatic switch to residential when Craigslist blocks.", "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 } } } } } } } } } }