{ "openapi": "3.0.1", "info": { "title": "Craigslist Scraper - Housing Jobs Cars Worldwide", "description": "Scrape Craigslist classifieds worldwide: housing, jobs, cars, services, gigs, community, events, and resumes. 707 official cities. Price, photos, URLs — no login or API key.", "version": "0.7", "x-build-id": "YR6Ew5ssLX2fXKtst" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~craigslist-housing-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-craigslist-housing-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/lentic_clockss~craigslist-housing-scraper/runs": { "post": { "operationId": "runs-sync-lentic_clockss-craigslist-housing-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/lentic_clockss~craigslist-housing-scraper/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-craigslist-housing-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": { "locations": { "title": "Craigslist area slugs", "type": "array", "description": "Official area slugs from craigslist.org/about/sites, e.g. austin, sfbay, toronto, london, sydney, berlin, mexicocity. Country/cc/lang are auto-resolved from this catalog unless overridden.", "default": [ "phoenix" ], "items": { "type": "string" } }, "country": { "title": "Country code override", "type": "string", "description": "Optional ISO-like Craigslist cc (us, ca, uk, au, de, fr, mx, …). Leave blank to use the area-slug catalog. gb is accepted as uk.", "default": "" }, "lang": { "title": "Language", "type": "string", "description": "SAPI lang. Default is en, except Quebec slugs which default to fr.", "default": "" }, "category": { "title": "Category", "enum": [ "all", "hhh", "sss", "jjj", "ggg", "bbb", "ccc", "eee", "rrr", "apa", "swp", "off", "prk", "rea", "roo", "sub", "vac", "hou", "hsw", "sha", "sbw", "act", "ats", "kid", "cls", "eve", "com", "grp", "vnn", "laf", "mis", "muc", "pet", "pol", "rnr", "rid", "vol", "aos", "bts", "cms", "cps", "crs", "cys", "evs", "fgs", "fns", "hws", "hss", "lbs", "lgs", "lss", "mas", "pas", "rts", "sks", "biz", "trv", "wet", "ata", "ppa", "ara", "sna", "pta", "ava", "baa", "bar", "haa", "bip", "bia", "bpa", "boo", "bka", "bfa", "cta", "ema", "moa", "cla", "cba", "syp", "sya", "ela", "gra", "zip", "fua", "gms", "foa", "hva", "hsa", "jwa", "maa", "mpa", "mca", "msa", "pha", "rva", "sga", "tia", "tla", "taa", "tra", "vga", "waa", "wta", "acc", "ofc", "egr", "med", "sci", "bus", "csr", "edu", "etc", "fbh", "lab", "gov", "hum", "lgl", "mnu", "mar", "hea", "npo", "rej", "ret", "sls", "spa", "sec", "trd", "sof", "sad", "tch", "trp", "tfr", "web", "wri", "cpg", "crg", "cwg", "dmg", "evg", "lbg", "tlg", "wrg", "reo", "reb" ], "type": "string", "description": "Any Craigslist 3-letter category. Section codes hhh/sss/jjj/ggg/bbb/ccc/eee/rrr search that whole section in one SAPI call. \"all\" expands every housing leaf (not the whole site).", "default": "apa" }, "purveyor": { "title": "Sale purveyor", "enum": [ "", "owner", "dealer" ], "type": "string", "description": "Used for real estate / for-sale. Leave blank for all, owner for by-owner, dealer for by-broker.", "default": "" }, "query": { "title": "Keyword query", "type": "string", "description": "Optional Craigslist keyword query." }, "minPrice": { "title": "Minimum price", "type": "integer", "description": "Optional minimum price / rent." }, "maxPrice": { "title": "Maximum price", "type": "integer", "description": "Optional maximum price / rent." }, "minBedrooms": { "title": "Minimum bedrooms", "type": "integer", "description": "Optional minimum bedroom count." }, "maxBedrooms": { "title": "Maximum bedrooms", "type": "integer", "description": "Optional maximum bedroom count." }, "minBathrooms": { "title": "Minimum bathrooms", "type": "integer", "description": "Optional minimum bathroom count (SAPI filter)." }, "maxBathrooms": { "title": "Maximum bathrooms", "type": "integer", "description": "Optional maximum bathroom count (SAPI filter)." }, "minSqft": { "title": "Minimum sqft", "type": "integer", "description": "Housing search minSqft filter." }, "maxSqft": { "title": "Maximum sqft", "type": "integer", "description": "Housing search maxSqft filter." }, "housingType": { "title": "Housing type", "type": "integer", "description": "Craigslist housing_type: 1 apartment, 2 condo, 3 cottage/cabin, 4 duplex, 5 flat, 6 house, 7 in-law, 8 loft, 9 land, 10 manufactured, 11 townhouse, 12 assisted living." }, "laundry": { "title": "Laundry", "type": "integer", "description": "1 w/d in unit, 2 w/d hookups, 3 laundry in bldg, 4 laundry on site, 5 no laundry on site." }, "parking": { "title": "Parking", "type": "integer", "description": "1 carport, 2 attached garage, 3 detached garage, 4 off-street, 5 street, 6 valet, 7 no parking." }, "catsOk": { "title": "Cats OK", "type": "boolean", "description": "Housing pets_cat=1.", "default": false }, "dogsOk": { "title": "Dogs OK", "type": "boolean", "description": "Housing pets_dog=1.", "default": false }, "furnished": { "title": "Furnished", "type": "boolean", "description": "Housing is_furnished=1.", "default": false }, "noSmoking": { "title": "No smoking", "type": "boolean", "description": "Housing no_smoking=1.", "default": false }, "wheelchairAccessible": { "title": "Wheelchair accessible", "type": "boolean", "description": "Housing wheelchair_accessible=1.", "default": false }, "evCharging": { "title": "EV charging", "type": "boolean", "description": "Housing EV_charging=1.", "default": false }, "airConditioning": { "title": "Air conditioning", "type": "boolean", "description": "Housing airconditioning=1.", "default": false }, "privateRoom": { "title": "Private room", "type": "boolean", "description": "Rooms/shares private_room=1.", "default": false }, "privateBath": { "title": "Private bath", "type": "boolean", "description": "Rooms/shares private_bath=1.", "default": false }, "hasPic": { "title": "Only listings with photos", "type": "boolean", "description": "Filter search results to postings that have at least one photo.", "default": false }, "postedToday": { "title": "Only posted today", "type": "boolean", "description": "Filter search results to postings published today.", "default": false }, "searchNearby": { "title": "Include nearby areas", "type": "boolean", "description": "Craigslist searchNearby=1.", "default": false }, "postal": { "title": "Postal / ZIP", "type": "string", "description": "Optional postal code for nearby search." }, "searchDistance": { "title": "Search distance", "type": "integer", "description": "Miles/km for search_distance when nearby search is on." }, "bundleDuplicates": { "title": "Bundle duplicates", "type": "boolean", "description": "Craigslist bundleDuplicates=1.", "default": false }, "saleDate": { "title": "Event sale date", "type": "string", "description": "Events calendar sale_date (YYYY-MM-DD)." }, "sort": { "title": "Sort order", "enum": [ "date", "dateoldest", "priceasc", "pricedsc" ], "type": "string", "description": "Craigslist search sort. When maxItems > 360, the actor also shards across alternate sorts/price buckets because SAPI /full has no true offset pagination.", "default": "date" }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Optional Craigslist search or detail URLs. Accepts www.craigslist.org/search/area/{slug}, city.craigslist.org, and international TLDs (.ca, .co.uk, .com.au, …). Search URLs override category/location for that URL. Store Test default is empty so Console Test uses locations+category only.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Max listings (max 2,000; free users capped at 1,000/run)", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Maximum listings to save (1–2000). Each SAPI request returns up to 360 rows; values above 360 automatically enable sort/price sharding. Free Apify plan users are capped at 1,000 listings per run and 10 total runs of this Actor — limits set by the Actor developer.", "default": 1 }, "scrapeDetails": { "title": "Enrich from detail pages", "type": "boolean", "description": "Fetch public listing detail pages (body, JSON-LD, map/门牌, images) and best-effort GET /reply/…/popup for relay email and poster name. Does not solve CAPTCHA or send messages. Default on — turn off only for title/price search cards (lead fields will be 未验证).", "default": true }, "maxDetailConcurrency": { "title": "Detail-page concurrency", "minimum": 1, "maximum": 15, "type": "integer", "description": "Maximum number of public detail pages fetched in parallel when enrichment is enabled.", "default": 5 }, "imageSize": { "title": "Search image size", "enum": [ "300x300", "600x450", "1200x900" ], "type": "string", "description": "Image size suffix used when constructing SAPI image URLs.", "default": "600x450" }, "requestDelayMillis": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Politeness delay applied before search shards and detail-page requests.", "default": 250 }, "workerBaseUrl": { "title": "Worker base URL (optional)", "type": "string", "description": "Override the Cloud Run worker origin for this run. Defaults to Actor env WORKER_BASE_URL. Production migrations should update WORKER_BASE_URL in Actor settings (no code change).", "default": "" } } }, "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 } } } } } } } } } }