{ "openapi": "3.0.1", "info": { "title": "Craigslist Scraper", "description": "Craigslist listings from more than 700 local sites with price, posting time, neighborhood and photos, plus the full text and attributes such as odometer on request. Paste a search URL from your browser, or pick sites, a category and a search term.", "version": "0.1", "x-build-id": "tjCItoFXbLGEkdAwr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/deriverge~craigslist-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-deriverge-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/deriverge~craigslist-scraper/runs": { "post": { "operationId": "runs-sync-deriverge-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/deriverge~craigslist-scraper/run-sync": { "post": { "operationId": "run-sync-deriverge-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": { "searchUrls": { "title": "Search URLs", "type": "array", "description": "Craigslist search pages as you see them in the browser, with any filters, for example https://sfbay.craigslist.org/search/cta?query=toyota&min_price=5000. Use this or the fields below.", "items": { "type": "string" } }, "areas": { "title": "Areas", "type": "array", "description": "Craigslist sites to search: the site name (sfbay, newyork, losangeles, chicago, london) or a city name Craigslist uses (New York, Los Angeles, London). A city inside a larger site, such as San Francisco, searches that whole site (sfbay). Combined with Category, Search query and the filters below.", "items": { "type": "string" } }, "category": { "title": "Category", "enum": [ "sss", "cta", "mca", "bia", "ela", "fua", "hsa", "tla", "sga", "msa", "zip", "hhh", "apa", "roo", "sub", "rea", "jjj", "ggg", "bbb", "ccc", "eee" ], "type": "string", "description": "Category for the areas above.", "default": "sss" }, "query": { "title": "Search query", "type": "string", "description": "Words to search for, for example \"toyota tacoma\" or \"studio\"." }, "minPrice": { "title": "Minimum price", "type": "integer", "description": "Lowest price in the local currency." }, "maxPrice": { "title": "Maximum price", "type": "integer", "description": "Highest price in the local currency." }, "hasPic": { "title": "Only listings with photos", "type": "boolean", "description": "Skip listings without photos.", "default": false }, "postedToday": { "title": "Posted today only", "type": "boolean", "description": "Only listings posted today.", "default": false }, "titleOnly": { "title": "Search titles only", "type": "boolean", "description": "Match the query in listing titles only, not in descriptions.", "default": false }, "splitBySubarea": { "title": "Split large searches by subarea", "type": "boolean", "description": "Craigslist returns the newest ~360 listings per search. When a search has more, it is repeated for each subarea (in sfbay: San Francisco, South Bay, East Bay...), which reaches many more listings.", "default": true }, "includeDetails": { "title": "Include description and attributes", "type": "boolean", "description": "Opens each listing for the full description, the attributes (make, odometer, bedrooms, pets, laundry...) and the update time. Slower; the price is the same.", "default": false }, "newOnly": { "title": "Return only listings new since the last run", "type": "boolean", "description": "Keeps a snapshot per watch name (or per saved task) and returns only listings that were not there before. Schedule it for a listing alert.", "default": false }, "watchName": { "title": "Watch name", "type": "string", "description": "Name of the snapshot used by the new-only mode, for example \"sf-road-bikes\". Runs from a saved task get one automatically." }, "maxItems": { "title": "Maximum rows", "minimum": 1, "type": "integer", "description": "Hard cap on returned listings in the run.", "default": 1000 } } }, "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 } } } } } } } } } }