{ "openapi": "3.0.1", "info": { "title": "Craigslist Scraper - Housing, Jobs and Cars", "description": "Collect public Craigslist housing, jobs, cars, and other classifieds across US and international areas. Get prices, photos, listing details, and available contacts. Pay per delivered listing row plus a start fee.", "version": "0.8", "x-build-id": "5F8bzqea1lvK6pDS1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~craigslist-housing-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-craigslist-housing-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/lentic_clockss~craigslist-housing-scraper/runs": { "post": { "operationId": "runs-sync-lentic_clockss-craigslist-housing-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/lentic_clockss~craigslist-housing-scraper/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-craigslist-housing-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": { "locations": { "title": "Craigslist area slugs", "type": "array", "description": "Official Craigslist area slugs, such as phoenix, toronto, london, or sydney. Leave all targets empty for a billed example run in phoenix with up to 3 rows.", "items": { "type": "string" } }, "country": { "title": "Country code override", "type": "string", "description": "Optional Craigslist country code, such as us, ca, uk, or au; gb is accepted as uk. Leave empty to use the selected area.", "default": "" }, "lang": { "title": "Language", "type": "string", "description": "Optional language code for the selected area. Leave empty for the area default, normally en or fr for Quebec areas.", "default": "" }, "category": { "title": "Category", "enum": [ "all", "hhh", "sss", "jjj", "ggg", "bbb", "ccc", "eee", "rrr", "apa", "swp", "off", "prk", "rea", "roo", "sub", "vac", "hou", "hsw", "sha", "sbw", "act", "ats", "kid", "cls", "eve", "com", "grp", "vnn", "laf", "mis", "muc", "pet", "pol", "rnr", "rid", "vol", "aos", "bts", "cms", "cps", "crs", "cys", "evs", "fgs", "fns", "hws", "hss", "lbs", "lgs", "lss", "mas", "pas", "rts", "sks", "biz", "trv", "wet", "ata", "ppa", "ara", "sna", "pta", "ava", "baa", "bar", "haa", "bip", "bia", "bpa", "boo", "bka", "bfa", "cta", "ema", "moa", "cla", "cba", "syp", "sya", "ela", "gra", "zip", "fua", "gms", "foa", "hva", "hsa", "jwa", "maa", "mpa", "mca", "msa", "pha", "rva", "sga", "tia", "tla", "taa", "tra", "vga", "waa", "wta", "acc", "ofc", "egr", "med", "sci", "bus", "csr", "edu", "etc", "fbh", "lab", "gov", "hum", "lgl", "mnu", "mar", "hea", "npo", "rej", "ret", "sls", "spa", "sec", "trd", "sof", "sad", "tch", "trp", "tfr", "web", "wri", "cpg", "crg", "cwg", "dmg", "evg", "lbg", "tlg", "wrg", "reo", "reb" ], "type": "string", "description": "Select a Craigslist category or a whole section, such as sss for for-sale listings or jjj for jobs. The all option searches housing categories only.", "default": "apa" }, "purveyor": { "title": "Seller type", "enum": [ "", "owner", "dealer" ], "type": "string", "description": "Filter real-estate or for-sale listings by owner or broker/dealer. Leave empty for all sellers.", "default": "" }, "query": { "title": "Keyword query", "type": "string", "description": "Optional search words. They are sent as entered, without automatic translation." }, "minPrice": { "title": "Minimum price", "type": "integer", "description": "Lowest asking price or rent to include, in the selected market currency." }, "maxPrice": { "title": "Maximum price", "type": "integer", "description": "Highest asking price or rent to include, in the selected market currency." }, "minBedrooms": { "title": "Minimum bedrooms", "type": "integer", "description": "Minimum number of bedrooms for a housing search." }, "maxBedrooms": { "title": "Maximum bedrooms", "type": "integer", "description": "Maximum number of bedrooms for a housing search." }, "minBathrooms": { "title": "Minimum bathrooms", "type": "integer", "description": "Minimum number of bathrooms for a housing search." }, "maxBathrooms": { "title": "Maximum bathrooms", "type": "integer", "description": "Maximum number of bathrooms for a housing search." }, "minSqft": { "title": "Minimum sqft", "type": "integer", "description": "Minimum housing floor area in square feet." }, "maxSqft": { "title": "Maximum sqft", "type": "integer", "description": "Maximum housing floor area in square feet." }, "housingType": { "title": "Housing type", "type": "integer", "description": "Housing type code: 1 apartment, 2 condo, 3 cottage/cabin, 4 duplex, 5 flat, 6 house, 7 in-law, 8 loft, 9 land, 10 manufactured, 11 townhouse, or 12 assisted living." }, "laundry": { "title": "Laundry", "type": "integer", "description": "Laundry code: 1 washer/dryer in unit, 2 hookups, 3 laundry in building, 4 laundry on site, or 5 no laundry on site." }, "parking": { "title": "Parking", "type": "integer", "description": "Parking code: 1 carport, 2 attached garage, 3 detached garage, 4 off-street, 5 street, 6 valet, or 7 no parking." }, "catsOk": { "title": "Cats OK", "type": "boolean", "description": "Only housing listings that allow cats.", "default": false }, "dogsOk": { "title": "Dogs OK", "type": "boolean", "description": "Only housing listings that allow dogs.", "default": false }, "furnished": { "title": "Furnished", "type": "boolean", "description": "Only furnished housing listings.", "default": false }, "noSmoking": { "title": "No smoking", "type": "boolean", "description": "Only housing listings marked no smoking.", "default": false }, "wheelchairAccessible": { "title": "Wheelchair accessible", "type": "boolean", "description": "Only housing listings marked wheelchair accessible.", "default": false }, "evCharging": { "title": "EV charging", "type": "boolean", "description": "Only housing listings with electric-vehicle charging.", "default": false }, "airConditioning": { "title": "Air conditioning", "type": "boolean", "description": "Only housing listings with air conditioning.", "default": false }, "privateRoom": { "title": "Private room", "type": "boolean", "description": "Only room listings with a private room.", "default": false }, "privateBath": { "title": "Private bath", "type": "boolean", "description": "Only room listings with a private bathroom.", "default": false }, "hasPic": { "title": "Only listings with photos", "type": "boolean", "description": "Filter search results to postings that have at least one photo.", "default": false }, "postedToday": { "title": "Only posted today", "type": "boolean", "description": "Filter search results to postings published today.", "default": false }, "searchNearby": { "title": "Include nearby areas", "type": "boolean", "description": "Include nearby Craigslist areas in a search.", "default": false }, "postal": { "title": "Postal / ZIP", "type": "string", "description": "Optional postal or ZIP code for a nearby search." }, "searchDistance": { "title": "Search distance", "type": "integer", "description": "Distance for a nearby search, using the distance units shown by Craigslist for the selected market." }, "bundleDuplicates": { "title": "Bundle duplicates", "type": "boolean", "description": "Ask Craigslist to group duplicate search postings.", "default": false }, "saleDate": { "title": "Event sale date", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Event calendar date to search, in YYYY-MM-DD format." }, "sort": { "title": "Sort order", "enum": [ "date", "dateoldest", "priceasc", "pricedsc" ], "type": "string", "description": "Order search rows by newest, oldest, lowest price, or highest price. Additional searches for larger requests may affect the final row order.", "default": "date" }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Craigslist search or listing URLs, including recognized international domains. Search URLs supply their area, category, and filters; when provided, they take precedence over locations and coordinates.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxResults": { "title": "Max results per input", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Maximum delivered and charged rows per Craigslist area or start URL, from 1 to 2,000; default 70. The run charge limit applies across all inputs; Free-plan runs also have a 200-row total cap and a 10-run allowance for this Actor.", "default": 70 }, "scrapeDetails": { "title": "Enrich from detail pages", "type": "boolean", "description": "Include listing text, housing attributes, photos, and available public contact or address details; enabled by default. Contact fields may remain empty when information is missing or access is restricted.", "default": true }, "readReplyOptions": { "title": "Read reply options", "type": "boolean", "description": "Also read which reply channels (email, phone, chat, text) the poster enabled. Adds up to 4 requests per listing and usually returns no contact values, because those stay behind a human check. Disabled by default.", "default": false }, "maxDetailConcurrency": { "title": "Detail-page concurrency", "minimum": 1, "maximum": 15, "type": "integer", "description": "Number of listing detail requests to make at once, from 1 to 15. Lower values reduce simultaneous requests.", "default": 5 }, "imageSize": { "title": "Search image size", "enum": [ "300x300", "600x450", "1200x900" ], "type": "string", "description": "Preferred size for search-result photo URLs: 300x300, 600x450, or 1200x900.", "default": "600x450" }, "requestDelayMillis": { "title": "Delay between requests (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Minimum spacing between applicable requests in milliseconds, from 0 to 10,000. Higher values slow collection.", "default": 250 }, "workerBaseUrl": { "title": "Developer test setting", "type": "string", "description": "Leave empty. Used only by the developer for testing.", "default": "" }, "discoveryMode": { "title": "Discovery mode", "enum": [ "search", "sitemap" ], "type": "string", "description": "Choose search for normal listing searches or sitemap for dated listing discovery. Sitemap discovery needs at least one area in locations and does not apply normal keyword, price, or amenity filters.", "default": "search" }, "sitemapDate": { "title": "Sitemap date", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Date for sitemap discovery in YYYY-MM-DD format. Leave empty for the newest day the sitemap lists." }, "sitemapIndexes": { "title": "Sitemap indexes", "type": "array", "description": "Optional sitemap index identifiers from 00 to 29. Leave empty to use the available indexes.", "items": { "type": "string", "pattern": "^\\d{2}$" } }, "proxyDetails": { "title": "Developer detail setting", "type": "boolean", "description": "Leave at its default. Used only by the developer for testing.", "default": false }, "lat": { "title": "Latitude", "type": "number", "description": "Latitude to use with longitude to select a Craigslist area. Leave locations and startUrls empty when using coordinates." }, "lon": { "title": "Longitude", "type": "number", "description": "Longitude to use with latitude to select a Craigslist area. Both coordinates are required for this input mode." } } }, "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 } } } } } } } } } }