{ "openapi": "3.0.1", "info": { "title": "Craigslist Scraper: Multi-City Listings Monitor, Only New", "description": "$1.20 per 1,000 listings. Scrape Craigslist from up to 100 cities and 20 keywords, or your own search URLs, in one run: title, price, place, coordinates, beds and sqft or job pay, images and link. Optional details: year, make, odometer. Only-new mode for schedules.", "version": "0.1", "x-build-id": "HUJFDErLf9nF7sWER" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automa-flow~craigslist-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automa-flow-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/automa-flow~craigslist-scraper/runs": { "post": { "operationId": "runs-sync-automa-flow-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/automa-flow~craigslist-scraper/run-sync": { "post": { "operationId": "run-sync-automa-flow-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": { "searches": { "title": "Keywords", "maxItems": 20, "type": "array", "description": "What to search for, one per line, for example iphone or honda civic. Each keyword runs in every city below. Leave empty to get the newest listings of the category.", "items": { "type": "string" } }, "cities": { "title": "Cities", "maxItems": 100, "type": "array", "description": "Craigslist sites, one per line: the name in the site address (newyork, sfbay, losangeles, chicago, toronto) or a subarea such as newyork/mnh or sfbay/eby. Up to 100.", "items": { "type": "string" } }, "category": { "title": "Category code", "pattern": "^[a-z]{3}$", "type": "string", "description": "Craigslist category code used with the keywords: sss all for sale, cta cars and trucks, apa apartments for rent, bia bicycles, ela electronics, fua furniture, zip free stuff, jjj jobs, hhh all housing, bbb services. Any other three-letter code from a Craigslist search address works too.", "default": "sss" }, "searchUrls": { "title": "Craigslist search URLs", "maxItems": 100, "type": "array", "description": "Paste searches made on craigslist.org, with their filters, for example https://sfbay.craigslist.org/search/cta?auto_make_model=honda&max_price=8000. Each URL is one search; its own filters win over the ones below.", "items": { "type": "string" } }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Only listings at this price or higher, in the site's currency." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Only listings at this price or lower, in the site's currency." }, "postedToday": { "title": "Posted today only", "type": "boolean", "description": "Only listings posted today, as Craigslist's own filter decides.", "default": false }, "maxResultsPerSearch": { "title": "Max listings per search", "minimum": 1, "maximum": 360, "type": "integer", "description": "Listings to deliver per city and keyword (or per URL), newest first. Craigslist answers up to 360 per search.", "default": 200 }, "onlyNew": { "title": "Only new listings", "type": "boolean", "description": "Deliver and charge only listings this Task (or these searches, for API runs) has not delivered before. The first run returns the current listings and remembers them; scheduled runs then return only what was posted since.", "default": false }, "includeDetails": { "title": "Listing details", "type": "boolean", "description": "Also open each delivered listing's page for its attributes: year, make and model, odometer, condition and title status for vehicles; bathrooms, laundry, parking and pets for rentals; employment type for jobs. +$0.50 per 1,000 listings whose page loaded. One extra request per listing, about 0.3 s each, so 1,000 listings take about 5 minutes. Descriptions and contacts are never collected.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Network for the requests. Apify's datacenter proxy is the default and is enough for Craigslist search.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }