{ "openapi": "3.0.1", "info": { "title": "Craigslist Search Scraper", "description": "Fast craigslist search scraper. Search any of 666 craigslist cities by category, keyword, price range, or map radius. Extracts title, price, posting timestamp, latitude and longitude, location, neighborhood, image urls, and post url. Reads craigslist's own JSON search API, no headless browser.", "version": "0.1", "x-build-id": "NLqedY9Gk3g3yGDni" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cirkit~craigslist-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cirkit-craigslist-search-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/cirkit~craigslist-search-scraper/runs": { "post": { "operationId": "runs-sync-cirkit-craigslist-search-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/cirkit~craigslist-search-scraper/run-sync": { "post": { "operationId": "run-sync-cirkit-craigslist-search-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": [ "cities" ], "properties": { "cities": { "title": "Cities", "type": "array", "description": "Craigslist city subdomains to search, one per line. Use the subdomain from the site url: newyork.craigslist.org is 'newyork'. 666 cities worldwide are supported, including london, toronto, berlin and sydney.", "default": [ "newyork" ], "items": { "type": "string" } }, "category": { "title": "Category", "type": "string", "description": "Craigslist category abbreviation. Top-level: sss (for sale), jjj (jobs), hhh (housing), bbb (services), ggg (gigs), ccc (community). Subcategories also work, for example cta (cars and trucks), apa (apartments for rent), ele (electronics), sof (software jobs).", "default": "sss" }, "query": { "title": "Search keyword", "type": "string", "description": "Optional free-text keyword, for example 'mountain bike'. Leave empty to return everything in the category." }, "maxItems": { "title": "Maximum results", "minimum": 1, "type": "integer", "description": "Hard cap on records written to the dataset across all cities. Craigslist exposes roughly 2000 results per city and category, so raise this by adding more cities rather than by expecting deeper paging.", "default": 1000 }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Only return posts at or above this price." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Only return posts at or below this price." }, "postedToday": { "title": "Posted today only", "type": "boolean", "description": "Restrict to posts made today.", "default": false }, "hasImage": { "title": "Has image only", "type": "boolean", "description": "Restrict to posts that include at least one photo.", "default": false }, "latitude": { "title": "Latitude", "type": "string", "description": "Optional centre point latitude. Set together with longitude and search radius to search around a specific location instead of the whole city." }, "longitude": { "title": "Longitude", "type": "string", "description": "Optional centre point longitude." }, "searchDistance": { "title": "Search radius", "minimum": 1, "type": "integer", "description": "Radius around the latitude and longitude, in miles for US cities." }, "imageSize": { "title": "Image size", "enum": [ "small", "medium", "large" ], "type": "string", "description": "Resolution of the returned image urls.", "default": "medium" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Craigslist's search API does not block datacenter traffic, so the default Apify proxy is sufficient and residential proxies are not needed.", "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 } } }, "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 } } } } } } } } } }