{ "openapi": "3.0.1", "info": { "title": "Redfin Scraper", "description": "Scrape active and recently sold property listings from Redfin. Filter by price, beds, baths, property type, square footage, year built, HOA and new construction. Supports multiple US cities and Redfin search URLs. Export to JSON, CSV or Excel.", "version": "1.0", "x-build-id": "39ODoM6Ufcu3yvaUg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/brilliant_gum~redfin-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-brilliant_gum-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/brilliant_gum~redfin-scraper/runs": { "post": { "operationId": "runs-sync-brilliant_gum-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/brilliant_gum~redfin-scraper/run-sync": { "post": { "operationId": "run-sync-brilliant_gum-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", "required": [ "locations", "searchMode" ], "properties": { "locations": { "title": "Locations", "type": "array", "description": "Redfin search URLs or city names. Supported city names: Austin TX, New York NY, Los Angeles CA, Chicago IL, Philadelphia PA, Seattle WA, Miami FL, Manhattan NY, Brooklyn NY, Queens NY. For any other city use a Redfin URL, e.g. \"https://www.redfin.com/city/16163/WA/Seattle\"", "items": { "type": "string" } }, "searchMode": { "title": "Search Mode", "enum": [ "SALE", "SOLD" ], "type": "string", "description": "SALE = active for-sale listings ยท SOLD = recently sold properties (last 90 days by default)", "default": "SALE" }, "maxListings": { "title": "Max Listings per Location", "minimum": 1, "maximum": 500, "type": "integer", "description": "Maximum number of listings to return per location.", "default": 100 }, "minPrice": { "title": "Min Price (USD)", "minimum": 0, "type": "integer", "description": "Minimum listing price in USD." }, "maxPrice": { "title": "Max Price (USD)", "minimum": 0, "type": "integer", "description": "Maximum listing price in USD." }, "minBeds": { "title": "Min Bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Minimum number of bedrooms." }, "minBaths": { "title": "Min Bathrooms", "minimum": 0, "type": "number", "description": "Minimum number of bathrooms (e.g. 1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5, 5)." }, "propertyTypes": { "title": "Property Types", "uniqueItems": true, "type": "array", "description": "Filter by property type. Leave empty to include all types.", "items": { "type": "string", "enum": [ "house", "condo", "townhouse", "multi-family", "land", "mobile" ] } }, "minSqFt": { "title": "Min Square Footage", "minimum": 0, "type": "integer", "description": "Minimum property square footage." }, "maxSqFt": { "title": "Max Square Footage", "minimum": 0, "type": "integer", "description": "Maximum property square footage." }, "minYearBuilt": { "title": "Min Year Built", "minimum": 1800, "maximum": 2025, "type": "integer", "description": "Only return properties built on or after this year (e.g. 1990)." }, "maxDaysOnMarket": { "title": "Max Days on Market", "minimum": 1, "type": "integer", "description": "Maximum number of days a listing has been on the market. Applies to active/sale listings only." }, "maxHOA": { "title": "Max HOA Fee (USD/month)", "minimum": 0, "type": "integer", "description": "Maximum HOA fee per month in USD. Set to 0 to disable this filter." }, "isNewConstruction": { "title": "New Construction Only", "type": "boolean", "description": "If enabled, return only new construction listings.", "default": false }, "sortOrder": { "title": "Sort Order", "enum": [ "newest", "price-asc", "price-desc", "days-asc" ], "type": "string", "description": "Sort results by the selected criterion. Leave blank for default Redfin sort." }, "soldWithin": { "title": "Sold Within (days)", "minimum": 1, "maximum": 365, "type": "integer", "description": "For SOLD mode only: return properties sold within this many days (e.g. 7, 30, 90, 180, 365). Leave blank to return all sold listings." } } }, "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 } } } } } } } } } }