{ "openapi": "3.0.1", "info": { "title": "Craigslist Scraper: Contacts & Change Monitoring", "description": "Search Craigslist across cities and categories, extract full listing details and public contacts, monitor new or changed posts, and generate price and inventory analytics.", "version": "0.0", "x-build-id": "gfSPtl6MTb9wggCFw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapingmonkey~craigslist-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapingmonkey-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/scrapingmonkey~craigslist-scraper/runs": { "post": { "operationId": "runs-sync-scrapingmonkey-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/scrapingmonkey~craigslist-scraper/run-sync": { "post": { "operationId": "run-sync-scrapingmonkey-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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "searchAndDetails", "details", "monitor", "analytics" ], "type": "string", "description": "Search returns fast summaries. Search + details opens every listing. Details accepts posting URLs. Monitor returns new or changed listings. Analytics adds a market summary.", "default": "search" }, "searchTerms": { "title": "Search terms", "maxItems": 100, "type": "array", "description": "Keywords or phrases. Leave an empty string out and use a category URL when you want an unfiltered category browse.", "items": { "type": "string" }, "default": [ "mountain bike" ] }, "regions": { "title": "Craigslist regions", "maxItems": 100, "type": "array", "description": "Region hostnames such as sfbay, newyork, london, tokyo, or manila. Multiple regions are combined with every term and category.", "items": { "type": "string" }, "default": [ "sfbay" ] }, "categories": { "title": "Category codes", "maxItems": 100, "type": "array", "description": "Three-character Craigslist category abbreviations such as sss, cta, apa, jjj, ggg, or bbb.", "items": { "type": "string" }, "default": [ "sss" ] }, "startUrls": { "title": "Craigslist search or posting URLs", "maxItems": 100, "type": "array", "description": "Optional current or legacy Craigslist search and posting URLs. Search URL parameters are preserved. Mixed lists are supported outside Details mode.", "items": { "type": "string" } }, "listingUrls": { "title": "Posting URLs", "maxItems": 100, "type": "array", "description": "Direct Craigslist posting URLs for Details mode or additional detail records in another mode.", "items": { "type": "string" } }, "maxResults": { "title": "Results per search", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum listings returned for every independent term × region × category or search URL.", "default": 50 }, "maxItems": { "title": "Global listing limit", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Maximum deduplicated listing rows across the whole run. Use 0 for unlimited. Analytics and diagnostic rows are additional.", "default": 0 }, "maxConcurrency": { "title": "Maximum concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Independent searches and detail pages processed in parallel.", "default": 5 }, "maxRequestRetries": { "title": "Request retries", "minimum": 1, "maximum": 10, "type": "integer", "description": "Retry attempts for rate limits, temporary server failures, proxy failures, and timeouts. The proxy session rotates after retryable failures.", "default": 4 }, "country": { "title": "Request country", "minLength": 2, "maxLength": 2, "type": "string", "description": "Two-letter locale country sent to Craigslist, such as US, GB, CA, JP, or PH. Listing prices still follow the selected Craigslist region.", "default": "US" }, "language": { "title": "Language", "type": "string", "description": "Craigslist interface language or locale such as en, de, fr, ja, or en-GB.", "default": "en" }, "sort": { "title": "Sort", "enum": [ "date", "rel", "priceasc", "pricedsc", "dateoldest", "dist" ], "type": "string", "description": "Sort every friendly search by newest, relevant, price, oldest, or distance.", "default": "date" }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "number", "description": "Minimum listing price. Applied to Craigslist and verified again before output." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "number", "description": "Maximum listing price. Applied to Craigslist and verified again before output." }, "condition": { "title": "Condition codes", "maxItems": 6, "type": "array", "description": "Craigslist condition values: 10 new, 20 like new, 30 excellent, 40 good, 50 fair, 60 salvage.", "items": { "type": "string" } }, "sellerType": { "title": "Seller type", "enum": [ "all", "owner", "dealer" ], "type": "string", "description": "All listings, owner listings, or dealer listings.", "default": "all" }, "hasImage": { "title": "Require an image", "type": "boolean", "description": "Ask Craigslist to return listings that contain at least one image.", "default": false }, "postedToday": { "title": "Posted today", "type": "boolean", "description": "Keep Craigslist results posted today.", "default": false }, "hideDuplicates": { "title": "Hide Craigslist duplicate bundles", "type": "boolean", "description": "Ask Craigslist to hide bundled duplicate postings. Actor-level ID deduplication remains enabled separately.", "default": true }, "deliveryAvailable": { "title": "Delivery available", "type": "boolean", "description": "Keep listings marked as offering delivery where the selected category supports it.", "default": false }, "titlesOnly": { "title": "Search titles only", "type": "boolean", "description": "Match the keyword against listing titles instead of the full Craigslist search index.", "default": false }, "postalCode": { "title": "Postal code", "type": "string", "description": "Center for a radius search. Provide Search distance too." }, "searchDistance": { "title": "Search distance", "minimum": 0, "type": "number", "description": "Radius around Postal code in the Craigslist region's native distance units." }, "filters": { "title": "Advanced native filters", "type": "object", "description": "Native Craigslist query parameters as JSON. Values may be strings, numbers, booleans, or arrays for repeated parameters, for example {\"min_auto_year\": 2018, \"auto_transmission\": [1, 2]}.", "default": {}, "additionalProperties": true }, "maxAgeDays": { "title": "Maximum listing age in days", "minimum": 0, "type": "number", "description": "Discard listings older than this many days after decoding the exact posting timestamp." }, "includeImages": { "title": "Include image URLs", "type": "boolean", "description": "Return full 600×450 Craigslist image URLs and image counts.", "default": true }, "includePublicContacts": { "title": "Extract public contacts", "type": "boolean", "description": "Extract only phone numbers and email addresses written publicly in the listing body. The anonymized reply-email challenge is never opened.", "default": true }, "onlyWithPrice": { "title": "Only listings with a price", "type": "boolean", "description": "Discard listings without a numeric price before storage and billing.", "default": false }, "onlyWithImages": { "title": "Only listings with images", "type": "boolean", "description": "Discard listings without images before storage and billing.", "default": false }, "deduplicate": { "title": "Deduplicate listings", "type": "boolean", "description": "Keep one record per Craigslist posting across overlapping terms, categories, regions, and input URLs.", "default": true }, "includeAnalytics": { "title": "Add market analytics", "type": "boolean", "description": "Add one analytics row with listing, price, contact, region, category, status, and attribute statistics.", "default": false }, "analyticsOnly": { "title": "Store only analytics", "type": "boolean", "description": "Use the scraped listings to calculate analytics but omit individual listing rows. Diagnostics remain visible and uncharged.", "default": false }, "monitorMode": { "title": "Monitor behavior", "enum": [ "changes", "newListings" ], "type": "string", "description": "Return only never-seen listings or both new listings and changes to price, content, images, contacts, attributes, or availability.", "default": "changes" }, "monitorKey": { "title": "Monitor key", "type": "string", "description": "Stable name that identifies this monitor's persistent state across scheduled runs.", "default": "craigslist-monitor" }, "monitorIncludeDetails": { "title": "Enrich details while monitoring", "type": "boolean", "description": "Open every discovered posting so changes to descriptions, contacts, attributes, and status can be detected. Leave off for cheaper price-only monitoring.", "default": 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 } } } } } } } } } }