{ "openapi": "3.0.1", "info": { "title": "Realtor.com Listings & Property Details Scraper", "description": "Collect US homes for sale, for rent and recently sold from Realtor.com by city, ZIP code or search link. Each row has price, beds, baths, size, lot, address, coordinates, status, list date, photos and the listing agent; optional details add description, history, taxes and schools.", "version": "0.1", "x-build-id": "xkDvF9gAlHyeYnr6o" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/barefoot_grade~realtor-com-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-barefoot_grade-realtor-com-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/barefoot_grade~realtor-com-scraper/runs": { "post": { "operationId": "runs-sync-barefoot_grade-realtor-com-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/barefoot_grade~realtor-com-scraper/run-sync": { "post": { "operationId": "run-sync-barefoot_grade-realtor-com-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 places to search: a city and state (Austin, TX), a ZIP code (78704), a county (Travis County, TX) or a neighborhood (Hyde Park, Austin, TX). Each location is one search.", "items": { "type": "string", "minLength": 1, "maxLength": 120 }, "default": [] }, "status": { "title": "Listing status", "enum": [ "for_sale", "for_rent", "sold" ], "type": "string", "description": "Which listings the locations search: for sale, for rent, or sold. Search links set their own status.", "default": "for_sale" }, "startUrls": { "title": "Realtor.com links or property IDs", "type": "array", "description": "Realtor.com search links (realestateandhomes-search/..., apartments/..., including filters such as beds-3 or price-300000-500000) and property links (realestateandhomes-detail/...) or property IDs. Property links always include full details.", "items": { "type": "string", "minLength": 1 }, "default": [] }, "minPrice": { "title": "Minimum price", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Lowest list price (monthly rent for rentals; sold price for sold homes), in US dollars." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Highest list price (monthly rent for rentals; sold price for sold homes), in US dollars." }, "minBeds": { "title": "Minimum bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Fewest bedrooms." }, "maxBeds": { "title": "Maximum bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Most bedrooms." }, "minBaths": { "title": "Minimum bathrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Fewest bathrooms." }, "minSqft": { "title": "Minimum living area", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Smallest interior area, in square feet." }, "maxSqft": { "title": "Maximum living area", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Largest interior area, in square feet." }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Only these home types. Leave empty for all.", "items": { "type": "string", "enum": [ "single_family", "condos", "townhomes", "multi_family", "land", "mobile", "farm" ], "enumTitles": [ "Single-family house", "Condo", "Townhome", "Multi-family", "Land", "Mobile home", "Farm or ranch" ] }, "default": [] }, "listedWithinDays": { "title": "Listed within (days)", "minimum": 1, "maximum": 3650, "type": "integer", "description": "For sale and for rent searches: only listings added in the last N days." }, "soldWithinDays": { "title": "Sold within (days)", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Sold searches: only homes sold in the last N days." }, "sort": { "title": "Sort order", "enum": [ "newest", "price_low", "price_high" ], "type": "string", "description": "Newest first (most recently listed, or most recently sold for sold searches), or by price.", "default": "newest" }, "includeDetails": { "title": "Include property details", "type": "boolean", "description": "Also read each listing's property page data: full description, features, price history, tax history, nearby schools, neighborhoods and every value estimate. Slower, same price per row.", "default": false }, "maxItemsPerSearch": { "title": "Maximum results per search", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Cap for each location or search link. Realtor.com shows at most 10,000 results per search; add filters to split a larger area.", "default": 200 }, "maxItems": { "title": "Maximum results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Cap on rows for the whole run, across every search and property.", "default": 1000 } } }, "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 } } } } } } } } } }