{ "openapi": "3.0.1", "info": { "title": "Craigslist Scraper — Listings, Cars, Housing & Jobs", "description": "Scrape craigslist listings in any of its 707 areas: title, price, posted date, place, category, photos, beds/ft² for housing, odometer for cars, pay/company for jobs. Optional full description and every attribute. Filters: price, condition, owner/dealer, make, year, ZIP radius. No login.", "version": "0.1", "x-build-id": "1YYTmBtlVh9bDSbgd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yugenox~craigslist-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yugenox-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/yugenox~craigslist-scraper/runs": { "post": { "operationId": "runs-sync-yugenox-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/yugenox~craigslist-scraper/run-sync": { "post": { "operationId": "run-sync-yugenox-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": { "areas": { "title": "📍 Areas", "type": "array", "description": "craigslist sites to search: the name before .craigslist.org (\"sfbay\", \"newyork\", \"losangeles\", \"toronto\", \"london\"), the area name (\"SF bay area\", \"New York\"), or a sub-area (\"sfbay/eby\", \"east bay\", \"brooklyn\"). All 707 craigslist areas work, in every country.", "items": { "type": "string" } }, "keywords": { "title": "🔎 Keywords", "type": "array", "description": "What to search for, e.g. \"bike\", \"honda civic\", \"2 bedroom\", \"delivery driver\". Each keyword is searched separately in each area. Leave empty to list everything in the category.", "items": { "type": "string" } }, "category": { "title": "Category", "enum": [ "sss", "cta", "mca", "bia", "bip", "boo", "rva", "pta", "wta", "sna", "hva", "tra", "fua", "hsa", "ppa", "ela", "sya", "syp", "moa", "vga", "pha", "msa", "tla", "maa", "gra", "sga", "taa", "baa", "cla", "jwa", "haa", "ata", "cba", "ara", "bka", "ema", "tia", "bfa", "foa", "zip", "gms", "bar", "waa", "hhh", "apa", "roo", "sub", "rea", "off", "prk", "vac", "swp", "jjj", "ggg", "bbb" ], "type": "string", "description": "Which craigslist section to search. For sale, housing, jobs, gigs and services are supported (community, resumes and housing-wanted posts are about people and are never collected).", "default": "sss" }, "maxItems": { "title": "Max listings", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Maximum number of listings for the whole run, shared fairly between your searches (a search that finds fewer leaves its share to the others). 0 = everything (craigslist lists up to 10,000 per search).", "default": 100 }, "includeDetails": { "title": "Include full details", "type": "boolean", "description": "Also open every posting for the full description, all attributes (condition, make, model, odometer, fuel, VIN, rent period, pay, employment type …), the original post date, the last update, the postal code and every photo. Adds one page per listing; charged separately per listing.", "default": false }, "startUrls": { "title": "🔗 craigslist URLs", "type": "array", "description": "Optional: craigslist search URLs (every filter in the URL is kept — set filters on craigslist, then paste the address) or posting URLs.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "sort": { "title": "Sort by", "enum": [ "newest", "relevance", "priceAsc", "priceDesc", "oldest" ], "type": "string", "description": "Order of the results (and which listings you get first).", "default": "newest" }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Lowest price, in the area's currency." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Highest price, in the area's currency." }, "postedToday": { "title": "Posted today", "type": "boolean", "description": "Only listings posted today.", "default": false }, "maxAgeHours": { "title": "Posted within (hours)", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Only listings posted or reposted in the last N hours — e.g. 24 for a daily schedule. Empty = any age." }, "hasImage": { "title": "Has photos", "type": "boolean", "description": "Only listings with at least one photo.", "default": false }, "sellerType": { "title": "Sold by", "enum": [ "all", "owner", "dealer" ], "type": "string", "description": "For-sale listings by owners, by dealers, or both.", "default": "all" }, "condition": { "title": "Condition", "type": "array", "description": "Only items in these conditions (for-sale categories). Empty = any.", "items": { "type": "string", "enum": [ "new", "like new", "excellent", "good", "fair", "salvage" ], "enumTitles": [ "New", "Like new", "Excellent", "Good", "Fair", "Salvage" ] } }, "searchTitlesOnly": { "title": "Search titles only", "type": "boolean", "description": "Match keywords in titles only (not in the posting text).", "default": false }, "bundleDuplicates": { "title": "Bundle duplicates", "type": "boolean", "description": "Keep one listing when craigslist marks several as duplicates of each other.", "default": false }, "includeNearby": { "title": "Include nearby areas", "type": "boolean", "description": "When an area has few results, craigslist adds listings from nearby areas. Off = only the areas you chose.", "default": false }, "postalCode": { "title": "ZIP / postal code", "type": "string", "description": "Search around this ZIP or postal code (inside the chosen area). Use with Distance." }, "searchDistance": { "title": "Distance", "minimum": 1, "maximum": 500, "type": "integer", "description": "Radius around the ZIP / postal code, in the area's units (miles in the US, km in Canada)." }, "makeModel": { "title": "Make and model", "type": "string", "description": "Vehicles: e.g. \"honda civic\", \"ford f-150\"." }, "minYear": { "title": "Min model year", "minimum": 1900, "maximum": 2100, "type": "integer", "description": "Vehicles: oldest model year." }, "maxYear": { "title": "Max model year", "minimum": 1900, "maximum": 2100, "type": "integer", "description": "Vehicles: newest model year." }, "minOdometer": { "title": "Min odometer", "minimum": 0, "type": "integer", "description": "Vehicles: lowest odometer reading." }, "maxOdometer": { "title": "Max odometer", "minimum": 0, "type": "integer", "description": "Vehicles: highest odometer reading." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "maximum": 8, "type": "integer", "description": "Housing: fewest bedrooms." }, "maxBedrooms": { "title": "Max bedrooms", "minimum": 0, "maximum": 8, "type": "integer", "description": "Housing: most bedrooms." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy (datacenter) is the default and comes with every Apify plan. If craigslist refuses datacenter IPs for a while, the run switches to residential proxies when your account has them.", "default": { "useApifyProxy": true } }, "maxConcurrency": { "title": "Parallel posting pages", "minimum": 1, "maximum": 8, "type": "integer", "description": "How many posting pages to read at once with \"Include full details\".", "default": 3 } } }, "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 } } } } } } } } } }