{ "openapi": "3.0.1", "info": { "title": "Craigslist Scraper: Search URLs, Cars, Housing & Deals", "description": "Extract Craigslist listings, vehicle VINs, seller phones/emails, apartments, and high-res photos across 50+ US metros. Zero compute fees with Pay-Per-Event billing.", "version": "1.0", "x-build-id": "7tYC5Aqvoqa6FDfxS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scraperpro~craigslist-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scraperpro-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/scraperpro~craigslist-scraper/runs": { "post": { "operationId": "runs-sync-scraperpro-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/scraperpro~craigslist-scraper/run-sync": { "post": { "operationId": "run-sync-scraperpro-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 (Search, Category, or Listing URLs)", "type": "array", "description": "List of Craigslist search, category, or direct listing URLs (e.g. https://losangeles.craigslist.org/search/cta?query=tacoma).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchUrl": { "title": "Search or Listing URL", "type": "string", "description": "Single Craigslist search or direct listing URL to scrape." }, "searchQuery": { "title": "Search Keyword", "type": "string", "description": "Keyword to search for (e.g., 'honda civic', 'macbook pro', 'leather sofa')." }, "category": { "title": "Category", "enum": [ "cta", "cto", "ctd", "apa", "rea", "roo", "sub", "sss", "ela", "fua", "app", "mca", "bka", "zip" ], "type": "string", "description": "Craigslist category code.", "default": "cta" }, "subdomain": { "title": "Metro Area / Region", "enum": [ "losangeles", "newyork", "sfbay", "chicago", "houston", "dallas", "miami", "seattle", "atlanta", "phoenix", "denver", "boston", "sandiego", "austin", "lasvegas", "portland", "orlando", "tampa", "minneapolis", "detroit", "philadelphia", "charlotte", "raleigh", "nashville", "sacramento", "saltlakecity", "columbus", "cleveland", "pittsburgh", "stlouis", "kansascity", "indianapolis", "cincinnati", "milwaukee", "sanantonio", "jacksonville", "memphis", "richmond", "baltimore", "honolulu", "anchorage", "albuquerque", "tucson", "fresno", "tulsa", "oklahomacity", "omaha", "louisville", "neworleans", "birmingham" ], "type": "string", "description": "Select from top 50 US metros, or paste any specific Craigslist search URL into \"Search or Listing URL\" to target any other region worldwide.", "default": "losangeles" }, "minPrice": { "title": "Minimum Price ($)", "minimum": 0, "type": "integer", "description": "Minimum listing price in USD." }, "maxPrice": { "title": "Maximum Price ($)", "minimum": 0, "type": "integer", "description": "Maximum listing price in USD." }, "purveyor": { "title": "Seller Type", "enum": [ "all", "owner", "dealer" ], "type": "string", "description": "Filter by owner or dealer.", "default": "all" }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of listings to extract.", "default": 50 }, "offset": { "title": "Result Offset (Skip Items)", "minimum": 0, "type": "integer", "description": "Number of initial listings to skip for pagination or bookmarking (e.g., 120, 240, 360).", "default": 0 }, "scrapeDetails": { "title": "Scrape Deep Details", "type": "boolean", "description": "When enabled, fetches full listing HTML to extract vehicle attributes (VIN, mileage, year, transmission), full descriptions, exact coordinates, and high-res photos.", "default": true }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum simultaneous detail requests.", "default": 5 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Apify residential proxies are recommended to avoid Craigslist rate limits.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }