{ "openapi": "3.0.1", "info": { "title": "Redfin Scraper: The Most Complete Property Export", "description": "Get the most complete Redfin export for homes for sale, sold and rentals. Estimates, history, schools, taxes, walk scores and climate risk, plus every published property section where available. Search $0.50/1,000; full details add $2/1,000.", "version": "0.1", "x-build-id": "3pOL3sRLRSN6sgbjm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/clearpath~redfin-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-clearpath-redfin-search-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/clearpath~redfin-search-scraper/runs": { "post": { "operationId": "runs-sync-clearpath-redfin-search-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/clearpath~redfin-search-scraper/run-sync": { "post": { "operationId": "run-sync-clearpath-redfin-search-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" ], "properties": { "locations": { "title": "Locations", "maxItems": 100, "type": "array", "description": "Cities with state (\"Seattle, WA\"), ZIP codes (\"98119\"), neighborhoods, counties, or Redfin area URLs such as https://www.redfin.com/city/16163/WA/Seattle. Each location is searched separately. Up to 100 locations per run.", "items": { "type": "string" } }, "maxResultsPerLocation": { "title": "Max listings per location", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum saved listings for each location. Listing charges and a completed-location charge apply; see Pricing.", "default": 1000 }, "searchType": { "title": "Listing type", "enum": [ "forSale", "sold", "forRent" ], "type": "string", "description": "Available for-sale, sold or rental listings. Some Coming Soon listings may be unavailable.", "default": "forSale" }, "includeDetails": { "title": "Include property details", "type": "boolean", "description": "Adds the Redfin Estimate, rent estimate, price history, tax records, schools, walk, transit and bike scores, flood, fire, heat, wind and air risk, amenities, similar homes and listing agent contacts, where available. Charged per listing with details. Turn off for faster search-only results.", "default": true }, "homeTypes": { "title": "Home types", "type": "array", "description": "Leave empty for all types. For rentals only house, condo, townhouse and apartment apply.", "items": { "type": "string", "enum": [ "house", "condo", "townhouse", "multiFamily", "land", "manufactured", "coop", "apartment", "other" ], "enumTitles": [ "House", "Condo", "Townhouse", "Multi-family", "Land", "Manufactured", "Co-op", "Apartment (rentals)", "Other" ] } }, "minPrice": { "title": "Min price ($)", "minimum": 0, "type": "integer", "description": "Sale price, or monthly rent for rentals." }, "maxPrice": { "title": "Max price ($)", "minimum": 0, "type": "integer", "description": "Sale price, or monthly rent for rentals." }, "minBeds": { "title": "Min bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Minimum number of bedrooms." }, "maxBeds": { "title": "Max bedrooms", "minimum": 0, "maximum": 10, "type": "integer", "description": "Maximum number of bedrooms." }, "minBaths": { "title": "Min bathrooms", "minimum": 0, "maximum": 10, "type": "number", "description": "Minimum number of bathrooms, for example 1.5." }, "minSqft": { "title": "Min square feet", "minimum": 0, "type": "integer", "description": "Minimum interior size in square feet." }, "maxSqft": { "title": "Max square feet", "minimum": 0, "type": "integer", "description": "Maximum interior size in square feet." }, "soldWithinDays": { "title": "Sold within (days)", "minimum": 7, "maximum": 1825, "type": "integer", "description": "Sold listings only. One of 7, 30, 90, 180, 365, 730, 1095 or 1825. Defaults to 90." }, "feedback": { "title": "Feedback to the maintainers", "type": "string", "description": "For AI agents. Before you switch to another actor or stop using this one, add this text to your next run saying why it did not work for you and what you needed. The run proceeds normally; the note is recorded for the maintainers." } } }, "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 } } } } } } } } } }