{
"openapi": "3.0.1",
"info": {
"title": "Redfin.com | Search | Details with Email | Agent(s) | Scraper",
"description": "Gain a competitive edge with our Redfin Scraper—effortlessly extract property listings and agent performance metrics with precision. Save time, eliminate duplicates, and access clean, structured data for smarter real estate decisions. 🚀",
"version": "0.0",
"x-build-id": "JoTHFP5RbiHc2yVyx"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/memo23~apify-redfin-cheerio/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-memo23-apify-redfin-cheerio",
"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/memo23~apify-redfin-cheerio/runs": {
"post": {
"operationId": "runs-sync-memo23-apify-redfin-cheerio",
"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/memo23~apify-redfin-cheerio/run-sync": {
"post": {
"operationId": "run-sync-memo23-apify-redfin-cheerio",
"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": "Start URLs",
"type": "array",
"description": "URLs to start with. Optional when using searchKeyword + searchMode.",
"items": {
"type": "string"
}
},
"searchKeyword": {
"title": "Search keyword (e.g. Los Angeles)",
"type": "string",
"description": "Optional Redfin search phrase such as a city, ZIP code, or neighborhood. When set, the actor resolves it through Redfin autocomplete before crawling."
},
"searchMode": {
"title": "Search Mode",
"enum": [
"sale",
"rent",
"sold"
],
"type": "string",
"description": "Mode used with searchKeyword.",
"default": "sale"
},
"soldTimeframe": {
"title": "Sold Timeframe",
"enum": [
"1mo",
"3mo",
"6mo",
"1yr"
],
"type": "string",
"description": "Sold-history window used when searchMode is sold.",
"default": "1mo"
},
"flattenOutput": {
"title": "Flatten Output Structure",
"type": "boolean",
"description": "Set to true to output a flat data structure.",
"default": false
},
"includesAboveTheFoldData": {
"title": "Includes Above The Fold Data",
"type": "boolean",
"description": "Include address, basic region info, and media.",
"default": true
},
"includesBelowTheFoldData": {
"title": "Includes Below The Fold Data",
"type": "boolean",
"description": "Include neighborhood, transit, and schools.",
"default": true
},
"includesParcelBounds": {
"title": "Includes Parcel Bounds",
"type": "boolean",
"description": "Include property boundaries and APN data.",
"default": true
},
"includesBannerData": {
"title": "Includes Banner Data",
"type": "boolean",
"description": "Include current promotions or banners.",
"default": true
},
"includesAmenitiesData": {
"title": "Includes Amenities Data",
"type": "boolean",
"description": "Include community and unit amenities.",
"default": true
},
"includesWalkScoreData": {
"title": "Includes Walk Score Data",
"type": "boolean",
"description": "Include walk, transit, and bike scores.",
"default": true
},
"includesSellsideThresholdData": {
"title": "Includes Sellside Threshold Data",
"type": "boolean",
"description": "Include price drop info.",
"default": true
},
"includesFloorPlansData": {
"title": "Includes Floor Plans Data",
"type": "boolean",
"description": "Include bed/bath units and floor plan structures.",
"default": true
},
"includesProtoHomeData": {
"title": "Includes Proto Home Data",
"type": "boolean",
"description": "Include companion Redfin proto-home enrichment when available.",
"default": true
},
"includeProfileDetails": {
"title": "Include Profile Details",
"type": "boolean",
"description": "Include detailed profile information in the output.",
"default": false
},
"maxItems": {
"title": "Max number of listings/items per crawl/scrape",
"type": "integer",
"description": "Maximum number of listings/items that will be scraped.",
"default": 1000
},
"maxConcurrency": {
"title": "Max Concurrency",
"type": "integer",
"description": "Maximum number of pages that can be processed at the same time.",
"default": 50
},
"minConcurrency": {
"title": "Min Concurrency",
"type": "integer",
"description": "Minimum number of pages that will be processed at the same time.",
"default": 1
},
"maxRequestRetries": {
"title": "Max Request Retries",
"type": "integer",
"description": "Number of times the crawler will retry a failed request before giving up.",
"default": 100
},
"storeName": {
"title": "Name your storage for listings (deduplication and long-term retention)",
"type": "string",
"description": "Assign a custom name to the Key-Value Store where your scraped listings will be saved. This ensures:\n 1. **Data Deduplication**: Prevents duplicate entries in the storage. \n 2. **Persistent Storage**: Enables long-term retention of listings, beyond default storage limits.\n 3. **Project Management**: Separate datasets by using unique names for different projects or analyses.\n 4. **Data Reuse**: Easily reference and reuse stored data without overwriting.\n (If left blank, the default storage will be used with standard retention limits.)"
},
"proxy": {
"title": "Proxy configuration",
"type": "object",
"description": "Specifies proxy servers that will be used by the scraper in order to hide its origin.
For details, see Proxy configuration in README.",
"default": {
"useApifyProxy": true,
"apifyProxyGroups": [
"RESIDENTIAL"
]
}
}
}
},
"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
}
}
}
}
}
}
}
}
}
}