{ "openapi": "3.0.1", "info": { "title": "Craigslist Real Estate Scraper | FSBO & Rentals", "description": "Extract Craigslist real estate listings: prices, beds, baths, square footage, photos, descriptions, owner/dealer flags, and public contact signals. Search cities or paste listing URLs. Export as JSON, CSV, Excel.", "version": "1.0", "x-build-id": "boHjisnh7qTwInFaN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parsebird~craigslist-real-estate-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parsebird-craigslist-real-estate-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/parsebird~craigslist-real-estate-scraper/runs": { "post": { "operationId": "runs-sync-parsebird-craigslist-real-estate-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/parsebird~craigslist-real-estate-scraper/run-sync": { "post": { "operationId": "run-sync-parsebird-craigslist-real-estate-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", "direct_urls" ], "type": "string", "description": "Choose search to build a Craigslist city search, or direct URLs to scrape exact public listing pages.", "default": "search" }, "city": { "title": "City", "enum": [ "sfbay", "newyork", "losangeles", "chicago", "seattle", "boston", "washingtondc", "atlanta", "dallas", "houston", "denver", "philadelphia", "miami", "austin", "sandiego", "phoenix", "portland", "minneapolis", "detroit", "nashville", "raleigh", "charlotte", "baltimore", "stlouis", "orlando", "tampa", "lasvegas", "sacramento", "newhaven", "providence", "richmond", "saltlakecity", "toronto", "vancouver", "montreal" ], "type": "string", "description": "Craigslist city code. Use the subdomain from craigslist.org, such as sfbay, newyork, losangeles, or chicago.", "default": "sfbay" }, "category": { "title": "Category", "enum": [ "apa", "rea", "roo", "sub", "vac" ], "type": "string", "description": "Craigslist real estate category to scrape.", "default": "rea" }, "listingType": { "title": "Listing type", "enum": [ "all", "owner", "dealer" ], "type": "string", "description": "Filter for owner/FSBO or dealer/broker where Craigslist exposes that signal. The scraper also applies post-fetch checks to listing URLs, category codes, and text.", "default": "all" }, "directUrls": { "title": "Direct URLs", "type": "array", "description": "Paste public Craigslist real estate listing URLs. Used only when mode is direct_urls.", "items": { "type": "string" } }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Only include listings priced at or above this amount." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Only include listings priced at or below this amount." }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Only include listings with at least this many bedrooms when the field is visible." }, "postalCode": { "title": "Postal code", "type": "string", "description": "Optional ZIP/postal code for Craigslist radius search." }, "searchDistance": { "title": "Search distance", "minimum": 1, "maximum": 200, "type": "integer", "description": "Radius in miles around the postal code. Used only when postal code is provided.", "default": 10 }, "maxListings": { "title": "Max listings", "minimum": 1, "maximum": 500, "type": "integer", "description": "Hard cap on listings to return. Allowed range is 1 to 500.", "default": 25 }, "includePhotos": { "title": "Include photos", "type": "boolean", "description": "Return public Craigslist image URLs when available.", "default": true }, "includeContactInfo": { "title": "Include public contact info", "type": "boolean", "description": "Extract only phone numbers or emails visibly present in the public listing body. The actor does not automate Craigslist reply flows.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Use Apify Proxy for reliable Craigslist requests. Switch proxy groups if Craigslist returns blocks or empty responses.", "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 } } }, "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 } } } } } } } } } }