{ "openapi": "3.0.1", "info": { "title": "Craigslist FSBO & Rentals Scraper + Monitor", "description": "Collect owner-filtered sales and rentals with full details, new-listing and price/title monitoring, possible repost hints and deeper price-range searches. California defaults; other regions supported. Platform usage included.", "version": "0.3", "x-build-id": "7MFNGfy0XmqhQUDAB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/khadinakbar~craigslist-fsbo-rentals-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-khadinakbar-craigslist-fsbo-rentals-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/khadinakbar~craigslist-fsbo-rentals-scraper/runs": { "post": { "operationId": "runs-sync-khadinakbar-craigslist-fsbo-rentals-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/khadinakbar~craigslist-fsbo-rentals-scraper/run-sync": { "post": { "operationId": "run-sync-khadinakbar-craigslist-fsbo-rentals-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": { "connectionMode": { "title": "Connection strategy", "enum": [ "direct", "auto" ], "type": "string", "description": "Direct HTTPS with platform usage included. Paid proxy routes are not supported in this version.", "default": "direct" }, "listingMode": { "title": "Listing types", "enum": [ "both", "fsbo", "rentals" ], "type": "string", "description": "Choose owner-filtered real estate sales, apartment/housing rentals, or both. FSBO uses the Craigslist owner filter; this is not independent proof of property ownership. Both types share maxResults.", "default": "both" }, "sites": { "title": "Craigslist regions", "type": "array", "description": "Search these Craigslist regions. Defaults to SF Bay Area, Los Angeles, San Diego, Sacramento, Orange County and Inland Empire. Replace with other region codes for broader coverage; use 1–30 regions.", "items": { "type": "string" }, "default": [ "sfbay", "losangeles", "sandiego", "sacramento", "orangecounty", "inlandempire" ] }, "maxResults": { "title": "Max properties", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum delivered records, up to 5,000. Deeper searches split crowded price ranges; source caps and scan/page limits can leave partial coverage.", "default": 25 }, "includeDetails": { "title": "Include full listing details", "type": "boolean", "description": "Open each listing for description, photos, address and housing attributes when published. Enriched rows cost $0.00015; cards and recoverable card-only fallbacks cost $0.0001. Derived price-per-square-foot and source-quality flags are included. Platform usage is separate.", "default": false }, "searchQuery": { "title": "Search keywords", "type": "string", "description": "Optional free-text keywords Craigslist applies to titles and post bodies (e.g. studio, backyard, downtown)." }, "minSalePrice": { "title": "Minimum sale price", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Minimum asking price for FSBO searches. Zero disables the filter.", "default": 0 }, "maxSalePrice": { "title": "Maximum sale price", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Maximum asking price for FSBO searches. Zero disables the filter.", "default": 0 }, "minRent": { "title": "Minimum rent", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Minimum rent for rental searches. Zero disables the filter.", "default": 0 }, "maxRent": { "title": "Maximum rent", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Maximum rent for rental searches. Zero disables the filter.", "default": 0 }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Filter search results to at least this many bedrooms. Use 0 to disable.", "default": 0 }, "maxBedrooms": { "title": "Maximum bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Filter search results to at most this many bedrooms. Use 0 to disable.", "default": 0 }, "minBathrooms": { "title": "Minimum bathrooms", "minimum": 0, "maximum": 20, "type": "number", "description": "Filter search results to at least this many bathrooms. Use 0 to disable.", "default": 0 }, "maxBathrooms": { "title": "Maximum bathrooms", "minimum": 0, "maximum": 20, "type": "number", "description": "Filter search results to at most this many bathrooms. Use 0 to disable.", "default": 0 }, "minSqft": { "title": "Minimum square feet", "minimum": 0, "type": "integer", "description": "Filter by minimum living area when Craigslist exposes sqft. Use 0 to disable.", "default": 0 }, "maxSqft": { "title": "Maximum square feet", "minimum": 0, "type": "integer", "description": "Filter by maximum living area when Craigslist exposes sqft. Use 0 to disable.", "default": 0 }, "housingTypes": { "title": "Housing types", "type": "array", "description": "Optional Craigslist housing_type filters (apartment, condo, house, townhouse, etc.). Leave empty for all types.", "items": { "type": "string", "enum": [ "apartment", "condo", "cottage-cabin", "duplex", "flat", "house", "in-law", "loft", "townhouse", "manufactured", "assisted-living", "land" ] }, "default": [] }, "postalCode": { "title": "Postal / ZIP code", "type": "string", "description": "Optional ZIP/postal that redirects Craigslist to a city search scoped around that code." }, "searchRadiusMiles": { "title": "Search radius (miles)", "minimum": 0, "maximum": 250, "type": "integer", "description": "Radius in miles around postalCode. Only applied when postalCode is set.", "default": 0 }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Optional Craigslist real estate (rea) or apartment rental (apa) search/listing URLs. Overrides regions and listingMode. Sale URLs without the owner filter are labeled sale, not FSBO. No other housing category is supported.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxRunSeconds": { "title": "Run time budget (seconds)", "minimum": 30, "maximum": 600, "type": "integer", "description": "Stop dispatching work at this time budget. Completed requests and persisted listings remain available; unfinished work is reported as PARTIAL.", "default": 180 }, "site": { "title": "Craigslist site code", "type": "string", "description": "Optional single region that overrides sites when nonempty. Leave empty for the California default regions.", "default": "" }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Legacy minimum price applied to both types unless their specific minimum is set. Prefer minSalePrice and minRent.", "default": 0 }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Legacy maximum price applied to both types unless their specific maximum is set. Prefer maxSalePrice and maxRent.", "default": 0 }, "catsOk": { "title": "Cats OK", "type": "boolean", "description": "Only return listings marked cats-ok on Craigslist.", "default": false }, "dogsOk": { "title": "Dogs OK", "type": "boolean", "description": "Only return listings marked dogs-ok on Craigslist.", "default": false }, "furnishedOnly": { "title": "Furnished only", "type": "boolean", "description": "Only return furnished listings when Craigslist supports the filter.", "default": false }, "hasPic": { "title": "Has pictures", "type": "boolean", "description": "Only return listings that include photos.", "default": false }, "postedToday": { "title": "Posted today", "type": "boolean", "description": "Only return listings Craigslist marks as posted today.", "default": false }, "maxAgeDays": { "title": "Max listing age (days)", "minimum": 0, "type": "integer", "description": "Skip listings older than this many days when a posted date is available. Use 0 to disable.", "default": 0 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 3, "type": "integer", "description": "Parallel HTTP requests (1–5). Requests are also limited to 30 per minute.", "default": 2 }, "monitorMode": { "title": "Monitoring", "enum": [ "off", "new", "changes" ], "type": "string", "description": "First monitoring run establishes history and returns new listings. Later runs compare the same watch and query scope; unchanged rows are not billed.", "default": "off" }, "watchName": { "title": "Watch name", "pattern": "^[a-zA-Z0-9_-]{1,64}$", "type": "string", "description": "Required for monitoring unless run as a saved task. Keep this name and query scope unchanged between runs. Isolated by authenticated account and Actor. History expires after 60 days and is bounded to 10,000 observations." }, "maxSearchPages": { "title": "Maximum search requests", "minimum": 1, "maximum": 30, "type": "integer", "description": "Hard bound on initial searches plus price-range continuation. Each attempted search costs $0.00015 including empty or blocked responses. This caps work; it is not a promise of complete inventory.", "default": 12 }, "maxListingsScanned": { "title": "Maximum observed listings", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Monitoring scans unchanged listings to find updates; stops at this bound even when fewer records are delivered.", "default": 5000 } } }, "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 } } } } } } } } } }