{
"openapi": "3.0.1",
"info": {
"title": "Craigslist Multi-City Listings Scraper",
"description": "Scrape Craigslist listings across many US metro areas and categories in one run. Get titles, prices, locations, images, posted/updated dates, structured attributes, descriptions, and public reply links -- normalized into one clean dataset instead of one run per city.",
"version": "0.0",
"x-build-id": "qiQgdhCgt8F1hh98C"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/devilscrapes~craigslist-listings-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-devilscrapes-craigslist-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/devilscrapes~craigslist-listings-scraper/runs": {
"post": {
"operationId": "runs-sync-devilscrapes-craigslist-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/devilscrapes~craigslist-listings-scraper/run-sync": {
"post": {
"operationId": "run-sync-devilscrapes-craigslist-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": {
"areas": {
"title": "Areas",
"maxItems": 20,
"type": "array",
"description": "Craigslist area slugs to search (e.g. \"newyork\", \"losangeles\") from /about/sites. Combined with All top US metros below when that's enabled. Up to 20 entries.",
"default": [],
"items": {
"type": "string"
}
},
"allTopUsMetros": {
"title": "All top US metros",
"type": "boolean",
"description": "Union in a curated list of up to 25 top-US-metro Craigslist area slugs (not the full ~700-area directory) on top of anything listed in Areas.",
"default": false
},
"categories": {
"title": "Categories",
"type": "array",
"description": "Top-level Craigslist category codes to search: sss (for sale), cta (cars & trucks), reo (real estate), apa (apartments/housing), jjj (jobs), bbb (community), ggg (gigs). Use \"all\" to expand to all 7.",
"default": [
"sss"
],
"items": {
"type": "string"
}
},
"query": {
"title": "Search query",
"maxLength": 200,
"type": "string",
"description": "Single search term, passed verbatim to Craigslist's search. Leave empty to browse a category with no keyword filter."
},
"maxResultsPerCombo": {
"title": "Max results per combo",
"minimum": 1,
"maximum": 300,
"type": "integer",
"description": "Cap on listings collected per (area, category) combo. 300 is Craigslist's observed single-page result-set ceiling.",
"default": 100
},
"fetchDetails": {
"title": "Fetch listing detail pages",
"type": "boolean",
"description": "When enabled, fetch each listing's detail page for posted/updated dates, full description, structured attributes, and the public reply-flow URL. When disabled, only search-list fields are returned.",
"default": true
},
"postedWithinDays": {
"title": "Posted within days",
"minimum": 1,
"maximum": 365,
"type": "integer",
"description": "Drop listings older than this many days. Only enforceable when Fetch listing detail pages is enabled -- posting date is a detail-page-only field."
},
"maxRunMinutes": {
"title": "Max run minutes",
"minimum": 1,
"maximum": 60,
"type": "integer",
"description": "Run-wide wall-clock budget. New (area, category) combos stop being started once this is exceeded; already-collected rows are still flushed.",
"default": 10
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "Apify Proxy configuration. Craigslist's search and detail pages clear cleanly on the standard (non-residential) group -- no anti-bot behaviour observed.",
"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
}
}
},
"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
}
}
}
}
}
}
}
}
}
}