{ "openapi": "3.0.1", "info": { "title": "Craigslist Scraper & Monitor", "description": "Scrape Craigslist by keyword, city, ZIP radius, state or nationwide, with complete results past Craigslist's 360 cap. Monitor mode returns only new listings, price drops and reposts, with Discord, Slack and Telegram alerts. Deal scores, repost detection, scam flags and VIN decoding included.", "version": "0.1", "x-build-id": "XEgh63c6F5aDDEVZ1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hydedata~craigslist-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hydedata-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/hydedata~craigslist-scraper/runs": { "post": { "operationId": "runs-sync-hydedata-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/hydedata~craigslist-scraper/run-sync": { "post": { "operationId": "run-sync-hydedata-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": { "searchQueries": { "title": "Search keywords", "type": "array", "description": "What to search for. Each keyword is its own search in every location below. Leave empty to browse the whole category. Craigslist syntax works: \"road bike | gravel bike\" matches either, \"-kids\" excludes a word.", "items": { "type": "string" } }, "category": { "title": "Category", "enum": [ "sss", "cta", "cto", "ctd", "mca", "mcy", "mcd", "mpa", "mpo", "mpd", "rva", "rvs", "rvd", "boo", "boa", "bod", "bpa", "bpo", "bpd", "pta", "pts", "ptd", "wta", "wto", "wtd", "tra", "tro", "trb", "sna", "snw", "snd", "hva", "hvo", "hvd", "ava", "avo", "avd", "bia", "bik", "bid", "bip", "bop", "bdp", "ela", "ele", "eld", "sya", "sys", "syd", "syp", "sop", "sdp", "moa", "mob", "mod", "vga", "vgm", "vgd", "pha", "pho", "phd", "msa", "msg", "msd", "ema", "emd", "emq", "fua", "fuo", "fud", "ppa", "app", "ppd", "hsa", "hsh", "hsd", "tla", "tls", "tld", "maa", "mat", "mad", "gra", "grd", "grq", "sga", "spo", "sgd", "taa", "tag", "tad", "baa", "bab", "bad", "cba", "clt", "cbd", "ata", "atq", "atd", "ara", "art", "ard", "jwa", "jwl", "jwd", "cla", "clo", "cld", "haa", "hab", "had", "bka", "bks", "bkd", "tia", "tix", "tid", "bfa", "bfs", "bfd", "foa", "for", "fod", "zip", "gms", "waa", "wan", "wad", "hhh", "apa", "roo", "sub", "vac", "rea", "reo", "reb", "off", "prk", "jjj", "ggg", "bbb", "ccc", "eee" ], "type": "string", "description": "Craigslist section to search. \"for sale (all)\" covers every for-sale category. The \"by owner\" and \"by dealer\" entries search only that kind of seller.", "default": "sss" }, "locations": { "title": "Locations", "type": "array", "description": "Where to search. Any of: \"City, ST\" (\"Plano, TX\", \"Toronto, ON\"), a ZIP or Canadian postal code (\"78704\", \"M5V 2T6\"), or a Craigslist site name (\"sfbay\", \"orlando\", \"SF bay area\"). Cities and postal codes search the radius below; site names search that whole Craigslist site.", "items": { "type": "string" } }, "radiusMiles": { "title": "Radius (miles)", "minimum": 1, "type": "integer", "description": "Search this far around each city or postal code, across Craigslist site borders. Defaults to 25 miles. With a site name, searches this far around the site's center instead of the whole site. Up to 250 miles uses Craigslist's own radius search; bigger radii search every site in range." }, "searchStates": { "title": "Whole states or provinces", "type": "array", "description": "Search every Craigslist site in these states or provinces, e.g. \"TX\", \"Florida\", \"ON\".", "items": { "type": "string" } }, "searchEverywhere": { "title": "Search everywhere", "enum": [ "", "US", "CA", "US_CA", "ALL" ], "type": "string", "description": "Search every Craigslist site in a country at once. Each site is one request, so a nationwide US search is about 410 requests (still only a few MB).", "default": "" }, "searchUrls": { "title": "Craigslist search URLs (advanced)", "type": "array", "description": "Optional. Run a search on craigslist.org with any filters and paste its URL. Every filter in the URL is kept. Can be combined with keywords.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "categoryCode": { "title": "Category code (advanced)", "type": "string", "description": "Any Craigslist category code, overriding the list above, e.g. \"sof\" for software jobs or \"lbs\" for labor and moving services." }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Lowest price." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Highest price." }, "postedWithinHours": { "title": "Posted within (hours)", "minimum": 1, "type": "integer", "description": "Only listings posted or renewed in the last this many hours, e.g. 24." }, "sellerType": { "title": "Sold by", "enum": [ "all", "owner", "dealer" ], "type": "string", "description": "Owners, dealers, or both. Works with any for-sale category; the \"by owner\" and \"by dealer\" categories do the same for one section.", "default": "all" }, "conditions": { "title": "Condition", "type": "array", "description": "Only listings in these conditions. Leave empty for any.", "items": { "type": "string", "enum": [ "10", "20", "30", "40", "50", "60" ], "enumTitles": [ "new", "like new", "excellent", "good", "fair", "salvage" ] } }, "hasImage": { "title": "Has image", "type": "boolean", "description": "Only listings with photos.", "default": false }, "searchTitlesOnly": { "title": "Search titles only", "type": "boolean", "description": "Craigslist matches keywords in the title only instead of the whole post.", "default": false }, "strictKeywordMatch": { "title": "Only keep listings whose title matches the keywords", "type": "boolean", "description": "Craigslist matches keywords anywhere in a post, so a \"tacoma\" search also returns cars whose description mentions a Tacoma. When on, a listing is kept only if its title contains every keyword word (\"bike\" also matches \"bikes\"). Dropped listings aren't charged.", "default": false }, "excludeKeywords": { "title": "Exclude listings with these words", "type": "array", "description": "Drop listings whose title contains any of these words or phrases, e.g. \"parts\", \"wanted\", \"kids\". Dropped listings aren't charged.", "items": { "type": "string" } }, "deliveryAvailable": { "title": "Delivery available", "type": "boolean", "description": "Only listings that offer delivery.", "default": false }, "hideCraigslistDuplicates": { "title": "Craigslist's hide duplicates", "type": "boolean", "description": "Craigslist's own duplicate bundling. The Actor's repost grouping (below) catches more.", "default": false }, "makeModel": { "title": "Make and model", "type": "string", "description": "Vehicle make and/or model as Craigslist matches it, e.g. \"toyota tacoma\"." }, "minYear": { "title": "Min model year", "minimum": 1900, "type": "integer", "description": "Oldest model year." }, "maxYear": { "title": "Max model year", "minimum": 1900, "type": "integer", "description": "Newest model year." }, "minMiles": { "title": "Min odometer", "minimum": 0, "type": "integer", "description": "Lowest mileage." }, "maxMiles": { "title": "Max odometer", "minimum": 0, "type": "integer", "description": "Highest mileage." }, "titleStatus": { "title": "Title status", "type": "array", "description": "Leave empty for any.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6" ], "enumTitles": [ "clean", "salvage", "rebuilt", "parts only", "lien", "missing" ] } }, "transmission": { "title": "Transmission", "type": "array", "description": "Leave empty for any.", "items": { "type": "string", "enum": [ "1", "2", "3" ], "enumTitles": [ "manual", "automatic", "other" ] } }, "fuelType": { "title": "Fuel", "type": "array", "description": "Leave empty for any.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "6" ], "enumTitles": [ "gas", "diesel", "hybrid", "electric", "other" ] } }, "drivetrain": { "title": "Drive", "type": "array", "description": "Leave empty for any.", "items": { "type": "string", "enum": [ "1", "2", "3" ], "enumTitles": [ "fwd", "rwd", "4wd" ] } }, "bodyType": { "title": "Body type", "type": "array", "description": "Leave empty for any.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12", "13" ], "enumTitles": [ "bus", "convertible", "coupe", "hatchback", "minivan", "offroad", "pickup", "sedan", "truck", "SUV", "wagon", "van", "other" ] } }, "cylinders": { "title": "Cylinders", "type": "array", "description": "Leave empty for any.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6", "7", "8" ], "enumTitles": [ "3", "4", "5", "6", "8", "10", "12", "other" ] } }, "paintColor": { "title": "Paint color", "type": "array", "description": "Leave empty for any.", "items": { "type": "string", "enum": [ "1", "2", "20", "3", "4", "5", "6", "7", "8", "9", "10", "11" ], "enumTitles": [ "black", "blue", "brown", "green", "grey", "orange", "purple", "red", "silver", "white", "yellow", "custom" ] } }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "type": "integer", "description": "Fewest bedrooms." }, "maxBedrooms": { "title": "Max bedrooms", "minimum": 0, "type": "integer", "description": "Most bedrooms." }, "minBathrooms": { "title": "Min bathrooms", "minimum": 0, "type": "integer", "description": "Fewest bathrooms." }, "maxBathrooms": { "title": "Max bathrooms", "minimum": 0, "type": "integer", "description": "Most bathrooms." }, "minSqft": { "title": "Min square feet", "minimum": 0, "type": "integer", "description": "Smallest size." }, "maxSqft": { "title": "Max square feet", "minimum": 0, "type": "integer", "description": "Largest size." }, "housingTypes": { "title": "Housing type", "type": "array", "description": "Leave empty for any.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6", "7", "8", "9", "10", "11", "12" ], "enumTitles": [ "apartment", "condo", "cottage/cabin", "duplex", "flat", "house", "in-law", "loft", "townhouse", "manufactured", "assisted living", "land" ] } }, "laundry": { "title": "Laundry", "type": "array", "description": "Leave empty for any.", "items": { "type": "string", "enum": [ "1", "4", "2", "3", "5" ], "enumTitles": [ "w/d in unit", "w/d hookups", "laundry in bldg", "laundry on site", "no laundry on site" ] } }, "parking": { "title": "Parking", "type": "array", "description": "Leave empty for any.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6", "7" ], "enumTitles": [ "carport", "attached garage", "detached garage", "off-street parking", "street parking", "valet parking", "no parking" ] } }, "catsOk": { "title": "Cats OK", "type": "boolean", "description": "Only listings marked cats ok.", "default": false }, "dogsOk": { "title": "Dogs OK", "type": "boolean", "description": "Only listings marked dogs ok.", "default": false }, "furnished": { "title": "Furnished", "type": "boolean", "description": "Only listings marked furnished.", "default": false }, "noSmoking": { "title": "No smoking", "type": "boolean", "description": "Only listings marked no smoking.", "default": false }, "wheelchairAccessible": { "title": "Wheelchair accessible", "type": "boolean", "description": "Only listings marked wheelchair accessible.", "default": false }, "airConditioning": { "title": "Air conditioning", "type": "boolean", "description": "Only listings marked air conditioning.", "default": false }, "evCharging": { "title": "EV charging", "type": "boolean", "description": "Only listings marked ev charging.", "default": false }, "noBrokerFee": { "title": "No broker fee", "type": "boolean", "description": "Only listings marked no broker fee.", "default": false }, "noApplicationFee": { "title": "No application fee", "type": "boolean", "description": "Only listings marked no application fee.", "default": false }, "employmentTypes": { "title": "Employment type", "type": "array", "description": "Leave empty for any.", "items": { "type": "string", "enum": [ "1", "2", "3", "4" ], "enumTitles": [ "full-time", "part-time", "contract", "employee's choice" ] } }, "telecommuting": { "title": "Remote OK", "type": "boolean", "description": "Only jobs that allow telecommuting.", "default": false }, "internship": { "title": "Internships", "type": "boolean", "description": "Only internships.", "default": false }, "nonprofit": { "title": "Non-profit", "type": "boolean", "description": "Only non-profit organizations.", "default": false }, "paidGigsOnly": { "title": "Paid gigs only", "type": "boolean", "description": "Only gigs marked as paid.", "default": false }, "extraSearchParams": { "title": "Other Craigslist parameters (advanced)", "type": "object", "description": "Any other Craigslist search parameter, as it appears in a search URL, e.g. {\"crypto_currency_ok\": 1} or {\"language\": [5, 6]}." }, "maxItemsPerSearch": { "title": "Max listings per search", "minimum": 1, "type": "integer", "description": "Upper limit of listings delivered per keyword and location (or search URL). Craigslist's own search stops at 360 results; this Actor reads the complete result set, so this can be in the thousands. In monitor mode, listings past this limit on the first run are remembered as seen.", "default": 100 }, "sortBy": { "title": "Sort by", "enum": [ "newest", "oldest", "price_asc", "price_desc", "distance", "best_deal" ], "type": "string", "description": "Which listings come first, and so which ones make the cut when a search has more than the max. \"Best deals\" sorts by price against comparable listings.", "default": "newest" }, "includeDetails": { "title": "Add listing details", "type": "boolean", "description": "For each delivered listing, also get its full description, every attribute (VIN, title status, condition, bathrooms, laundry...), updated date and map address. Charged per listing that gets details. In monitor mode only new and changed listings are fetched. Seller names and contact details are never collected.", "default": false }, "enrichVehicles": { "title": "Decode VINs and look up recalls", "type": "boolean", "description": "With details on, vehicles with a VIN get year, make, model, trim, engine and drivetrain from NHTSA's VIN decoder, plus open safety recalls for that model. No extra charge.", "default": true }, "dealScores": { "title": "Deal scores", "type": "boolean", "description": "Compare each listing's price with similar listings in the same search (vehicles by model year and mileage, housing by bedrooms) and rate it great, good, fair or high. Free.", "default": true }, "groupReposts": { "title": "Group reposts", "type": "boolean", "description": "Spot the same item posted more than once, by its photos, and mark every copy but the newest as a duplicate.", "default": true }, "hideReposts": { "title": "Hide reposts", "type": "boolean", "description": "Drop duplicate postings before you're charged for them. In monitor mode, also skips reposts of listings you've already seen.", "default": false }, "riskFlags": { "title": "Scam-risk flags", "type": "boolean", "description": "Flag listings priced far below comparable ones, photos reused 100+ miles apart, and (with details) phrases common in scams like wire transfers, deposits before viewing and owners out of the country.", "default": true }, "marketSnapshot": { "title": "Market snapshot", "type": "boolean", "description": "Save a summary per search to the key-value store (MARKET_SNAPSHOT): listing count, median and quartile prices, new listings in the last day and week, owner vs dealer, and median rent by bedrooms.", "default": true }, "monitorMode": { "title": "Monitor mode (new listings and changes only)", "type": "boolean", "description": "Remembers what previous runs returned and only outputs new listings, price drops and reposts. Use with a Schedule. The first run returns listings as the baseline.", "default": false }, "includeRenewed": { "title": "Include renewed listings", "type": "boolean", "description": "In monitor mode, also output listings the seller renewed (bumped to the top) since the last run.", "default": false }, "reportRemoved": { "title": "Report removed listings", "type": "boolean", "description": "In monitor mode, add a row for each listing that disappeared since the last run (sold, deleted or expired), with how many days it was listed. Charged as a listing.", "default": false }, "notifyWebhookUrl": { "title": "Send new listings to a webhook", "type": "string", "description": "Paste a Discord or Slack incoming webhook URL to get each run's listings as a message, with photo, price, deal rating and link. Any other URL gets the listings as JSON. Only sent when the run delivers something." }, "telegramBotToken": { "title": "Telegram bot token", "type": "string", "description": "Also send alerts to Telegram. Create a bot with @BotFather and paste its token here." }, "telegramChatId": { "title": "Telegram chat ID", "type": "string", "description": "The chat, group or channel ID the bot posts to." }, "notifyMinDealRating": { "title": "Only alert on deals", "enum": [ "any", "good", "great" ], "type": "string", "description": "Only send alerts for listings rated at least this good. The dataset still gets every listing.", "default": "any" }, "stateStoreName": { "title": "Monitor state store name", "type": "string", "description": "Named key-value store that keeps monitor memory between runs. Use different names to run independent monitors.", "default": "craigslist-monitor-state" }, "stateRetentionDays": { "title": "Forget listings after (days)", "minimum": 1, "type": "integer", "description": "Listings not seen for this many days are dropped from monitor memory.", "default": 30 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy is recommended.", "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 } } } } } } } } } }