{ "openapi": "3.0.1", "info": { "title": "Realtor.com Scraper - Homes for Sale & Rent Data", "description": "Collect US Realtor.com homes for sale and rent by city, ZIP, or listing URL. Get prices, property details, photos, and available agent contacts. Pay per delivered listing row plus a start fee.", "version": "0.3", "x-build-id": "EGP8TIyD4HSDmxNY5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~realtor-com-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-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/lentic_clockss~realtor-com-scraper/runs": { "post": { "operationId": "runs-sync-lentic_clockss-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/lentic_clockss~realtor-com-scraper/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-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": { "location": { "title": "Location", "maxLength": 120, "type": "string", "description": "US city and state or ZIP, e.g. 'Austin, TX' or '78701'. Leave empty when you fill in Detail URLs." }, "detailUrls": { "title": "Detail URLs (optional)", "type": "array", "description": "Realtor.com listing URLs ending with a property identifier such as _M12345-67890; use real listing links, not search pages. Each URL is an input with its own maxResults allowance and takes precedence over location search.", "items": { "type": "string", "pattern": "^https?://([A-Za-z0-9-]+\\.)*realtor\\.com([/?#]|$)" } }, "maxResults": { "title": "Maximum listings per input", "minimum": 1, "maximum": 200, "type": "integer", "description": "Maximum listings for each location or supplied detail URL (1–200; split across sale and rent when listingType is both). The default is 70. The whole run still stops at the free-plan quota or your maximum charge limit.", "default": 70 }, "listingType": { "title": "Listing type", "enum": [ "sale", "rent", "both" ], "type": "string", "description": "Scrape for-sale listings, rentals, or both.", "default": "sale" }, "propertyTypes": { "title": "Property types", "uniqueItems": true, "type": "array", "description": "Optional residential property-type filters (multi-select). Leave empty for all types. Full set: house, condo, townhouse, multi_family, mobile, farm, land, apartment.", "items": { "type": "string", "enum": [ "house", "condo", "townhouse", "multi_family", "mobile", "farm", "land", "apartment" ], "enumTitles": [ "House", "Condo", "Townhouse", "Multi-family", "Mobile / manufactured", "Farm / ranch", "Land", "Apartment" ] }, "default": [] }, "propertyType": { "title": "Property type (legacy single)", "enum": [ "", "house", "condo", "townhouse", "multi_family", "mobile", "farm", "land", "apartment" ], "type": "string", "description": "Legacy single property-type filter. Prefer propertyTypes. Merged with propertyTypes when both are set.", "default": "" }, "minPrice": { "title": "Min price ($)", "minimum": 0, "type": "integer", "description": "Optional minimum list price or rent in USD." }, "maxPrice": { "title": "Max price ($)", "minimum": 0, "type": "integer", "description": "Optional maximum list price or rent in USD." }, "enrichDetails": { "title": "Enrich details", "type": "boolean", "description": "Add available detail-page information, such as fees, history, photos, and contacts, to search results. Enabled by default; specific listing URLs always fetch details.", "default": true }, "includeRaw": { "title": "Include raw payload", "type": "boolean", "description": "Attach source property data under raw when enabled; this increases row size. Off by default, with embedded unit data capped at 5.", "default": false }, "workerBaseUrl": { "title": "Developer testing setting", "type": "string", "description": "Leave empty. Used only by the developer for testing.", "default": "" } } }, "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 } } } } } } } } } }