{ "openapi": "3.0.1", "info": { "title": "Craigslist Scraper: Listings, Cars, Housing, Jobs & For Sale", "description": "Scrape Craigslist listings from any city or all US sites: for sale, cars & trucks, housing, jobs, gigs. Price, location, photos, map coordinates and details.", "version": "1.0", "x-build-id": "BbhfZrzivHiMQJi5W" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/uber_byte~craigslist-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-uber_byte-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/uber_byte~craigslist-scraper/runs": { "post": { "operationId": "runs-sync-uber_byte-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/uber_byte~craigslist-scraper/run-sync": { "post": { "operationId": "run-sync-uber_byte-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": { "sites": { "title": "Sites (cities)", "type": "array", "description": "Craigslist site names, the part before .craigslist.org, e.g. sfbay, newyork, losangeles, chicago, seattle.", "items": { "type": "string" } }, "allUsSites": { "title": "Search all US sites", "type": "boolean", "description": "Run the search on every US craigslist site (~400). maxItems applies to each site and category.", "default": false }, "categories": { "title": "Categories", "type": "array", "description": "Craigslist category codes: sss (all for sale), cta (cars+trucks), cto (cars by owner), ctd (cars by dealer), hhh (all housing), apa (apartments for rent), rea (real estate for sale), roo (rooms), jjj (jobs), ggg (gigs), bbb (services), ccc (community), eee (events), fua (furniture), ela (electronics), zip (free stuff).", "default": [ "sss" ], "items": { "type": "string" } }, "query": { "title": "Search query", "type": "string", "description": "Keywords, e.g. \"honda civic\" or \"standing desk\"." }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Min price." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Max price." }, "postedToday": { "title": "Posted today", "type": "boolean", "description": "Posted today.", "default": false }, "hasPic": { "title": "Has image", "type": "boolean", "description": "Has image.", "default": false }, "postal": { "title": "ZIP / postal code", "type": "string", "description": "Search around this ZIP code. Use with Search distance." }, "searchDistance": { "title": "Search distance (miles)", "minimum": 1, "type": "integer", "description": "Radius around the ZIP code. Listings outside the radius are left out." }, "sort": { "title": "Sort", "enum": [ "date", "rel", "priceasc", "pricedsc", "dist" ], "type": "string", "description": "Leave empty for craigslist's default (relevance with a query, newest otherwise)." }, "searchUrls": { "title": "Search URLs", "type": "array", "description": "Craigslist search URLs copied from your browser, e.g. https://sfbay.craigslist.org/search/cta?query=tacoma or https://www.craigslist.org/search/area/newyork?cat=apa&max_price=3000. All filters in the URL are kept.", "items": { "type": "string" } }, "maxItems": { "title": "Max listings per search", "minimum": 1, "type": "integer", "description": "Maximum number of results to return. See the README for whether this applies per search or to the whole run.", "default": 100 }, "includeDetails": { "title": "Include posting details", "type": "boolean", "description": "Open each posting for its description, attributes (odometer, condition, make/model, bedrooms, sqft...), updated date and address. One extra request per listing.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Proxy settings. Apify Proxy is recommended for larger runs.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }