{ "openapi": "3.0.1", "info": { "title": "Craigslist Scraper - Housing, For Sale, Jobs, Cars in Any City", "description": "Scrape Craigslist search results in any city: apartments, for sale, cars, jobs, gigs, services. Title, price, neighborhood, map coordinates, post date, photos; optional full description and attributes (bedrooms, sqft, make, model, odometer). Keyword, price and date filters. Half the usual price.", "version": "0.1", "x-build-id": "xlOG21iO528rlHdLD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/unbrowseai~craigslist-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-unbrowseai-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/unbrowseai~craigslist-scraper/runs": { "post": { "operationId": "runs-sync-unbrowseai-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/unbrowseai~craigslist-scraper/run-sync": { "post": { "operationId": "run-sync-unbrowseai-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": { "cities": { "title": "Cities", "type": "array", "description": "Craigslist sites to search: the subdomain (austin, sfbay, newyork, losangeles, chicago, seattle) or the site name (Austin, SF bay area). Add a subarea with a slash, e.g. sfbay/sfc or newyork/brk. 700+ sites worldwide are supported.", "items": { "type": "string" } }, "category": { "title": "Category", "enum": [ "sss", "cta", "cto", "ctd", "mca", "rva", "boo", "pta", "fua", "ela", "sya", "moa", "ppa", "hsa", "tla", "bia", "sga", "cla", "jwa", "taa", "vga", "pha", "msa", "baa", "ara", "bka", "maa", "gra", "tia", "zip", "gms", "hhh", "apa", "roo", "sub", "rea", "vac", "off", "prk", "swp", "jjj", "sof", "web", "acc", "ofc", "hea", "fbh", "ret", "trd", "trp", "lab", "sls", "mar", "edu", "ggg", "cpg", "crg", "lbg", "dmg", "evg", "wrg", "tlg", "bbb", "ccc", "eee", "rrr" ], "type": "string", "description": "What to search. For any other category, paste a Craigslist search URL below.", "default": "sss" }, "searchQuery": { "title": "Keyword", "type": "string", "description": "Optional search words, as in the Craigslist search box (e.g. \"honda civic\", \"studio\", \"react developer\")." }, "titleOnly": { "title": "Search titles only", "type": "boolean", "description": "Match the keyword in post titles only.", "default": false }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Minimum price in the site currency." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Maximum price in the site currency." }, "postedToday": { "title": "Posted today", "type": "boolean", "description": "Only posts from today.", "default": false }, "hasImage": { "title": "Has image", "type": "boolean", "description": "Only posts with at least one photo.", "default": false }, "condition": { "title": "Condition (for sale)", "type": "array", "description": "For-sale items only: keep these conditions.", "items": { "type": "string", "enum": [ "new", "like-new", "excellent", "good", "fair", "salvage" ], "enumTitles": [ "New", "Like new", "Excellent", "Good", "Fair", "Salvage" ] } }, "postal": { "title": "ZIP / postal code", "type": "string", "description": "Optional. Search around this ZIP code (use with Search radius)." }, "searchDistance": { "title": "Search radius (miles)", "minimum": 1, "maximum": 500, "type": "integer", "description": "Distance from the ZIP code, in miles (km outside the US)." }, "sort": { "title": "Sort", "enum": [ "date", "rel", "priceasc", "pricedsc", "dateoldest" ], "type": "string", "description": "Order of results.", "default": "date" }, "maxResults": { "title": "Max posts per search", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many posts for each city (or search URL). The whole search is available, not just the first page.", "default": 100 }, "includeDetails": { "title": "Include post details", "type": "boolean", "description": "Open every post for the full description, all attributes (bedrooms, bathrooms, sqft, housing type, laundry, parking, make and model, odometer, condition, VIN, employment type...), street address, precise map location, all photos and the updated date. Slower.", "default": false }, "startUrls": { "title": "Craigslist search URLs", "type": "array", "description": "Optional. Craigslist search result URLs with your filters already set, e.g. https://austin.craigslist.org/search/apa?min_bedrooms=2. The filters above do not apply to these.", "default": [], "items": { "type": "string" } } } }, "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 } } } } } } } } } }