{ "openapi": "3.0.1", "info": { "title": "Redfin Scraper - Homes for Sale, Prices, Beds & Photos", "description": "Scrape Redfin homes for sale by city, neighborhood or county link: address, price, beds, baths, square feet, lot size, year built, HOA, days on market, photo, tour links, coordinates and description. Filter by price, beds, type, age. Use onlyNew for daily alerts. Error rows are free.", "version": "0.1", "x-build-id": "Lp93OaxhCLrXOOlWA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapewise~redfin-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapewise-redfin-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/scrapewise~redfin-scraper/runs": { "post": { "operationId": "runs-sync-scrapewise-redfin-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/scrapewise~redfin-scraper/run-sync": { "post": { "operationId": "run-sync-scrapewise-redfin-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": { "startUrls": { "title": "Redfin region links", "type": "array", "description": "Links to a Redfin city, neighborhood or county page, for example https://www.redfin.com/city/1826/MA/Boston. Filters in the link (min-price, max-beds, property-type...) are used when the fields below are empty. One region per link.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchQueries": { "title": "Regions or ZIP codes", "type": "array", "description": "Optional. A region written as city:1826, neighborhood:1 or county:5 (the number in the Redfin link), or a five-digit ZIP code. One region per line.", "items": { "type": "string" } }, "listingStatus": { "title": "Listing status", "enum": [ "all", "active", "comingSoon" ], "type": "string", "description": "Redfin shows homes that are on the market now. Sold homes are not included.", "default": "all" }, "minPrice": { "title": "Min price (USD)", "minimum": 0, "type": "integer", "description": "Keep homes at or above this price. Empty = no minimum." }, "maxPrice": { "title": "Max price (USD)", "minimum": 0, "type": "integer", "description": "Keep homes at or below this price. Empty = no maximum." }, "minBeds": { "title": "Min bedrooms", "minimum": 0, "type": "integer", "description": "Keep homes with at least this many bedrooms." }, "maxBeds": { "title": "Max bedrooms", "minimum": 0, "type": "integer", "description": "Keep homes with at most this many bedrooms." }, "minBaths": { "title": "Min bathrooms", "minimum": 0, "type": "number", "description": "Keep homes with at least this many bathrooms (1.5 counts a half bath)." }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Keep only these types. Empty = all.", "items": { "type": "string", "enum": [ "House", "Condo", "Townhouse", "Multi-family", "Land", "Other", "Mobile", "Co-op" ] } }, "minSqft": { "title": "Min square feet", "minimum": 0, "type": "integer", "description": "Keep homes with at least this living area." }, "maxSqft": { "title": "Max square feet", "minimum": 0, "type": "integer", "description": "Keep homes with at most this living area." }, "minYearBuilt": { "title": "Built after (year)", "minimum": 0, "type": "integer", "description": "Keep homes built in this year or later." }, "maxYearBuilt": { "title": "Built before (year)", "minimum": 0, "type": "integer", "description": "Keep homes built in this year or earlier." }, "maxDaysOnMarket": { "title": "Max days on Redfin", "minimum": 0, "type": "integer", "description": "Keep homes listed on Redfin for at most this many days. Coming soon homes always pass." }, "maxItems": { "title": "Max homes", "minimum": 0, "type": "integer", "description": "Hard cap for the whole run, across all regions. 0 = no cap. A single region returns up to 10,000 homes; split bigger areas into cities or counties.", "default": 50 }, "onlyNew": { "title": "Only new homes", "type": "boolean", "description": "Skip homes already delivered by earlier runs of the same region and filters. Schedule the run daily to get only new listings. Homes skipped this way are not charged.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify datacenter proxy by default. Change it only if you know you need to.", "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 } } } } } } } } } }