{ "openapi": "3.0.1", "info": { "title": "Craigslist Scraper — Listings, Prices & New Post Alerts", "description": "Returns Craigslist listings from any search URL or city + category: title, price, location, coordinates, posted date, images, bedrooms / sqft, job pay, category; optional full description and attributes. Multi-city ('all US'), filters, and new-post monitoring.", "version": "0.1", "x-build-id": "OVo7DsBSx7FiD267a" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tortuga~craigslist-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tortuga-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/tortuga~craigslist-scraper/runs": { "post": { "operationId": "runs-sync-tortuga-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/tortuga~craigslist-scraper/run-sync": { "post": { "operationId": "run-sync-tortuga-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", "type": "array", "description": "Craigslist search pages with any filters set in the browser, e.g. https://sfbay.craigslist.org/search/sss?query=bike&min_price=100 (any site, subarea such as /search/eby/apa, or category). A posting URL (https://www.craigslist.org/view/d/…) returns that one posting with full details. Clear this field if you use Sites + Category instead.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "sites": { "title": "Sites (cities)", "type": "array", "description": "Instead of Start URLs: Craigslist sites to search with the category and filters below, i.e. the subdomain of https://.craigslist.org, e.g. sfbay, newyork, losangeles, chicago, seattle. Use 'sfbay/eby' for a subarea, or 'all US' (413 sites), 'all CA', 'all GB' for every site in a country.", "items": { "type": "string" } }, "category": { "title": "Category", "enum": [ "sss", "hhh", "jjj", "cta", "apa", "ggg", "bbb", "ccc", "roo", "rea", "fua", "ela", "mca", "bia", "zip", "sub", "boo", "rva", "tla", "eee" ], "type": "string", "description": "Used with Sites. For any other category, paste its search URL into Start URLs (the code after /search/, e.g. /search/ppa = appliances).", "default": "sss" }, "searchQuery": { "title": "Search query", "type": "string", "description": "Keywords, as typed into Craigslist's search box, e.g. \"road bike\", \"2 bedroom\", \"forklift\". Craigslist operators work: -word excludes, \"exact phrase\", word1|word2." }, "searchTitlesOnly": { "title": "Search titles only", "type": "boolean", "description": "Match the query against posting titles only (Craigslist's 'search titles only').", "default": false }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Used with Sites. In the site's currency (USD in the US)." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Used with Sites." }, "postedToday": { "title": "Posted today", "type": "boolean", "description": "Only postings from today.", "default": false }, "hasImage": { "title": "Has image", "type": "boolean", "description": "Only postings with at least one photo.", "default": false }, "bundleDuplicates": { "title": "Bundle duplicates", "type": "boolean", "description": "Let Craigslist hide near-identical reposts (its 'bundle duplicates' option).", "default": false }, "sellerType": { "title": "Seller", "enum": [ "", "owner", "dealer" ], "type": "string", "description": "For-sale categories: by owner or by dealer only.", "default": "" }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "type": "integer", "description": "Housing categories." }, "maxBedrooms": { "title": "Max bedrooms", "minimum": 0, "type": "integer", "description": "Housing categories." }, "minSqft": { "title": "Min square feet", "minimum": 0, "type": "integer", "description": "Housing categories." }, "maxSqft": { "title": "Max square feet", "minimum": 0, "type": "integer", "description": "Housing categories." }, "postalCode": { "title": "ZIP / postal code", "type": "string", "description": "Search around a ZIP code instead of the whole site (use with Distance). A large distance (up to 1000 miles) searches across neighbouring sites in one request." }, "searchDistance": { "title": "Distance (miles)", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Radius around the ZIP / postal code in miles (1-1000)." }, "sort": { "title": "Sort", "enum": [ "date", "rel", "priceasc", "pricedsc", "dateoldest" ], "type": "string", "description": "Used with Sites (start URLs keep their own sort). 'Newest first' is the right choice for monitoring and complete crawls.", "default": "date" }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Stop after this many postings in total (across all searches and sites). Craigslist returns at most 10,000 postings per search; split bigger searches by subarea or price range.", "default": 100 }, "maxItemsPerSearch": { "title": "Max items per search / site", "minimum": 1, "type": "integer", "description": "Optional cap per search URL or site, so a multi-city run (e.g. 'all US') spreads Max items over many cities instead of filling up from the first ones." }, "includeDetails": { "title": "Include posting details", "type": "boolean", "description": "Also open every posting page for the full description, all attributes (condition, make / model, VIN, odometer, employment type, rent period, laundry, parking...), bathrooms, first posted and updated dates, city / ZIP, and the street address for rental and job posts. One extra request per posting, charged extra (see pricing).", "default": false }, "onlyNewOrChanged": { "title": "Only new or changed items", "type": "boolean", "description": "Remember what earlier runs of this search returned and output only new items or items whose price/status changed. Use with a Schedule; unchanged items are not charged. Here: new postings, and postings whose price or job pay changed. Max items is the number of newest postings checked per run.", "default": false }, "monitoringKey": { "title": "Monitoring key", "type": "string", "description": "Name for this watch, so several schedules on the same search stay separate; defaults to a key derived from the search input" }, "skipRenewals": { "title": "Skip renewed older posts", "type": "boolean", "description": "Monitoring only. Craigslist lets posters renew a listing, which moves an older posting back to the top. With this on, such postings are not output (they are remembered and not charged), so alerts contain brand-new posts only. Off: they are output with isRenewal: true." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy (datacenter) works for Craigslist and is the default; each request goes out from a fresh IP. Switch to the RESIDENTIAL group only if a run logs many blocked (403) requests.", "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 } } } } } } } } } }