{ "openapi": "3.0.1", "info": { "title": "Realtor.com Scraper", "description": "Scrape Realtor.com property listings for sale, for rent and recently sold: price, beds, baths, sqft, address, agent contacts, photos, price and tax history, schools, value estimates and climate risk scores.", "version": "1.0", "x-build-id": "ftmOpz1dVisgZzjOn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parsebird~realtor-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parsebird-realtor-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/parsebird~realtor-scraper/runs": { "post": { "operationId": "runs-sync-parsebird-realtor-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/parsebird~realtor-scraper/run-sync": { "post": { "operationId": "run-sync-parsebird-realtor-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": { "searchLocations": { "title": "Locations", "type": "array", "description": "Enter a city and state (\"Austin, TX\"), a ZIP code (\"78701\"), a neighborhood (\"Zilker, Austin, TX\"), a county (\"Travis County, TX\"), a state (\"Texas\") or a street address. Each location runs as its own search with the filters below.", "items": { "type": "string" } }, "startUrls": { "title": "Realtor.com URLs", "type": "array", "description": "Paste Realtor.com search-results URLs (e.g. https://www.realtor.com/realestateandhomes-search/Austin_TX) or property pages (e.g. https://www.realtor.com/realestateandhomes-detail/...). The URL type is detected automatically. Search URLs keep their own location, listing status and filters (property type, price, beds, baths, sqft, lot size); the Search filters section below applies to Locations only.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "listingStatus": { "title": "Listing status", "enum": [ "for_sale", "for_rent", "recently_sold" ], "type": "string", "description": "Pick which listings to search for the Locations above. Recently sold returns the most recent sales first.", "default": "for_sale" }, "propertyType": { "title": "Property type", "enum": [ "all", "single_family", "condos", "townhomes", "multi_family", "land", "mobile", "farm" ], "type": "string", "description": "Limit the Locations searches to one type of property.", "default": "all" }, "maxItems": { "title": "Max properties", "minimum": 0, "type": "integer", "description": "Maximum number of properties to return in total, shared across all locations and URLs. Set 0 for no limit. Start with 10-50 to test.", "default": 100 }, "includePropertyDetails": { "title": "Include property details", "type": "boolean", "description": "Load each property page for schools, price and tax history, mortgage estimate, environmental risk scores (flood, fire, heat, wind, air) and the full feature list. Billed as an extra event per property. Turn off for search-result data only (price, address, beds, baths, agent, photos, value estimates).", "default": true }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional proxy to send requests through.", "default": { "useApifyProxy": 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 }, "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 } } } } } } } } } }