{ "openapi": "3.0.1", "info": { "title": "Craigslist Scraper & API: Cars, Housing, Jobs & Deals", "description": "⚡ Fast & Cheap ($0.35/1k): Monitor & scrape Craigslist cars, housing, jobs, electronics & for-sale across 700+ cities. Multi-city search, new listing alerts, HD photos & contacts.", "version": "1.2", "x-build-id": "k8PwbslPcqnR7XfK5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/unitbytes~craigslist-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-unitbytes-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/unitbytes~craigslist-scraper/runs": { "post": { "operationId": "runs-sync-unitbytes-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/unitbytes~craigslist-scraper/run-sync": { "post": { "operationId": "run-sync-unitbytes-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": { "startUrls": { "title": "Start URLs (Search, Category, or Listing URLs)", "type": "array", "description": "List of Craigslist search, category, borough/subarea, or direct listing URLs (e.g. https://sfbay.craigslist.org/eby/cta, https://newyork.craigslist.org/mnh/apa, https://toronto.craigslist.org/search/cta). Paste URLs directly from your browser to target any city, neighborhood, or custom filter set worldwide.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchUrl": { "title": "Search or Listing URL", "type": "string", "description": "💡 Easiest method: Browse to any search, neighborhood, or borough on Craigslist, copy the URL from your browser address bar (e.g. https://sfbay.craigslist.org/eby/cta or https://newyork.craigslist.org/mnh/apa), and paste it here. All cities, subareas, filters, and price ranges are automatically extracted." }, "searchQuery": { "title": "Search Keyword (Optional)", "type": "string", "description": "Keyword to search for (e.g. 'toyota', 'macbook', 'apartment'). Leave blank to scrape ALL listings in the selected category or city." }, "category": { "title": "Category", "enum": [ "sss", "cta", "cto", "ctd", "apa", "rea", "reo", "roo", "sub", "off", "jjj", "ggg", "bbb", "res", "sof", "trd", "trp", "ela", "mob", "sys", "vgm", "pha", "fua", "app", "tla", "mca", "mcy", "rva", "boo", "pts", "hva", "bka", "sga", "clt", "atq", "ccc", "zip" ], "type": "string", "description": "Craigslist category code.", "default": "sss" }, "subdomain": { "title": "Metro Area / Region", "enum": [ "losangeles", "newyork", "sfbay", "chicago", "houston", "dallas", "miami", "seattle", "atlanta", "phoenix", "denver", "boston", "sandiego", "austin", "lasvegas", "portland", "orlando", "tampa", "minneapolis", "detroit", "philadelphia", "washingtondc", "charlotte", "raleigh", "nashville", "sacramento", "saltlakecity", "columbus", "cleveland", "pittsburgh", "stlouis", "kansascity", "indianapolis", "cincinnati", "milwaukee", "sanantonio", "jacksonville", "memphis", "richmond", "baltimore", "honolulu", "anchorage", "albuquerque", "tucson", "fresno", "tulsa", "oklahomacity", "omaha", "louisville", "neworleans", "birmingham", "toronto", "vancouver", "montreal", "calgary", "ottawa", "edmonton", "london", "manchester", "edinburgh", "dublin", "sydney", "melbourne", "brisbane", "auckland", "paris", "berlin", "amsterdam", "rome", "madrid", "tokyo", "singapore", "hongkong", "dubai", "seoul", "mexicocity", "puertorico", "buenosaires" ], "type": "string", "description": "Select from top global metropolitan areas across US, Canada, UK, Australia, Europe, and Asia, OR simply paste any Craigslist URL above to target ANY city, town, or neighborhood worldwide.", "default": "losangeles" }, "subarea": { "title": "Sub-Region / Borough (Optional)", "type": "string", "description": "Optional sub-region or borough code (e.g., 'mnh' for Manhattan, 'eby' for East Bay, 'wst' for Westside, 'tor' for City of Toronto). Leave empty to search the entire metropolitan area, or paste a URL above." }, "regionPreset": { "title": "Regional Cluster Preset", "enum": [ "none", "socal", "norcal_bayarea", "florida", "texas", "tri_state_ny", "pacific_northwest", "midwest_chicago" ], "type": "string", "description": "Target an entire regional market across multiple cities in a single run. Overrides the single Metro Area dropdown above.", "default": "none" }, "subdomains": { "title": "Custom Multi-Metro List (Optional)", "type": "array", "description": "List of specific Craigslist metropolitan subdomains to scrape in a single run (e.g. ['miami', 'orlando', 'tampa'] or ['austin', 'dallas']).", "items": { "type": "string" } }, "scrapeDetails": { "title": "Scrape Full Listing Details (Recommended)", "type": "boolean", "description": "Enabled by default ($1.50/1k). Extracts complete listing details including full description, direct contact info (phones/emails), complete vehicle specs (VIN, mileage, year, title status, transmission), real estate attributes (beds, baths, sqft, laundry, parking, pets), job employment type, brand/model, and up to 24 HD photos (1200x900). Disable for fast Search Discovery ($0.50/1k — returns title, price, post date, city/subarea, coordinates, and summary attributes; detail-only columns like VIN, Baths, and Phones/Emails will be empty).", "default": true }, "minPrice": { "title": "Minimum Price ($)", "minimum": 0, "type": "integer", "description": "Minimum listing price in USD." }, "maxPrice": { "title": "Maximum Price ($)", "minimum": 0, "type": "integer", "description": "Maximum listing price in USD." }, "purveyor": { "title": "Seller Type", "enum": [ "all", "owner", "dealer" ], "type": "string", "description": "Filter by owner or dealer.", "default": "all" }, "hasImage": { "title": "Has Photos Only", "type": "boolean", "description": "Only return listings that include photos.", "default": false }, "postedToday": { "title": "Posted Today Only", "type": "boolean", "description": "Only return listings published within the last 24 hours.", "default": false }, "sort": { "title": "Sort Order", "enum": [ "date", "priceasc", "pricedsc", "rel" ], "type": "string", "description": "Sort order for returned listings (Newest first, lowest price, highest price, or relevance).", "default": "date" }, "postal": { "title": "Postal / ZIP Code (Optional)", "type": "string", "description": "Target a specific postal or ZIP code (e.g. '90210', '10001', 'M5V 2T6'). Combine with Search Radius below." }, "radius": { "title": "Search Radius (Miles)", "minimum": 1, "maximum": 500, "type": "integer", "description": "Distance radius in miles around the specified Postal / ZIP Code." }, "condition": { "title": "Item Condition", "enum": [ "all", "10", "20", "30", "40", "50", "60" ], "type": "string", "description": "Filter listings by item condition (for vehicles, electronics, furniture, for sale).", "default": "all" }, "autoMakeModel": { "title": "Vehicle Make / Model", "type": "string", "description": "Filter by vehicle make or model (e.g. 'toyota tacoma', 'honda civic', 'ford f150'). Executed server-side on Craigslist." }, "minAutoYear": { "title": "Min Model Year", "minimum": 1900, "maximum": 2030, "type": "integer", "description": "Minimum vehicle model year (e.g. 2015)." }, "maxAutoYear": { "title": "Max Model Year", "minimum": 1900, "maximum": 2030, "type": "integer", "description": "Maximum vehicle model year (e.g. 2026)." }, "minAutoMiles": { "title": "Min Odometer Mileage", "minimum": 0, "type": "integer", "description": "Minimum vehicle odometer reading in miles." }, "maxAutoMiles": { "title": "Max Odometer Mileage", "minimum": 0, "type": "integer", "description": "Maximum vehicle odometer reading in miles (e.g. 100000)." }, "autoTitleStatus": { "title": "Vehicle Title Status", "enum": [ "all", "1", "2", "3", "4", "5", "6" ], "type": "string", "description": "Filter vehicles by title status.", "default": "all" }, "autoTransmission": { "title": "Transmission", "enum": [ "all", "1", "2", "3" ], "type": "string", "description": "Filter vehicles by transmission type.", "default": "all" }, "autoFuelType": { "title": "Fuel Type", "enum": [ "all", "1", "2", "3", "4", "6" ], "type": "string", "description": "Filter vehicles by fuel or powertrain type.", "default": "all" }, "minBedrooms": { "title": "Min Bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Minimum number of bedrooms (0 for Studio, 1, 2, 3+)." }, "maxBedrooms": { "title": "Max Bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Maximum number of bedrooms." }, "minBathrooms": { "title": "Min Bathrooms", "minimum": 1, "maximum": 10, "type": "integer", "description": "Minimum number of bathrooms." }, "maxBathrooms": { "title": "Max Bathrooms", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum number of bathrooms." }, "minSqft": { "title": "Min Square Feet (Sqft)", "minimum": 0, "type": "integer", "description": "Minimum property square footage." }, "maxSqft": { "title": "Max Square Feet (Sqft)", "minimum": 0, "type": "integer", "description": "Maximum property square footage." }, "housingType": { "title": "Property / Housing Type", "enum": [ "all", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "12" ], "type": "string", "description": "Filter by specific residential or land property type.", "default": "all" }, "petsDog": { "title": "Dogs OK", "type": "boolean", "description": "Only return rentals that allow dogs.", "default": false }, "petsCat": { "title": "Cats OK", "type": "boolean", "description": "Only return rentals that allow cats.", "default": false }, "laundryType": { "title": "Laundry Amenities", "enum": [ "all", "1", "2", "3", "4", "5" ], "type": "string", "description": "Filter by laundry availability.", "default": "all" }, "parkingType": { "title": "Parking Options", "enum": [ "all", "1", "2", "3", "4", "5", "6", "7" ], "type": "string", "description": "Filter by parking or garage availability.", "default": "all" }, "employmentType": { "title": "Employment Type", "enum": [ "all", "1", "2", "3", "4" ], "type": "string", "description": "Filter job postings by full-time, part-time, or contract status.", "default": "all" }, "isTelecommuting": { "title": "Remote / Telecommute OK", "type": "boolean", "description": "Only return remote or telecommute-friendly job listings.", "default": false }, "isInternship": { "title": "Internship Only", "type": "boolean", "description": "Only return internship positions.", "default": false }, "isNonProfit": { "title": "Non-Profit Organization Only", "type": "boolean", "description": "Only return jobs at non-profit organizations.", "default": false }, "isPaidGig": { "title": "Gig Pay Status (For Gigs)", "enum": [ "all", "yes", "no" ], "type": "string", "description": "Filter gig listings by paid or unpaid status.", "default": "all" }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of listings to extract.", "default": 50 }, "offset": { "title": "Result Offset (Skip Items)", "minimum": 0, "type": "integer", "description": "Number of initial listings to skip for pagination or bookmarking (e.g., 120, 240, 360).", "default": 0 }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum simultaneous detail requests.", "default": 5 }, "hideDuplicates": { "title": "Bundle Duplicate Postings", "type": "boolean", "description": "Enables Craigslist's server-side duplicate bundling (bundleDuplicates=1) to collapse duplicate dealer reposts.", "default": true }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Managed Apify proxy configuration with automatic IP rotation. Highly recommended when Scrape Full Listing Details is enabled to prevent Craigslist IP blocks.", "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 }, "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 } } } } } } } } } }