{ "openapi": "3.0.1", "info": { "title": "Craigslist Scraper — For Sale, Housing, Cars & Jobs, No Phones", "description": "craigslist listings from any city and section — for sale, housing, cars, jobs, gigs, services: title, price, place, date, category, images, and optionally description and attributes. No phones.", "version": "0.1", "x-build-id": "JOanynTY3mL5dIDYY" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/highbrow_fame~craigslist-listings/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-highbrow_fame-craigslist-listings", "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/highbrow_fame~craigslist-listings/runs": { "post": { "operationId": "runs-sync-highbrow_fame-craigslist-listings", "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/highbrow_fame~craigslist-listings/run-sync": { "post": { "operationId": "run-sync-highbrow_fame-craigslist-listings", "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": "Search links", "type": "array", "description": "Set up a search on craigslist with all the filters you want and paste the address of the results page (any city, any section: for sale, housing, cars, jobs, gigs, services). One per line.", "items": { "type": "string" } }, "cities": { "title": "Cities", "type": "array", "description": "Or search here without a link: craigslist sites (sfbay, newyork, chicago, toronto, london) or their names (SF bay area, new york), or sub-areas (manhattan, east bay). The fields below apply.", "items": { "type": "string" } }, "keywords": { "title": "Keywords", "type": "array", "description": "Optional: words to search for in each city above (one search per city and keyword). Empty: the whole section.", "items": { "type": "string" } }, "section": { "title": "Section", "enum": [ "sss", "cta", "hhh", "apa", "rea", "roo", "sub", "jjj", "ggg", "bbb", "fua", "ela", "bia", "mca", "zip" ], "type": "string", "description": "For the cities above.", "default": "sss" }, "minPrice": { "title": "Min price", "minimum": 0, "type": "integer", "description": "Optional, in the city's currency (USD, CAD, GBP…)." }, "maxPrice": { "title": "Max price", "minimum": 0, "type": "integer", "description": "Optional, in the city's currency." }, "sellerType": { "title": "Sold by", "enum": [ "all", "owner", "dealer" ], "type": "string", "description": "For sale and cars: owners or dealers.", "default": "all" }, "postedToday": { "title": "Posted today", "type": "boolean", "description": "Only listings posted today.", "default": false }, "hasPic": { "title": "Has a picture", "type": "boolean", "description": "Only listings with pictures.", "default": false }, "titlesOnly": { "title": "Keywords in titles only", "type": "boolean", "description": "Search the keywords in titles, not in the whole text.", "default": false }, "postalCode": { "title": "ZIP / postal code", "type": "string", "description": "Optional: search around this code (with the distance below)." }, "distanceMiles": { "title": "Distance (miles)", "minimum": 1, "maximum": 500, "type": "integer", "description": "Optional: how far around the ZIP / postal code." }, "sortBy": { "title": "Sort", "enum": [ "default", "newest", "relevance", "price-low", "price-high" ], "type": "string", "description": "For the cities above.", "default": "default" }, "maxListingsPerSearch": { "title": "Max listings per search", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stops each search after this many listings. craigslist lists up to 10,000 for one search.", "default": 200 }, "includeDetails": { "title": "Open every listing for its details", "type": "boolean", "description": "Adds the full description, the attributes (condition, odometer, bathrooms, rent period, compensation…), ZIP code and the updated date. One more page per listing, so slower.", "default": false }, "maxConcurrency": { "title": "Parallel searches", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many searches to work on at the same time.", "default": 3 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Used only to try again after a network error: the first try goes out directly.", "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 } } } } } } } } } }