{ "openapi": "3.0.1", "info": { "title": "Redfin Explorer", "description": "Scrape REDFIN.com Real Estates", "version": "0.0", "x-build-id": "a6IYNSSZbHdSk4Jm4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jupri~redfin-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jupri-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/jupri~redfin-scraper/runs": { "post": { "operationId": "runs-sync-jupri-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/jupri~redfin-scraper/run-sync": { "post": { "operationId": "run-sync-jupri-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": { "location": { "title": "Location", "type": "array", "description": "max=maybe 5", "items": { "type": "string" } }, "search_type": { "title": "Search Mode", "enum": [ "sale", "sold", "rent" ], "type": "string", "description": "" }, "keywords": { "title": "Keywords", "type": "string", "description": "" }, "limit": { "title": "Limit", "type": "integer", "description": "Number of results" }, "sort": { "title": "Sort", "enum": [ "redfin-recommended", "days-on-redfin", "price", "square-footage", "lot-sq-ft", "price-per-sqft", "bed", "baths", "dollars-per-sq-ft" ], "type": "string", "description": "" }, "order": { "title": "Order", "enum": [ "asc", "desc" ], "type": "string", "description": "" }, "max_days": { "title": "Days on Redfin", "enum": [ "", "1-", "3-", "7-", "14-", "30-", "-7", "-14", "-30", "-45", "-60", "-90", "-180" ], "type": "string", "description": "" }, "sold_within": { "title": "Sold Within", "type": "integer", "description": "Days", "default": 1 }, "move_date": { "title": "Move-in date", "type": "string", "description": "Available on or before this date." }, "deals": { "title": "Deals or promotion", "type": "boolean", "description": "Only show listings with deals or promotions" }, "dogs_allowed": { "title": "Dogs allowed", "type": "boolean", "description": "" }, "cats_allowed": { "title": "Cats allowed", "type": "boolean", "description": "" }, "types.house": { "title": "House", "type": "boolean", "description": "" }, "types.townhouse": { "title": "Townhouse", "type": "boolean", "description": "" }, "types.condo": { "title": "Condo", "type": "boolean", "description": "" }, "types.land": { "title": "Land", "type": "boolean", "description": "" }, "types.multifamily": { "title": "Multi-Family", "type": "boolean", "description": "" }, "types.mobile": { "title": "Mobile", "type": "boolean", "description": "" }, "types.coop": { "title": "Co-op", "type": "boolean", "description": "" }, "types.other": { "title": "Other", "type": "boolean", "description": "" }, "status.comingsoon": { "title": "Coming Soon", "type": "boolean", "description": "" }, "status.active": { "title": "Active", "type": "boolean", "description": "" }, "status.pending": { "title": "Under contract / pending", "type": "boolean", "description": "" }, "listing.agent": { "title": "By agent", "type": "boolean", "description": "" }, "listing.foreclosures": { "title": "Foreclosures", "type": "boolean", "description": "" }, "listing.fsbo": { "title": "By owner (FSBO)", "type": "boolean", "description": "" }, "excl_ss": { "title": "Exclude short sales", "type": "boolean", "description": "" }, "listing.newconstruction": { "title": "New construction", "type": "boolean", "description": "" }, "rdfn_lst": { "title": "Redfin listings only", "type": "boolean", "description": "" }, "min_year": { "title": "Year Built", "type": "integer", "description": "" }, "max_year": { "title": "", "type": "integer", "description": "" }, "min_price": { "title": "Price", "type": "integer", "description": "" }, "max_price": { "title": "", "type": "integer", "description": "" }, "monthy_price": { "title": "Monthly Price", "type": "boolean", "description": "For SALE only" }, "mortgage_term": { "title": "Loan type", "enum": [ "1", "2", "3" ], "type": "string", "description": "", "default": "1" }, "interest_rate": { "title": "Interest rate (%)", "type": "string", "description": "", "default": "7.931" }, "down_payment": { "title": "Down payment", "type": "integer", "description": "", "default": 20 }, "down_payment_type": { "title": "Down payment (type)", "enum": [ "0", "1" ], "type": "string", "description": "", "default": "0" }, "insurance_rate": { "title": "Homeowners insurance (%)", "type": "string", "description": "", "default": "0.24" }, "hoa_fee": { "title": "HOA Fee", "enum": [ "", "0", "25", "50", "75", "100", "150", "200", "250", "300", "400", "500", "600", "700", "800", "900", "1000", "1250", "1500", "1750", "2000", "2500", "3000", "3500", "4000", "4500", "5000" ], "type": "string", "description": "" }, "taxes": { "title": "Property Taxes", "enum": [ "", "0", "250", "500", "750", "1000", "1250", "1500", "1750", "2000", "2500", "3000", "3500", "4000", "4500", "5000", "5500", "6000", "6500", "7000", "8000", "10000", "12000", "14000", "16000", "20000", "24000" ], "type": "string", "description": "" }, "min_price_ps": { "title": "Price/Sqft.", "type": "integer", "description": "" }, "max_price_ps": { "title": "", "type": "integer", "description": "" }, "financing": { "title": "Accepted financing", "enum": [ "1", "2" ], "type": "string", "description": "" }, "excl_ll": { "title": "Exclude land leases", "type": "boolean", "description": "In a land lease deal, you are purchasing the home but paying rent for the land to the landowner." }, "price_reduce": { "title": "Price Reduced", "enum": [ "1-", "3-", "7-", "14-", "30-", "-30", "-60", "-120" ], "type": "string", "description": "" }, "studio": { "title": "Studio", "type": "boolean", "description": "" }, "min_beds": { "title": "Beds", "type": "integer", "description": "" }, "max_beds": { "title": "", "type": "integer", "description": "" }, "num_baths": { "title": "Bathrooms", "type": "integer", "description": "" }, "min_sqft": { "title": "Home Size", "type": "integer", "description": "Square Feets" }, "max_sqft": { "title": "", "type": "integer", "description": "" }, "min_lot": { "title": "Lot Size", "type": "integer", "description": "Square Feets" }, "max_lot": { "title": "", "type": "integer", "description": "" }, "min_stories": { "title": "Stories", "type": "integer", "description": "" }, "max_stories": { "title": "", "type": "integer", "description": "" }, "num_garages": { "title": "Garages", "type": "integer", "description": "" }, "pool": { "title": "Pool Type", "enum": [ "0", "1", "2", "3", "4" ], "type": "string", "description": "" }, "excl_ar": { "title": "Exclude 55+ communities", "type": "boolean", "description": "" }, "parking": { "title": "Include outdoor parking", "type": "boolean", "description": "" }, "amenities.ac": { "title": "Air Conditioning", "type": "boolean", "description": "" }, "amenities.wf": { "title": "Waterfront", "type": "boolean", "description": "" }, "amenities.wd": { "title": "Washer/dryer hookup", "type": "boolean", "description": "" }, "amenities.view": { "title": "Has View", "type": "boolean", "description": "" }, "amenities.pets": { "title": "Pets Allowed", "type": "boolean", "description": "" }, "amenities.fireplace": { "title": "Fireplace", "type": "boolean", "description": "" }, "amenities.primarybed": { "title": "Primary bedroom on main floor", "type": "boolean", "description": "" }, "amenities.fixer": { "title": "Fixer-upper", "type": "boolean", "description": "" }, "amenities.rv": { "title": "RV parking", "type": "boolean", "description": "" }, "amenities.guest": { "title": "Guest House", "type": "boolean", "description": "" }, "amenities.green": { "title": "Green Home", "type": "boolean", "description": "" }, "amenities.elevator": { "title": "Elevator", "type": "boolean", "description": "" }, "amenities.accessible": { "title": "Accessible home", "type": "boolean", "description": "" }, "basement.finish": { "title": "Finished", "type": "boolean", "description": "" }, "basement.unfinish": { "title": "Unfinished", "type": "boolean", "description": "" }, "open_house": { "title": "Open house", "enum": [ "2", "1" ], "type": "string", "description": "" }, "video_tour": { "title": "3D walkthrough & video tour", "type": "boolean", "description": "" }, "walk_score": { "title": "Walk Score®", "type": "integer", "description": "0 - 100" }, "tran_score": { "title": "Transit Score®", "type": "integer", "description": "0 - 100" }, "bike_score": { "title": "Bike Score®", "type": "integer", "description": "0 - 100" }, "dev_proxy_config": { "title": "🌐 PROXY NETWORKING", "type": "object", "description": "💡 Supported protocol:

HTTP(S), SOCKS5
{http|socks5}://{user:pass}@{hostname|ip-address}:port

Example: socks5://example.com:9000" }, "dev_custom_headers": { "title": "📜 HTTP HEADERS", "type": "array", "description": "💡 Additional HTTP Headers", "items": { "type": "object", "required": [ "key", "value" ], "properties": { "key": { "type": "string", "title": "Key" }, "value": { "type": "string", "title": "Value" } } } }, "dev_custom_cookies": { "title": "🍰 HTTP COOKIES", "type": "array", "description": "💡 Additional HTTP Cookies", "items": { "type": "object", "required": [ "key", "value" ], "properties": { "key": { "type": "string", "title": "Key" }, "value": { "type": "string", "title": "Value" } } } }, "dev_transform_fields": { "title": "♻️ CUSTOM FIELD", "type": "array", "description": "💡 Transform the resulting output. Select only needed fields.

For nested object use DOT. For example: 
address.streetAddress

For nested array use NUMBER (index of array element starting from index=0). For example: 
images.0.url
", "items": { "type": "object", "required": [ "key", "value" ], "properties": { "key": { "type": "string", "title": "Key" }, "value": { "type": "string", "title": "Value" } } } }, "dev_dataset_name": { "title": "📁 CUSTOM STORAGE", "type": "string", "description": "💡 Save results into custom named Dataset, use mask to customize dataset name

{ACTOR} = actor name
{DATE} = date (YYYYMMDD)
{TIME} = time (HHMMSS)

This masks can be used to autogenerate Dataset Name.

example: data-{DATE}
Depending on today date the dataset name will be: data-20230603

default: data-{ACTOR}-{DATE}-{TIME}" }, "dev_dataset_clear": { "title": "Clear Storage", "type": "boolean", "description": "Clear Dataset before insert/update." }, "dev_no_strip": { "title": "Disable data cleansing", "type": "boolean", "description": "💡 Keep/Save empty values (NULL, FALSE, empty ARRAY, empty OBJECT, empty STRING)" } } }, "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 } } } } } } } } } }