{ "openapi": "3.0.1", "info": { "title": "Realtor.com Scraper", "description": "Search Realtor.com property listings by city, ZIP code, or URL. Export prices, addresses, home features, descriptions, photos, and optional detail data.", "version": "0.1", "x-build-id": "UzGcaemeMubjfnos9" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mlg14~realtor-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mlg14-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/mlg14~realtor-scraper/runs": { "post": { "operationId": "runs-sync-mlg14-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/mlg14~realtor-scraper/run-sync": { "post": { "operationId": "run-sync-mlg14-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": "Search locations", "maxItems": 50, "type": "array", "description": "Cities in City, ST format or five-digit ZIP codes. Each location is searched for property listings.", "items": { "type": "string" } }, "startUrls": { "title": "Property search or detail URLs", "maxItems": 50, "type": "array", "description": "Property search URLs use their city and state or ZIP location. Additional filters encoded in a search URL are not applied; use the fields below. Property detail URLs return one listing.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Maximum listings", "minimum": 0, "type": "integer", "description": "Maximum output rows across every location. Set 0 for no output cap; the page limit still applies.", "default": 100 }, "maxPages": { "title": "Maximum pages per location", "minimum": 1, "maximum": 300, "type": "integer", "description": "Stop after this many 30-listing pages per location.", "default": 20 }, "priceMin": { "title": "Minimum list price", "minimum": 0, "type": "integer", "description": "Only output listings at or above this price in USD. Filtered by realtor.com itself." }, "priceMax": { "title": "Maximum list price", "minimum": 0, "type": "integer", "description": "Only output listings at or below this price in USD. Filtered by realtor.com itself." }, "bedsMin": { "title": "Minimum bedrooms", "minimum": 0, "type": "number", "description": "Only output listings with at least this many bedrooms. Filtered by realtor.com itself." }, "bathsMin": { "title": "Minimum bathrooms", "minimum": 0, "type": "number", "description": "Only output listings with at least this many bathrooms. Filtered by realtor.com itself." }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Optional property types. Empty includes every type. Filtered by realtor.com itself.", "items": { "type": "string", "enum": [ "single_family", "condos", "townhomes", "multi_family", "mobile", "land", "farm", "duplex_triplex", "coop", "apartment" ], "enumTitles": [ "Single family", "Condos", "Townhomes", "Multi-family", "Mobile / manufactured", "Land", "Farm / ranch", "Duplex / triplex", "Co-op", "Apartment" ] }, "default": [] }, "statuses": { "title": "Listing statuses", "type": "array", "description": "Listing statuses to include. Defaults to for_sale when empty; rentals only appear when you add for_rent. Filtered by realtor.com itself.", "items": { "type": "string", "enum": [ "for_sale", "for_rent", "sold", "pending", "contingent" ], "enumTitles": [ "For sale", "For rent", "Sold", "Pending", "Contingent" ] }, "default": [ "for_sale" ] }, "includeDetails": { "title": "Fetch property details", "type": "boolean", "description": "Request each property's detail record to add more photo URLs and reported days on market. This adds one request per accepted listing.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Use the default proxy configuration or supply your own proxy settings.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }