{ "openapi": "3.0.1", "info": { "title": "Realtor.com Property Listings Scraper", "description": "Extract Realtor.com property listings, full property details, photos, prices, agents, locations, similar homes, surroundings, and mortgage estimates from search results or known property IDs. Built for real estate leads, market research, and property data collection.", "version": "0.1", "x-build-id": "Lh3oYczs307jVyIIA" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlio~realtor-property-listings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlio-realtor-property-listings-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/crawlio~realtor-property-listings-scraper/runs": { "post": { "operationId": "runs-sync-crawlio-realtor-property-listings-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/crawlio~realtor-property-listings-scraper/run-sync": { "post": { "operationId": "run-sync-crawlio-realtor-property-listings-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": { "mode": { "title": "Mode", "enum": [ "search", "details", "mortgage" ], "type": "string", "description": "Choose the extraction profile. Search is the most common workflow.", "default": "search" }, "search": { "title": "Search input", "type": "object", "description": "Configure settings for listing search.", "properties": { "locations": { "title": "Locations", "type": "array", "description": "US locations to search, such as city/state, ZIP code, county, or neighborhood.", "default": [ "Austin, TX" ], "editor": "stringList", "items": { "type": "string" } }, "status": { "title": "Listing type", "type": "string", "description": "Type of Realtor.com listings to collect.", "default": "for_sale", "enum": [ "for_sale", "for_rent", "sold" ], "enumTitles": [ "For sale", "For rent", "Recently sold" ], "editor": "select" }, "maxResults": { "title": "Maximum listings per location", "type": "integer", "description": "Maximum number of listings to save for each location.", "default": 20, "minimum": 1, "maximum": 1000, "editor": "number" }, "resultsPerPage": { "title": "Results per upstream page", "type": "integer", "description": "Page size used internally. Higher values are faster; lower values can be more stable.", "default": 20, "minimum": 1, "maximum": 200, "editor": "number" }, "offset": { "title": "Start offset", "type": "integer", "description": "Number of listings to skip before collecting results.", "default": 0, "minimum": 0, "maximum": 9999, "editor": "number" }, "includePropertyDetails": { "title": "Include property details", "type": "boolean", "description": "Fetch the full details payload for each returned listing and attach it under propertyDetails. Charged per enriched listing and slower than normal search.", "default": false, "editor": "checkbox" }, "minPrice": { "title": "Minimum price", "type": "integer", "description": "Optional minimum listing price in USD.", "minimum": 0, "editor": "number" }, "maxPrice": { "title": "Maximum price", "type": "integer", "description": "Optional maximum listing price in USD.", "minimum": 0, "editor": "number" }, "includeReadyToBuild": { "title": "Include ready-to-build homes", "type": "boolean", "description": "Include ready-to-build new construction results when listing type is For sale.", "default": true, "editor": "checkbox" }, "includeBoundary": { "title": "Include search boundary", "type": "boolean", "description": "Ask Realtor.com for boundary data on the first page. This does not change listing records.", "default": false, "editor": "checkbox" } }, "default": { "locations": [ "Austin, TX" ], "status": "for_sale", "maxResults": 20, "resultsPerPage": 20, "offset": 0, "includePropertyDetails": false, "includeReadyToBuild": true, "includeBoundary": false }, "additionalProperties": false }, "details": { "title": "Property details input", "type": "object", "description": "Configure settings for single property details.", "properties": { "propertyId": { "title": "Property ID", "type": "string", "description": "Realtor.com property ID.", "default": "4405180267", "editor": "textfield" }, "listingId": { "title": "Listing ID (optional)", "type": "string", "description": "Optional Realtor.com listing ID for exact listing matching.", "default": "", "editor": "textfield" }, "enrichSurroundings": { "title": "Get Property Surroundings", "type": "boolean", "description": "Fetch flood, noise, and local surroundings data. Charged as a details add-on.", "default": false, "editor": "checkbox" }, "enrichSimilarHomes": { "title": "Get Similar Homes", "type": "boolean", "description": "Fetch comparable nearby homes. Charged as a details add-on.", "default": false, "editor": "checkbox" }, "similarHomesLimit": { "title": "Similar homes limit", "type": "integer", "description": "Maximum similar homes to return when Get Similar Homes is enabled.", "default": 12, "minimum": 1, "maximum": 50, "editor": "number" } }, "default": { "propertyId": "4405180267", "listingId": "", "enrichSurroundings": false, "enrichSimilarHomes": false, "similarHomesLimit": 12 }, "additionalProperties": false }, "mortgage": { "title": "Mortgage input", "type": "object", "description": "Configure settings for mortgage calculation.", "properties": { "mortgagePrice": { "title": "Property price", "type": "integer", "description": "Property price in USD.", "default": 500000, "minimum": 1, "editor": "number" }, "mortgageDownPayment": { "title": "Down payment", "type": "integer", "description": "Down payment in USD. Defaults to 20% of the property price when omitted.", "default": 100000, "minimum": 0, "editor": "number" }, "mortgageTaxRate": { "title": "Tax rate", "type": "number", "description": "Annual property tax rate.", "default": 0.006, "minimum": 0, "editor": "number" }, "mortgageInterestRate": { "title": "Interest rate", "type": "number", "description": "Annual mortgage interest rate.", "default": 0.065, "minimum": 0, "editor": "number" }, "propertyId": { "title": "Property ID (optional)", "type": "string", "description": "Optional Realtor.com property ID. Used only when property price is omitted.", "default": "", "editor": "textfield" }, "listingId": { "title": "Listing ID (optional)", "type": "string", "description": "Optional Realtor.com listing ID for exact price lookup when property price is omitted.", "default": "", "editor": "textfield" } }, "default": { "mortgagePrice": 500000, "mortgageDownPayment": 100000, "mortgageTaxRate": 0.006, "mortgageInterestRate": 0.065 }, "additionalProperties": 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 } } }, "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 } } } } } } } } } }