{ "openapi": "3.0.1", "info": { "title": "Craigslist Listings Scraper", "description": "Search public Craigslist listings by city, category, and optional keywords, then collect listing IDs, titles, prices, dates, coordinates, neighborhoods, images, and source URLs. Optional detail-page requests add available descriptions and attributes to the dataset.", "version": "1.0", "x-build-id": "0Gj2jgJUHQlC3Mbm3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/axiomworks~craigslist-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-axiomworks-craigslist-listings-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/axiomworks~craigslist-listings-scraper/runs": { "post": { "operationId": "runs-sync-axiomworks-craigslist-listings-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/axiomworks~craigslist-listings-scraper/run-sync": { "post": { "operationId": "run-sync-axiomworks-craigslist-listings-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 or search URLs", "type": "array", "description": "Required. Craigslist city hostnames or full search URLs, e.g. [\"sfbay\",\"austin\"] or [\"https://sfbay.craigslist.org/search/bia?query=road+bike\"]. Hostname = the part before .craigslist.org. An unknown city or dead URL is skipped; if nothing is found the run still succeeds with 0 results and a status message naming what to change.", "items": { "type": "string" } }, "category": { "title": "Category abbreviation", "type": "string", "description": "Craigslist category code, default \"sss\" (all for sale). Examples: \"bia\" bicycles by owner, \"cta\" cars and trucks, \"apa\" apartments, \"jjj\" jobs, \"ela\" electronics. A category inside a search URL overrides this. Unknown codes return 0 results with a message. Output categoryAbbr may differ (e.g. bia listings report \"bik\").", "default": "sss" }, "searchQuery": { "title": "Search words", "type": "string", "description": "Words to find in listings, e.g. \"road bike\" or \"iphone 14\". Empty string (default) returns all listings in the category, newest first.", "default": "" }, "searchQueries": { "title": "More search queries", "type": "array", "description": "Optional extra keywords searched in each city in addition to searchQuery, e.g. [\"gravel bike\",\"fixie\"]. Results are de-duplicated across queries and tagged in matchedQuery. Default none.", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Maximum items", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of unique listings for the whole run (not per city), 1-10000, default 50. Use 5-20 for a quick test.", "default": 50 }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Optional. Only keep listings priced at or above this number in local currency, e.g. 100. Listings without a price are kept. Integer 0 or more." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Optional. Only keep listings priced at or below this number in local currency, e.g. 500. Listings without a price are kept. Integer 0 or more." }, "postedWithinHours": { "title": "Posted within (hours)", "minimum": 1, "type": "integer", "description": "Optional. Only keep listings posted in the last N hours, e.g. 24 for the last day. Integer 1 or more; paging stops once older listings appear." }, "sortBy": { "title": "Sort by", "enum": [ "newest", "relevance", "priceAsc", "priceDesc" ], "type": "string", "description": "Result order: newest (default), relevance, priceAsc (cheapest first) or priceDesc (most expensive first). With maxItems this gives the N cheapest or priciest listings per city. postedWithinHours only stops paging early with newest; listings without a price come first with priceAsc.", "default": "newest" }, "includeDetails": { "title": "Include details", "type": "boolean", "description": "true (default) opens each listing page to add description and attributes; about 1 second per listing, unreadable pages are skipped. false returns search-feed fields only (no description/attributes) and is much faster; use it for large maxItems.", "default": true }, "enrichWithAI": { "title": "Add AI deal signal", "type": "boolean", "description": "Optional, default false. true adds dealSignal (\"underpriced\", \"fair\", \"overpriced\" or \"unknown\") to each listing using a third-party AI processor; extra charge per enriched result. false leaves dealSignal null.", "default": false }, "maxJevCalls": { "title": "Maximum Jev calls", "minimum": 0, "maximum": 500, "type": "integer", "description": "Cap on AI calls per run, 0-500, default 500. Only used when enrichWithAI is true.", "default": 500 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy settings, e.g. {\"useApifyProxy\": true}. Default is datacenter proxy; blocked requests retry on a fresh session and then on residential proxy.", "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 } } } } } } } } } }