{ "openapi": "3.0.1", "info": { "title": "Redfin Sale, Rental & Sold Listings Scraper", "description": "Scrape Redfin real estate listings - search properties for sale, recently sold, and rental listings across the US. Extracts price, beds, baths, sqft, address, coordinates, agent info, images, and more.", "version": "1.1", "x-build-id": "3iuYhFjMsqpWI3htR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nimbryxo-studio~redfin-sale-rental-and-sold-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nimbryxo-studio-redfin-sale-rental-and-sold-listings-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/nimbryxo-studio~redfin-sale-rental-and-sold-listings-scraper/runs": { "post": { "operationId": "runs-sync-nimbryxo-studio-redfin-sale-rental-and-sold-listings-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/nimbryxo-studio~redfin-sale-rental-and-sold-listings-scraper/run-sync": { "post": { "operationId": "run-sync-nimbryxo-studio-redfin-sale-rental-and-sold-listings-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "forSale", "recentlySold", "forRent", "search", "byUrl" ], "type": "string", "description": "What type of listings to fetch.", "default": "forSale" }, "location": { "title": "Location", "type": "string", "description": "City and state (`Austin, TX`), ZIP (`90210`, `10001`, `78701`), neighborhood (`South Congress, Austin, TX`), Redfin search URL, or a region token such as `6_30818` (city region 30818).", "default": "Austin, TX" }, "listingUrl": { "title": "Listing URL (mode=byUrl)", "type": "string", "description": "Full Redfin listing URL containing `/home/`, e.g. `https://www.redfin.com/TX/Austin/123-Main-St-78701/home/12345678`." }, "keyword": { "title": "Keyword", "type": "string", "description": "Case-insensitive keyword matched against address, description, listing tags, key facts, subdivision, and building name. Required in `search` mode and optional in other modes." }, "propertyType": { "title": "Property type", "enum": [ "all", "house", "condo", "townhouse", "multifamily", "land", "other" ], "type": "string", "description": "Filter by property type. Applied server-side where Redfin supports it and re-checked in the actor.", "default": "all" }, "minPrice": { "title": "Min price ($)", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Minimum sale price, or minimum monthly rent in forRent mode." }, "maxPrice": { "title": "Max price ($)", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Maximum sale price, or maximum monthly rent in forRent mode." }, "minBeds": { "title": "Min bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Minimum number of bedrooms." }, "minBaths": { "title": "Min bathrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Minimum number of bathrooms." }, "minSqft": { "title": "Min square footage", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Minimum interior square footage." }, "maxSqft": { "title": "Max square footage", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Maximum interior square footage." }, "soldWithinDays": { "title": "Sold within (days)", "enum": [ "30", "90", "180", "365", "1095", "1825" ], "type": "string", "description": "How far back to search in recentlySold mode. Ignored in other modes.", "default": "180" }, "sort": { "title": "Sort order", "enum": [ "recommended", "newest", "oldest", "priceLowToHigh", "priceHighToLow" ], "type": "string", "description": "Result ordering. Verified against Redfin's GIS and rental APIs.", "default": "recommended" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Hard cap on emitted records (1-20,000). This is a self-imposed cap; Redfin returned homes at a start offset of 19,950 in verification. Deep offsets in very large regions can return an empty page.", "default": 20 }, "includeDetails": { "title": "Include detail enrichment", "type": "boolean", "description": "Fetch each listing's below-the-fold detail payload: price history, tax history, public records (APN, county, year renovated), and amenities. Adds one request per emitted listing.", "default": false } } }, "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 } } } } } } } } } }