{ "openapi": "3.0.1", "info": { "title": "Craigslist Scraper", "description": "Scrape Craigslist listings across all categories and cities. Search for-sale items, housing, jobs, services. Returns prices, descriptions, locations.", "version": "1.0", "x-build-id": "qyKtEiKxTke59pYV0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lulzasaur~craigslist-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lulzasaur-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/lulzasaur~craigslist-scraper/runs": { "post": { "operationId": "runs-sync-lulzasaur-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/lulzasaur~craigslist-scraper/run-sync": { "post": { "operationId": "run-sync-lulzasaur-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", "required": [ "searchQueries" ], "properties": { "searchQueries": { "title": "Search Queries", "type": "array", "description": "List of search terms to scrape (e.g., 'bicycle', 'iPhone 15', 'couch'). Each query will produce a separate set of results.", "default": [ "bicycle" ], "items": { "type": "string" } }, "city": { "title": "City Subdomain", "type": "string", "description": "Craigslist city subdomain (e.g., 'newyork', 'sfbay', 'chicago', 'losangeles', 'seattle', 'boston', 'austin', 'denver', 'portland', 'miami'). This is the subdomain used in the URL: {city}.craigslist.org", "default": "newyork" }, "category": { "title": "Category Code", "type": "string", "description": "Craigslist category code for search. Common codes: 'sss' (all for sale), 'cta' (cars+trucks), 'moa' (furniture), 'ela' (electronics), 'bia' (bikes), 'bka' (books), 'cla' (clothing), 'taa' (toys+games).", "default": "sss" }, "maxListings": { "title": "Max Listings per Query", "minimum": 0, "type": "integer", "description": "Maximum number of listings to scrape per search query. Set to 0 for unlimited. Craigslist typically returns up to 300+ results per search page.", "default": 100 }, "scrapeDetails": { "title": "Scrape Full Details", "type": "boolean", "description": "If enabled, visits each listing page to get full description, all photos, price, location coordinates, item attributes (condition, make, model), post date, and post ID. Slower but much richer data. If disabled, only scrapes search result data (title, URL, thumbnail).", "default": false }, "minPrice": { "title": "Min Price ($)", "minimum": 0, "type": "integer", "description": "Minimum price filter in dollars. Only listings at or above this price will appear." }, "maxPrice": { "title": "Max Price ($)", "minimum": 0, "type": "integer", "description": "Maximum price filter in dollars. Only listings at or below this price will appear." }, "sortBy": { "title": "Sort By", "enum": [ "", "newest", "price_asc", "price_desc", "relevant" ], "type": "string", "description": "How to sort search results.", "default": "" }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings. Not required for basic Craigslist scraping but recommended for large-scale runs to avoid rate limiting.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }