{ "openapi": "3.0.1", "info": { "title": "Craigslist Classifieds Scraper with Category Attributes", "description": "Scrape Craigslist search results and individual posts across any city subdomain, with category-specific attributes for jobs, housing, autos, and for-sale posts. No login or proxy required.", "version": "1.0", "x-build-id": "HWKb9T9uefJQgHpvH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vexaloom-labs~craigslist-classifieds-scraper-with-category/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vexaloom-labs-craigslist-classifieds-scraper-with-category", "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/vexaloom-labs~craigslist-classifieds-scraper-with-category/runs": { "post": { "operationId": "runs-sync-vexaloom-labs-craigslist-classifieds-scraper-with-category", "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/vexaloom-labs~craigslist-classifieds-scraper-with-category/run-sync": { "post": { "operationId": "run-sync-vexaloom-labs-craigslist-classifieds-scraper-with-category", "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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "category", "byUrl", "areas" ], "type": "string", "description": "What to collect: keyword search, a category browse, specific Craigslist URLs, or the region/subarea reference list.", "default": "search" }, "region": { "title": "Region", "enum": [ "sfbay", "newyork", "losangeles", "chicago", "seattle", "boston", "washingtondc", "atlanta", "dallas", "houston", "denver", "philadelphia", "miami", "austin", "sandiego", "phoenix", "portland", "minneapolis", "detroit", "nashville", "raleigh", "charlotte", "baltimore", "stlouis", "orlando", "tampa", "lasvegas", "sacramento", "hartford", "columbus", "indianapolis", "cincinnati", "cleveland", "kansascity", "milwaukee", "sanantonio", "pittsburgh", "newhaven", "providence", "richmond", "salem", "saltlakecity", "anchorage", "honolulu", "hudsonvalley", "longisland", "newjersey", "toronto", "vancouver", "montreal", "calgary", "ottawa", "edmonton", "london", "manchester", "birmingham", "leeds", "liverpool", "edinburgh", "glasgow", "bristol", "brighton" ], "type": "string", "description": "Craigslist city/region to search (mode=search/category). Pick a common region, or use Custom region for any of the 707 Craigslist sites.", "default": "sfbay" }, "customRegion": { "title": "Custom region", "type": "string", "description": "Any Craigslist hostname or abbreviation (e.g. humboldt, tokyo, sfbay). Overrides Region. (mode=search/category)" }, "subarea": { "title": "Subarea", "type": "string", "description": "Optional Craigslist subarea abbreviation inside the region (e.g. sfc, eby, brk). Leave blank for the whole region. (mode=search/category)" }, "category": { "title": "Category", "enum": [ "sss", "foa", "for", "fod", "sya", "sys", "syd", "waa", "wan", "wad", "tia", "tix", "tid", "bia", "bik", "bid", "mca", "mcy", "mcd", "bka", "bks", "bkd", "sga", "spo", "sgd", "cla", "clo", "cld", "cba", "clt", "cbd", "ela", "ele", "eld", "hsa", "hsh", "hsd", "msa", "msg", "msd", "baa", "bab", "bad", "ema", "emd", "emq", "tla", "tls", "tld", "boo", "boa", "bod", "jwa", "jwl", "jwd", "pta", "pts", "ptd", "rva", "rvs", "rvd", "taa", "tag", "tad", "gra", "grd", "grq", "bfa", "bfs", "bfd", "ara", "art", "ard", "maa", "mat", "mad", "pha", "pho", "phd", "fua", "fuo", "fud", "cta", "cto", "ctd", "ppa", "app", "ppd", "ata", "atq", "atd", "vga", "vgm", "vgd", "haa", "hab", "had", "moa", "mob", "mod", "sna", "snw", "snd", "hva", "hvo", "hvd", "mpa", "mpo", "mpd", "bip", "bop", "bdp", "syp", "sop", "sdp", "bpa", "bpo", "bpd", "wta", "wto", "wtd", "tra", "tro", "trb", "ava", "avo", "avd", "bar", "gms", "zip", "hhh", "rea", "reo", "reb", "apa", "hou", "roo", "sha", "sub", "off", "prk", "sbw", "swp", "vac", "rew", "jjj", "web", "bus", "mar", "etc", "wri", "sof", "acc", "ofc", "med", "hea", "ret", "npo", "lgl", "egr", "sls", "sad", "tfr", "hum", "tch", "edu", "trd", "gov", "sci", "csr", "trp", "spa", "rej", "mnu", "fbh", "lab", "sec", "ggg", "tlg", "cwg", "cpg", "lbg", "wrg", "dmg", "crg", "evg", "bbb", "biz", "cps", "crs", "evs", "hss", "lss", "lbs", "sks", "lgs", "fns", "rts", "aos", "bts", "wet", "trv", "fgs", "pas", "mas", "cys", "cms", "hws", "ccc", "com", "vol", "act", "rid", "pet", "kid", "mis", "ats", "muc", "pol", "laf", "rnr", "grp", "vnn", "eee", "eve", "cls", "rrr", "res" ], "type": "string", "description": "Craigslist category to search or browse. The default is all for-sale listings.", "default": "sss" }, "searchQueries": { "title": "Search queries", "type": "array", "description": "One or more keywords. Each query is searched separately; results are de-duplicated. Leave empty for a category browse. (mode=search)", "items": { "type": "string" }, "default": [] }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Craigslist search pages, new-style /view/d/... post URLs, or old /region/category/post-id.html URLs. (mode=byUrl)", "items": { "type": "object" }, "default": [] }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Only listings at or above this price. Posts without a price are excluded when a price filter is set." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Only listings at or below this price. Posts without a price are excluded when a price filter is set." }, "postedToday": { "title": "Posted today", "type": "boolean", "description": "Only listings posted in the last 24 hours (Craigslist's posted-today filter).", "default": false }, "hasImage": { "title": "Has image", "type": "boolean", "description": "Only listings with at least one photo.", "default": false }, "titlesOnly": { "title": "Titles only", "type": "boolean", "description": "Match the keywords against titles only instead of titles and descriptions.", "default": false }, "sellerType": { "title": "Seller type", "enum": [ "all", "owner", "dealer" ], "type": "string", "description": "Filter by owner, dealer, or either.", "default": "all" }, "sortBy": { "title": "Sort by", "enum": [ "newest", "oldest", "relevance", "priceAsc", "priceDesc", "distance" ], "type": "string", "description": "Order of results within each query.", "default": "newest" }, "condition": { "title": "Condition", "enum": [ "any", "new", "like-new", "excellent", "good", "fair", "salvage" ], "type": "string", "description": "For for-sale and auto categories: only items in this condition.", "default": "any" }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Housing only." }, "maxBedrooms": { "title": "Maximum bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Housing only." }, "minBathrooms": { "title": "Minimum bathrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Housing only." }, "maxBathrooms": { "title": "Maximum bathrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Housing only." }, "minSqft": { "title": "Minimum square feet", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Housing only." }, "maxSqft": { "title": "Maximum square feet", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Housing only." }, "autoMakeModel": { "title": "Vehicle make and model", "type": "string", "description": "Auto categories only, e.g. honda civic." }, "minAutoYear": { "title": "Minimum vehicle year", "minimum": 1900, "maximum": 2100, "type": "integer", "description": "Auto categories only." }, "maxAutoYear": { "title": "Maximum vehicle year", "minimum": 1900, "maximum": 2100, "type": "integer", "description": "Auto categories only." }, "maxAutoMiles": { "title": "Maximum vehicle mileage", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Auto categories only." }, "postalCode": { "title": "Postal code", "type": "string", "description": "Optional ZIP/postal code to anchor the search geographically. Use with Search radius." }, "searchRadiusMiles": { "title": "Search radius (miles)", "minimum": 1, "maximum": 250, "type": "integer", "description": "Distance around the postal code. Requires Postal code." }, "hideDuplicates": { "title": "Hide duplicate listings", "type": "boolean", "description": "Ask Craigslist to group duplicate/reposted listings together.", "default": false }, "deliveryAvailable": { "title": "Delivery available", "type": "boolean", "description": "For-sale and auto categories: only listings offering delivery.", "default": false }, "cryptoOk": { "title": "Cryptocurrency accepted", "type": "boolean", "description": "For-sale and auto categories: only listings that accept crypto.", "default": false }, "countryCode": { "title": "Country code", "type": "string", "description": "Two-letter country code to filter the areas list (mode=areas), e.g. US, CA, GB. Leave blank for all 707 sites." }, "maxItems": { "title": "Maximum listings", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard cap across all queries and URLs. Craigslist returns at most 10,000 results per search.", "default": 100 }, "includeDetails": { "title": "Include full listing details", "type": "boolean", "description": "Fetch each listing's full description, attributes, images, coordinates, and repost status. Turn off for faster search-card-only results.", "default": 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 } } } } } } } } } }