{ "openapi": "3.0.1", "info": { "title": "Redfin Scraper: Property Listings, Sold Listings & Rentals", "description": "Scrape Redfin property listings: homes for sale, sold and for rent by search URL with its filters, city, ZIP code, neighborhood, county or home URL. Property data: id, URL, price, beds, baths, sq ft, lot size, year built, HOA fee, status, days on market, coordinates, MLS id, photos. No login.", "version": "0.1", "x-build-id": "oofAcIk1QmdRPk8JE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hyperbach~redfin-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hyperbach-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/hyperbach~redfin-scraper/runs": { "post": { "operationId": "runs-sync-hyperbach-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/hyperbach~redfin-scraper/run-sync": { "post": { "operationId": "run-sync-hyperbach-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": { "searchUrls": { "title": "Redfin URLs", "type": "array", "description": "Redfin search URLs as your browser shows them, one a line: a city, ZIP code, neighborhood or county search (`https://www.redfin.com/city/30818/TX/Austin`), with every filter you set on the site kept (`/filter/property-type=house,max-price=500k,min-beds=3`, a map area `viewport=…`, sold homes `include=sold-3mo`, rentals `/apartments-for-rent` or `/rentals`). A home URL (`https://www.redfin.com/TX/Austin/3808-Balcones-Dr-78731/home/34166255`) is found in its ZIP code's for-sale, sold (5 years) and rental lists.", "items": { "type": "string" } }, "locations": { "title": "Places", "type": "array", "description": "Places to search, one a line: a city with its state (`Austin, TX`), a ZIP code (`78731`), a neighborhood (`Hyde Park, Austin`) or a county (`Travis County, TX`). Each is resolved by Redfin's own place search (its first place) and searched for the listing type below. A place Redfin does not know gives a free row with no home.", "items": { "type": "string" } }, "listingType": { "title": "Listing type (for the places)", "enum": [ "for_sale", "for_rent", "sold_1mo", "sold_3mo", "sold_6mo", "sold_1yr", "sold_3yr", "sold_5yr" ], "type": "string", "description": "What the places above search: homes for sale, homes for rent, or homes sold in the last month to 5 years. A Redfin URL keeps its own (sold or rentals in the URL).", "default": "for_sale" }, "maxItemsPerSearch": { "title": "Max homes per search", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Stop each search after this many new homes. 0 = every home Redfin gives the search: up to 10,000 for sale or sold (the site's limit of one search), every rental.", "default": 1000 }, "maxItems": { "title": "Max homes in the run", "minimum": 0, "type": "integer", "description": "Stop the whole run after this many home rows, over every search. 0 = no run cap (each search keeps its own cap).", "default": 0 }, "feedback": { "title": "Feedback to the maintainers", "maxLength": 2000, "type": "string", "description": "A note to the people who maintain this Actor: what you needed and did not get. For example a missing field, a wrong or empty result, or the Actor you switch from or to, and why. The run does not read it: the rows and the charges stay the same. A person reads every note." } } }, "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 } } } } } } } } } }