{ "openapi": "3.0.1", "info": { "title": "Craigslist Scraper & New Listings Monitor", "description": "Search Craigslist across many cities or a whole country in one run: for sale, cars, housing, jobs, gigs and services. Get price, location with GPS, photos and full description. Gets past the 360-result limit, and monitor mode returns only new listings.", "version": "1.0", "x-build-id": "6Q4A0y7WNaXKgkokC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datapulse-labs~craigslist-scraper-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datapulse-labs-craigslist-scraper-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/datapulse-labs~craigslist-scraper-monitor/runs": { "post": { "operationId": "runs-sync-datapulse-labs-craigslist-scraper-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/datapulse-labs~craigslist-scraper-monitor/run-sync": { "post": { "operationId": "run-sync-datapulse-labs-craigslist-scraper-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": { "locations": { "title": "Locations", "type": "array", "description": "City names (\"new york\", \"los angeles\"), Craigslist subdomains (\"sfbay\") or a 2-letter country code (\"US\", \"CA\", \"GB\") to search every city in that country.", "items": { "type": "string" } }, "category": { "title": "Category", "enum": [ "sss", "cta", "mca", "boo", "bik", "fua", "ela", "sya", "mob", "vga", "app", "tls", "msa", "clo", "spo", "ata", "zip", "hhh", "apa", "roo", "sub", "rea", "jjj", "ggg", "bbb", "ccc", "eee" ], "type": "string", "description": "What to search.", "default": "sss" }, "query": { "title": "Search keywords", "type": "string", "description": "Optional, e.g. \"iphone 15\", \"road bike\", \"2 bedroom\"." }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Optional minimum price." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Optional maximum price." }, "postedToday": { "title": "Posted today only", "type": "boolean", "description": "Only listings posted today.", "default": false }, "hasPic": { "title": "Has photos", "type": "boolean", "description": "Only listings with photos.", "default": false }, "titlesOnly": { "title": "Search titles only", "type": "boolean", "description": "Match keywords in the title only.", "default": false }, "searchUrls": { "title": "Craigslist search URLs (optional)", "type": "array", "description": "Paste search URLs copied from your browser, with all filters, e.g. https://newyork.craigslist.org/search/apa?min_price=1500&max_price=3000. They are scraped as-is, in addition to the locations above.", "items": { "type": "string" } }, "getAllResults": { "title": "Get all results (beyond 360)", "type": "boolean", "description": "Craigslist returns max 360 results per search. When on, the Actor splits the search by price ranges to collect everything.", "default": false }, "includeDetails": { "title": "Include full description & attributes", "type": "boolean", "description": "Opens each listing for the description, attributes (condition, make, model, size...) and all photos in high resolution. Slower.", "default": false }, "maxItems": { "title": "Max listings", "minimum": 1, "type": "integer", "description": "Stop after this many listings in total.", "default": 500 }, "maxItemsPerSearch": { "title": "Max listings per location", "minimum": 0, "type": "integer", "description": "0 = no limit.", "default": 0 }, "onlyNewListings": { "title": "Monitor mode: only new listings", "type": "boolean", "description": "Return only listings not seen in previous runs with the same input. Schedule it every hour to get deal alerts.", "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 }, "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 } } } } } } } } } }