{ "openapi": "3.0.1", "info": { "title": "Realtor.com US Property Listings Scraper", "description": "Search Realtor.com property listings across the United States by city, state, or ZIP. Get homes for sale, rent, or sold with prices, beds, baths, photos, location data, optional property details, and listing history.", "version": "0.4", "x-build-id": "K7YQR8XM4s9vJ2qr4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datascraperes~realtor-property-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datascraperes-realtor-property-search", "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/datascraperes~realtor-property-search/runs": { "post": { "operationId": "runs-sync-datascraperes-realtor-property-search", "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/datascraperes~realtor-property-search/run-sync": { "post": { "operationId": "run-sync-datascraperes-realtor-property-search", "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", "required": [ "locations" ], "properties": { "locations": { "title": "Locations", "minItems": 1, "maxItems": 1000, "type": "array", "description": "Add each search area as a simple form. Enter city and state together, a ZIP code, or only a state code. Leave unused fields blank.", "items": { "type": "object", "additionalProperties": false, "properties": { "stateCode": { "title": "State code", "description": "Two-letter US state code, for example TX. Required when entering a city.", "type": "string", "editor": "textfield", "pattern": "^[A-Za-z]{2}$" }, "city": { "title": "City", "description": "City name. Also enter its state code.", "type": "string", "editor": "textfield", "minLength": 1, "maxLength": 100 }, "postalCode": { "title": "ZIP code", "description": "Five-digit US ZIP code, optionally followed by a four-digit extension.", "type": "string", "editor": "textfield", "pattern": "^\\d{5}(?:-\\d{4})?$" } } } }, "listingStatuses": { "title": "Listing statuses", "minItems": 1, "maxItems": 3, "uniqueItems": true, "type": "array", "description": "Choose purchase, rental, or recently sold properties.", "items": { "type": "string", "enum": [ "for_sale", "for_rent", "sold" ], "enumTitles": [ "For sale", "For rent", "Recently sold" ] }, "default": [ "for_sale" ] }, "minPrice": { "title": "Minimum price", "minimum": 0, "type": "integer", "description": "Lowest listing price to include." }, "maxPrice": { "title": "Maximum price", "minimum": 0, "type": "integer", "description": "Highest listing price to include." }, "minBeds": { "title": "Minimum bedrooms", "minimum": 0, "type": "number", "description": "Minimum bedroom count." }, "minBaths": { "title": "Minimum bathrooms", "minimum": 0, "type": "number", "description": "Minimum bathroom count." }, "propertyTypes": { "title": "Property types", "minItems": 1, "maxItems": 25, "uniqueItems": true, "type": "array", "description": "Optional Realtor property-type values, for example single_family.", "items": { "type": "string", "minLength": 1, "maxLength": 50, "pattern": "^[a-z0-9_]+$" } }, "maxResultsPerLocation": { "title": "Maximum results per location", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Stop after this many unique properties for each location.", "default": 100 }, "maxTotalResults": { "title": "Maximum total results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Hard run-wide result limit across all locations. Apify's maximum charge per run can impose a lower billing limit.", "default": 1000 }, "outputMode": { "title": "Output mode", "enum": [ "compact", "standard", "full" ], "type": "string", "description": "Choose compact, standard, or the richest listing record.", "default": "full" }, "fetchDetails": { "title": "Fetch property details", "type": "boolean", "description": "Add a detail lookup for every returned property.", "default": false }, "fetchHistory": { "title": "Fetch property event history", "type": "boolean", "description": "Add listing event history for every returned property. Automatically enables property details.", "default": false }, "requestDelaySeconds": { "title": "Delay between requests", "minimum": 0, "maximum": 10, "type": "number", "description": "Pause between paginated search requests.", "default": 0.2 } } }, "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 } } } } } } } } } }