{
"openapi": "3.0.1",
"info": {
"title": "Redfin Scraper",
"description": "Scrape Redfin homes for sale, sold homes and rentals by city, ZIP code, county or search link: price, beds, baths, square feet, lot size, year built, days on market, sale date, photos and more. All Redfin filters.",
"version": "0.1",
"x-build-id": "xUyy8Jcxf1QP9bPsV"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/robertosan16~redfin-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-robertosan16-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/robertosan16~redfin-scraper/runs": {
"post": {
"operationId": "runs-sync-robertosan16-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/robertosan16~redfin-scraper/run-sync": {
"post": {
"operationId": "run-sync-robertosan16-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": {
"locations": {
"title": "Locations",
"type": "array",
"description": "US cities, ZIP codes, counties, neighborhoods or states, one per line, as you would type them into the Redfin search box: Austin, TX, 78701, Travis County, TX, Brooklyn, NY. Add the state to get the right city.",
"items": {
"type": "string"
}
},
"searchUrls": {
"title": "Redfin search links",
"type": "array",
"description": "Links of searches made on redfin.com, with any filters you set there, such as https://www.redfin.com/city/30818/TX/Austin/filter/property-type=house,min-beds=3. Rental searches (/apartments-for-rent) and sold searches work too. Each link keeps its own filters and listing type.",
"items": {
"type": "string"
}
},
"searchType": {
"title": "Listings",
"enum": [
"forSale",
"sold",
"forRent"
],
"type": "string",
"description": "What to scrape for the locations. Search links keep their own listing type.",
"default": "forSale"
},
"soldWithinDays": {
"title": "Sold within",
"enum": [
"7",
"30",
"90",
"180",
"365",
"730",
"1095",
"1825"
],
"type": "string",
"description": "For sold homes: how far back the sales go.",
"default": "90"
},
"includePending": {
"title": "Include pending and under contract",
"type": "boolean",
"description": "For homes for sale: also get homes that are pending or under contract. By default only active and coming soon homes are included, as on Redfin.",
"default": false
},
"propertyTypes": {
"title": "Property types",
"type": "array",
"description": "Leave empty for all types. For rent, multi-family means apartments, and land, manufactured, co-op and other do not apply.",
"items": {
"type": "string",
"enum": [
"house",
"condo",
"townhouse",
"multifamily",
"land",
"manufactured",
"co-op",
"other"
],
"enumTitles": [
"House",
"Condo",
"Townhouse",
"Multi-family (apartments for rent)",
"Land",
"Manufactured",
"Co-op",
"Other"
]
}
},
"minPrice": {
"title": "Minimum price",
"minimum": 0,
"type": "integer",
"description": "In US dollars. For rentals, the monthly rent."
},
"maxPrice": {
"title": "Maximum price",
"minimum": 0,
"type": "integer",
"description": "In US dollars. For rentals, the monthly rent."
},
"minBeds": {
"title": "Minimum bedrooms",
"minimum": 0,
"type": "integer",
"description": "Homes with at least this many bedrooms."
},
"maxBeds": {
"title": "Maximum bedrooms",
"minimum": 0,
"type": "integer",
"description": "Homes with at most this many bedrooms."
},
"minBaths": {
"title": "Minimum bathrooms",
"enum": [
"1",
"1.5",
"2",
"2.5",
"3",
"4",
"5"
],
"type": "string",
"description": "Homes with at least this many bathrooms."
},
"minSqft": {
"title": "Minimum square feet",
"minimum": 0,
"type": "integer",
"description": "Living area of at least this many square feet."
},
"maxSqft": {
"title": "Maximum square feet",
"minimum": 0,
"type": "integer",
"description": "Living area of at most this many square feet."
},
"minLotSqft": {
"title": "Minimum lot size (square feet)",
"minimum": 0,
"type": "integer",
"description": "One acre is 43,560 square feet."
},
"minYearBuilt": {
"title": "Built in or after",
"minimum": 0,
"type": "integer",
"description": "Homes built in this year or later."
},
"maxYearBuilt": {
"title": "Built in or before",
"minimum": 0,
"type": "integer",
"description": "Homes built in this year or earlier."
},
"maxHoa": {
"title": "Maximum HOA fee per month",
"minimum": 0,
"type": "integer",
"description": "In US dollars. 0 means homes without an HOA fee. Leave empty for any."
},
"maxDaysOnMarket": {
"title": "Listed within",
"enum": [
"1",
"3",
"7",
"14",
"30",
"90",
"180",
"365"
],
"type": "string",
"description": "For homes for sale: only homes listed within this time, for example new listings of the last day."
},
"keywords": {
"title": "Keywords in the description",
"type": "string",
"description": "Only homes whose listing description contains these words, such as pool or guest house."
},
"sortBy": {
"title": "Sort by",
"enum": [
"recommended",
"newest",
"priceLow",
"priceHigh",
"largest",
"pricePerSqftLow",
"recentlySold"
],
"type": "string",
"description": "Order of the results, as on Redfin. Very large searches are read by price range, and the order applies within each range.",
"default": "recommended"
},
"onlyNew": {
"title": "Only new listings since the last run",
"type": "boolean",
"description": "Save only listings that earlier runs of the same saved task did not save. The first run saves all current listings. Use it with a schedule to get new listings every day.",
"default": false
},
"includeAllPhotos": {
"title": "Include all photo links",
"type": "boolean",
"description": "Add the links of all photos of each home in photos. The main photo is always in photoUrl.",
"default": false
},
"maxItems": {
"title": "Maximum listings in total",
"minimum": 0,
"type": "integer",
"description": "Stop after saving this many listings. Leave empty or 0 for no limit. The example is kept small so the first run takes seconds."
},
"maxItemsPerSearch": {
"title": "Maximum listings per search",
"minimum": 0,
"type": "integer",
"description": "Limit for each location or search link, so that every search gets a share. Leave empty or 0 for no limit."
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "The Actor connects directly, which is fastest. If Redfin starts limiting requests, it switches to Apify Proxy automatically. Turn on a proxy here only to use it from the start.",
"default": {
"useApifyProxy": 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
}
}
}
}
}
}
}
}
}
}