{ "openapi": "3.0.1", "info": { "title": "Craigslist Scraper - Listings, Classifieds & Leads", "description": "Scrape Craigslist postings from any US city & category - housing, real estate, for-sale, services, gigs & jobs: title, price, beds/baths/sqft, attributes, body, geo, photos, dates, plus phone/email leads from the post body. New-post monitoring. No login, key or browser.", "version": "0.1", "x-build-id": "ez2r7CF31fVUie6DR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapesage~craigslist-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapesage-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/scrapesage~craigslist-scraper/runs": { "post": { "operationId": "runs-sync-scrapesage-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/scrapesage~craigslist-scraper/run-sync": { "post": { "operationId": "run-sync-scrapesage-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": { "sites": { "title": "Sites (Craigslist cities)", "type": "array", "description": "Craigslist sites to scrape — the subdomain (e.g. `austin`, `sfbay`, `newyork`, `losangeles`) or a metro name (e.g. `Austin`, `New York`, `San Francisco`). Each site is scraped for every selected category. Required unless you use Start URLs.", "items": { "type": "string" } }, "categories": { "title": "Categories", "type": "array", "description": "Craigslist categories to scrape in each site. You can also type any raw 3-letter Craigslist code (e.g. `apa`, `rea`, `cto`, `bbb`).", "items": { "type": "string", "enum": [ "apartments", "rooms-shares", "real-estate-for-sale", "housing-all", "for-sale-all", "cars-trucks", "furniture", "electronics", "free-stuff", "services-all", "skilled-trades", "computer-services", "creative-services", "labor-moving", "real-estate-services", "jobs-all", "gigs-all", "labor-gigs", "creative-gigs", "community-all" ], "enumTitles": [ "Apartments / housing for rent", "Rooms & shares", "Real estate - for sale", "Housing (all)", "For sale (all)", "Cars & trucks", "Furniture", "Electronics", "Free stuff", "Services (all)", "Skilled trades services", "Computer services", "Creative services", "Labor & moving services", "Real estate services", "Jobs (all)", "Gigs (all)", "Labor gigs", "Creative gigs", "Community (all)" ] }, "default": [ "apartments" ] }, "keywords": { "title": "Keywords (optional)", "type": "array", "description": "Optional search terms. Each keyword is run against every site × category. Leave empty to browse the whole category.", "items": { "type": "string" } }, "startUrls": { "title": "Start URLs (Craigslist pages)", "type": "array", "description": "Optional. Paste Craigslist search URLs (`https://austin.craigslist.org/search/apa?query=loft&max_price=2000`) or individual post URLs (`.../apa/d//.html`). Processed in addition to the sites above.", "items": { "type": "string" } }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Keep only postings priced at least this much. Leave empty for no filter." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Keep only postings priced at most this much. Leave empty for no filter." }, "minBedrooms": { "title": "Minimum bedrooms (housing)", "minimum": 0, "maximum": 8, "type": "integer", "description": "Housing only — minimum number of bedrooms. Leave empty for no filter." }, "maxBedrooms": { "title": "Maximum bedrooms (housing)", "minimum": 0, "maximum": 8, "type": "integer", "description": "Housing only — maximum number of bedrooms. Leave empty for no filter." }, "hasImage": { "title": "Has image only", "type": "boolean", "description": "Keep only postings that include at least one photo.", "default": false }, "postedTodayOnly": { "title": "Posted today only", "type": "boolean", "description": "Keep only postings made today.", "default": false }, "titleOnly": { "title": "Match keywords in title only", "type": "boolean", "description": "Search keywords against the post title only (not the body).", "default": false }, "searchNearby": { "title": "Include nearby areas", "type": "boolean", "description": "Also include results from Craigslist areas near the selected site.", "default": false }, "maxResultsPerSearch": { "title": "Max postings per search", "minimum": 1, "maximum": 360, "type": "integer", "description": "Cap per site × category × keyword. Craigslist's API returns at most ~360 results per query — narrow with keywords, price or a sub-category for deeper coverage.", "default": 120 }, "maxResults": { "title": "Max postings (whole run)", "minimum": 1, "maximum": 200000, "type": "integer", "description": "Global cap on the total number of postings emitted in this run.", "default": 300 }, "includePostDetails": { "title": "Include full post details", "type": "boolean", "description": "Open each post page for the full body text, all attributes (beds/baths/sqft/housing type/laundry/parking/pets/condition/make/model…), posted/updated dates, map address and — the lead wedge — the phone numbers and emails left in the post body. Turn off for a faster, list-only run (title, price, geo, photos, beds/sqft).", "default": true }, "deduplicatePostings": { "title": "Deduplicate postings", "type": "boolean", "description": "Emit each post only once per run (keyed by Craigslist post id), even across categories and keywords.", "default": true }, "monitorMode": { "title": "Monitoring mode — only new postings", "type": "boolean", "description": "Remember postings already returned and emit ONLY posts not seen in previous runs. Perfect for time-sensitive feeds (new FSBO listings, new gigs, new service posts). Pairs with Apify Schedules.", "default": false }, "monitorStoreName": { "title": "Monitor store name", "type": "string", "description": "Named key-value store that holds the 'already seen' post ids for monitoring mode. Use a different name per tracked feed to keep histories separate.", "default": "craigslist-monitor" }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 12, "type": "integer", "description": "Maximum parallel requests. Keep it moderate — Craigslist rate-limits aggressively per IP.", "default": 4 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Craigslist serves clean pages to US datacenter IPs but rate-limits per IP, so the default Apify proxy (with automatic fresh-session rotation) is recommended; switch to residential for very large or high-frequency runs.", "default": { "useApifyProxy": true, "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }