{ "openapi": "3.0.1", "info": { "title": "Craigslist Scraper - Listings, Prices, Photos, GPS", "description": "Scrape Craigslist listings in any city: title, price, date, neighborhood, GPS, photos, optional description, emails and phones. Filters: keyword, price range, condition, photo, posted today; sort by date or price. Beyond the 360-result limit. $1 per 1,000 listings, no start fee.", "version": "0.1", "x-build-id": "a6tCmkIMchmIAJjwy" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/om_kh~craigslist-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-om_kh-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/om_kh~craigslist-scraper/runs": { "post": { "operationId": "runs-sync-om_kh-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/om_kh~craigslist-scraper/run-sync": { "post": { "operationId": "run-sync-om_kh-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": { "searchUrls": { "title": "Craigslist search links", "type": "array", "description": "Paste search links from Craigslist with your filters, e.g. https://newyork.craigslist.org/search/brk/apa?max_price=3000 (up to 50).", "items": { "type": "string" } }, "cities": { "title": "Cities (optional)", "type": "array", "description": "Or build searches: Craigslist city hostnames such as newyork, losangeles, sfbay, chicago, london, paris, toronto.", "items": { "type": "string" } }, "category": { "title": "Category", "enum": [ "sss", "apa", "hhh", "roo", "cta", "jjj", "ggg", "bbb", "fua", "ela", "bia", "zip" ], "type": "string", "description": "Category used with Cities.", "default": "sss" }, "keywords": { "title": "Keywords (optional)", "type": "array", "description": "Keywords used with Cities; one search per city and keyword.", "items": { "type": "string" } }, "priceMin": { "title": "Minimum price (optional)", "minimum": 0, "type": "integer", "description": "Only postings priced at or above this amount." }, "priceMax": { "title": "Maximum price (optional)", "minimum": 0, "type": "integer", "description": "Only postings priced at or below this amount." }, "condition": { "title": "Condition (for sale only)", "enum": [ "", "new", "like-new", "excellent", "good", "fair", "salvage" ], "type": "string", "description": "Craigslist's own condition filter.", "default": "" }, "hasImage": { "title": "With a photo only", "type": "boolean", "description": "Only postings that have at least one photo.", "default": false }, "postedToday": { "title": "Posted today only", "type": "boolean", "description": "Only postings published in the last 24 hours.", "default": false }, "sort": { "title": "Sort by", "enum": [ "date", "rel", "priceasc", "pricedsc" ], "type": "string", "description": "Order of the results.", "default": "date" }, "maxItemsPerSearch": { "title": "Max listings per search", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Newest first, 1 to 10,000. Searches with more than 360 results are split automatically. Default 100.", "default": 100 }, "postedAfter": { "title": "Posted after (optional)", "type": "string", "description": "Only listings posted on or after this date (YYYY-MM-DD)." }, "includeDetails": { "title": "Include description and attributes", "type": "boolean", "description": "Open each listing for its full description, attributes (bedrooms, condition, odometer...) and address. $0.0015 instead of $0.001 per listing.", "default": false }, "maxTotalChargeUsd": { "title": "Max total charge (USD)", "type": "number", "description": "Optional hard cost cap for this run." } } }, "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 } } } } } } } } } }