{ "openapi": "3.0.1", "info": { "title": "Craigslist Scraper + Listing Change Monitor", "description": "Collect rich source-published Craigslist listing data across locations, categories, queries, and direct URLs, or track verified NEW, UPDATED, and ENDED changes.", "version": "0.3", "x-build-id": "DkSQcKXUgaCThNUTE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/luminar~craigslist-scraper-listing-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-luminar-craigslist-scraper-listing-monitor", "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/luminar~craigslist-scraper-listing-monitor/runs": { "post": { "operationId": "runs-sync-luminar-craigslist-scraper-listing-monitor", "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/luminar~craigslist-scraper-listing-monitor/run-sync": { "post": { "operationId": "run-sync-luminar-craigslist-scraper-listing-monitor", "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": { "workflow": { "title": "What do you want to do?", "enum": [ "current", "changes" ], "type": "string", "description": "Current delivers source-published listings. Changes keeps a scope-specific snapshot and delivers only NEW, UPDATED, or safely confirmed ENDED events.", "default": "current" }, "searchQueries": { "title": "Search terms", "maxItems": 20, "uniqueItems": true, "type": "array", "description": "Each term is combined with every location and category below. Leave empty to browse the category without a keyword.", "items": { "type": "string", "minLength": 1, "maxLength": 120 } }, "locations": { "title": "Craigslist locations", "maxItems": 20, "uniqueItems": true, "type": "array", "description": "Craigslist subdomain names such as newyork, sfbay, chicago, or losangeles.", "items": { "type": "string", "pattern": "^[a-z0-9-]{2,40}$" }, "default": [ "newyork" ] }, "categories": { "title": "Category codes", "maxItems": 20, "uniqueItems": true, "type": "array", "description": "Craigslist category codes such as sss (for sale), apa (apartments), or jjj (jobs).", "items": { "type": "string", "pattern": "^[a-z0-9-]{2,12}$" }, "default": [ "sss" ] }, "startUrls": { "title": "Search or listing URLs", "maxItems": 20, "type": "array", "description": "Optional existing Craigslist search or listing pages. These are added to generated targets and deduplicated.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "title": "Craigslist URL", "description": "Public Craigslist search or listing page.", "type": "string", "pattern": "^https://(?:[a-z0-9-]+\\.)?craigslist\\.org/" } } } }, "listingUrls": { "title": "Direct listing URLs", "maxItems": 100, "uniqueItems": true, "type": "array", "description": "Optional direct listing pages. No reply, email, account, or CAPTCHA route is visited.", "items": { "type": "string", "pattern": "^https://(?:[a-z0-9-]+\\.)?craigslist\\.org/", "maxLength": 500 } }, "maxItems": { "title": "Maximum delivered listings or changes", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard delivery ceiling. Current can report CAPPED with a useful prefix. Changes never commits state or emits ENDED from a capped scan.", "default": 25 }, "includeDetails": { "title": "Open each listing for full details", "type": "boolean", "description": "Adds description, published attributes, map coordinates, timestamps, and image URLs to the same listing result. It is not a separate paid result.", "default": false }, "minPrice": { "title": "Minimum price", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Minimum source search price." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Maximum source search price." }, "sellerType": { "title": "Seller type", "enum": [ "all", "owner", "dealer" ], "type": "string", "description": "Keep all sellers or request Craigslist owner/dealer results.", "default": "all" }, "onlyFreeListings": { "title": "Only free listings", "type": "boolean", "description": "Request only listings published as free.", "default": false }, "onlyWithPhotos": { "title": "Only listings with photos", "type": "boolean", "description": "Request only listings that publish at least one photo.", "default": false }, "postedToday": { "title": "Posted today", "type": "boolean", "description": "Request listings posted today.", "default": false }, "hideDuplicates": { "title": "Hide Craigslist duplicates", "type": "boolean", "description": "Ask Craigslist to bundle its duplicate listings.", "default": true }, "deliveryAvailable": { "title": "Delivery available", "type": "boolean", "description": "Request listings marked with delivery availability.", "default": false }, "postalCode": { "title": "Postal code", "maxLength": 12, "type": "string", "description": "Postal code used by the source radius search." }, "searchDistance": { "title": "Distance from postal code", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Maximum source search radius from the postal code." }, "searchNearby": { "title": "Include nearby areas", "type": "boolean", "description": "Ask Craigslist to include nearby areas.", "default": false }, "conditions": { "title": "Condition codes", "maxItems": 20, "uniqueItems": true, "type": "array", "description": "Optional Craigslist condition values. Values are passed through as source filter codes, not interpreted.", "items": { "type": "string", "maxLength": 40 } }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Minimum bedroom count sent to applicable housing searches." }, "maxBedrooms": { "title": "Maximum bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Maximum bedroom count sent to applicable housing searches." }, "minBathrooms": { "title": "Minimum bathrooms", "minimum": 0, "maximum": 20, "type": "number", "description": "Minimum bathroom count sent to applicable housing searches." }, "maxBathrooms": { "title": "Maximum bathrooms", "minimum": 0, "maximum": 20, "type": "number", "description": "Maximum bathroom count sent to applicable housing searches." }, "catsOk": { "title": "Cats allowed", "type": "boolean", "description": "Request applicable housing listings marked as allowing cats.", "default": false }, "dogsOk": { "title": "Dogs allowed", "type": "boolean", "description": "Request applicable housing listings marked as allowing dogs.", "default": false }, "sort": { "title": "Sort order", "enum": [ "date", "rel", "priceasc", "pricedsc" ], "type": "string", "description": "Craigslist source sort order.", "default": "date" }, "stateNamespace": { "title": "Monitoring scope name", "pattern": "^[A-Za-z0-9._~-]{1,64}$", "maxLength": 64, "type": "string", "description": "Stable buyer-supplied name that separates monitoring states.", "default": "default" }, "maxBuyerChargeUsd": { "title": "Maximum projected Actor charge", "minimum": 0.00001, "maximum": 1000, "type": "number", "description": "Stops before source work when the maximum event vector could exceed this ceiling. Pricing remains inactive until owner approval.", "default": 5 }, "maxRequests": { "title": "Request guard", "minimum": 1, "maximum": 2200, "type": "integer", "description": "Internal run-wide Craigslist request ceiling.", "default": 2200 }, "maxSourceBytes": { "title": "Transfer guard", "minimum": 10000, "maximum": 500000000, "type": "integer", "description": "Internal run-wide source transfer ceiling.", "default": 500000000 }, "maxRuntimeSecs": { "title": "Runtime guard", "minimum": 30, "maximum": 3600, "type": "integer", "description": "Internal source-work runtime ceiling.", "default": 3600 }, "detailConcurrency": { "title": "Detail concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Internal maximum concurrent listing-detail requests.", "default": 4 }, "_luminarQaFaultStage": { "title": "Private QA fault stage", "type": "string", "description": "Factory QA only; rejected outside the exact registered private QA Actor and immutable build." } } }, "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 } } } } } } } } } }