{ "openapi": "3.0.1", "info": { "title": "Craigslist Listings Scraper - Cars, Housing, Jobs & For Sale", "description": "Scrape Craigslist listings for any city and category - title, price, description, attributes, photos and map location - with keyword, price and photo filters.", "version": "1.0", "x-build-id": "NCGrO5w3cYn8TZbyB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/seemuapps~craigslist-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-seemuapps-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/seemuapps~craigslist-listings-scraper/runs": { "post": { "operationId": "runs-sync-seemuapps-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/seemuapps~craigslist-listings-scraper/run-sync": { "post": { "operationId": "run-sync-seemuapps-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", "properties": { "mode": { "title": "Mode", "enum": [ "search", "urls" ], "type": "string", "description": "Search: browse a Craigslist city + category with optional keyword and filters. URLs: paste listing links and get their full details.", "default": "search" }, "city": { "title": "City / area", "type": "string", "description": "Craigslist site name - the subdomain in the URL, e.g. 'sfbay', 'newyork', 'losangeles', 'chicago', 'toronto', 'london'. A full Craigslist URL is accepted too. Required in Search mode." }, "category": { "title": "Category", "enum": [ "sss", "cta", "apa", "hhh", "roo", "rea", "jjj", "ggg", "bbb", "ccc", "eee", "ela", "fua", "bia", "mca", "zip", "gms" ], "type": "string", "description": "The Craigslist section to search. For any other category use the 'Custom category code' field below, which overrides this choice.", "default": "cta" }, "categoryCode": { "title": "Custom category code (optional)", "type": "string", "description": "Any Craigslist category code as it appears in a search URL, e.g. 'cto' (cars by owner), 'boo' (boats), 'pta' (auto parts), 'sof' (software jobs), 'vga' (video gaming). Overrides the Category dropdown when set." }, "query": { "title": "Keyword (optional)", "type": "string", "description": "Search terms, exactly as you would type them into the Craigslist search box. Leave empty to list everything in the category." }, "minPrice": { "title": "Min price (optional)", "minimum": 0, "type": "integer", "description": "Only return listings priced at or above this amount (in the city's local currency)." }, "maxPrice": { "title": "Max price (optional)", "minimum": 0, "type": "integer", "description": "Only return listings priced at or below this amount (in the city's local currency)." }, "postedToday": { "title": "Posted today only", "type": "boolean", "description": "Only return listings posted within the last 24 hours.", "default": false }, "hasImage": { "title": "Has image only", "type": "boolean", "description": "Only return listings that include at least one photo.", "default": false }, "sort": { "title": "Sort by", "enum": [ "relevance", "newest", "priceAsc", "priceDesc" ], "type": "string", "description": "Order in which results are returned; matters when Max items cuts the list short.", "default": "relevance" }, "maxItems": { "title": "Max items", "minimum": 0, "type": "integer", "description": "Maximum number of listings to return in Search mode. 0 = every matching listing (up to the site's 10,000-result limit).", "default": 100 }, "fetchDetails": { "title": "Fetch full listing details", "type": "boolean", "description": "Open every listing page to capture the full description, attributes, all photo URLs, address and posting dates. Turn off for a faster, cheaper title/price/location-only crawl.", "default": true }, "urls": { "title": "Listing URLs", "type": "array", "description": "Craigslist listing links to scrape in URLs mode, one per line. Both classic (https://sfbay.craigslist.org/sby/cto/d/slug/1234567890.html) and new (https://www.craigslist.org/view/d/slug/key) link formats work.", "items": { "type": "string" } } } }, "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 } } } } } } } } } }