{ "openapi": "3.0.1", "info": { "title": "Realtor Scraper", "description": "Collect US Realtor.com listings from search links or locations, continue with saved batches, and monitor observed price and status changes. Includes nationwide search, optional history and datacenter-first proxy fallback.", "version": "0.1", "x-build-id": "dtk8bqAsj6VEWeQgv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/negligible_endive~realtor-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-negligible_endive-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/negligible_endive~realtor-scraper/runs": { "post": { "operationId": "runs-sync-negligible_endive-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/negligible_endive~realtor-scraper/run-sync": { "post": { "operationId": "run-sync-negligible_endive-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": { "startUrls": { "title": "Listing page links (optional)", "maxItems": 100, "type": "array", "description": "Paste Realtor.com search/results links, one per line. The Actor collects their next pages automatically, up to your property limit. Leave empty to search by location below or across the US. Property detail links are returned in the output; they are not accepted here.", "items": { "type": "string" } }, "maxRecords": { "title": "How many properties?", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum unique properties to collect in this run. Default 100. Request allowance, pacing and traffic caps are managed automatically. Leave location fields empty for a nationwide search. Base rates: $0.99 per 1,000 properties; delivered details +$0.25; successful non-empty history +$1. Silver receives 10% off; Gold and higher tiers receive 20% off. Your spending limit can lower this count.", "default": 100 }, "listingTypes": { "title": "What properties do you want?", "type": "array", "description": "Choose sale, rental or sold listings when searching by location. Pasted links determine their own listing category.", "items": { "type": "string", "enum": [ "for_sale", "for_rent", "sold" ], "enumTitles": [ "Homes for sale", "Homes for rent", "Recently sold homes" ] }, "default": [ "for_sale" ] }, "markets": { "title": "Cities, counties or ZIP codes (optional)", "maxItems": 100, "type": "array", "description": "Type one location per entry, including the state for cities and counties: Houston, TX or Harris County, TX. ZIP codes such as 77001 also work. Leave empty for a nationwide search or use States below. Choose listing links OR locations. An explicit location/state mismatch is rejected before scraping.", "items": { "type": "string" } }, "states": { "title": "States (optional)", "maxItems": 51, "type": "array", "description": "Leave empty for all states. Select one or more to narrow a nationwide search; also filters properties returned by your links or cities. A city, county or link that explicitly names a different state is rejected before scraping. For example, Houston, TX requires Texas or no state filter.", "items": { "type": "string", "enum": [ "AL", "AK", "AZ", "AR", "CA", "CO", "CT", "DE", "DC", "FL", "GA", "HI", "ID", "IL", "IN", "IA", "KS", "KY", "LA", "ME", "MD", "MA", "MI", "MN", "MS", "MO", "MT", "NE", "NV", "NH", "NJ", "NM", "NY", "NC", "ND", "OH", "OK", "OR", "PA", "RI", "SC", "SD", "TN", "TX", "UT", "VT", "VA", "WA", "WV", "WI", "WY" ], "enumTitles": [ "Alabama", "Alaska", "Arizona", "Arkansas", "California", "Colorado", "Connecticut", "Delaware", "District of Columbia", "Florida", "Georgia", "Hawaii", "Idaho", "Illinois", "Indiana", "Iowa", "Kansas", "Kentucky", "Louisiana", "Maine", "Maryland", "Massachusetts", "Michigan", "Minnesota", "Mississippi", "Missouri", "Montana", "Nebraska", "Nevada", "New Hampshire", "New Jersey", "New Mexico", "New York", "North Carolina", "North Dakota", "Ohio", "Oklahoma", "Oregon", "Pennsylvania", "Rhode Island", "South Carolina", "South Dakota", "Tennessee", "Texas", "Utah", "Vermont", "Virginia", "Washington", "West Virginia", "Wisconsin", "Wyoming" ] } }, "sortBy": { "title": "Sort listings", "enum": [ "price_asc", "price_desc", "newest", "oldest" ], "type": "string", "description": "Source sort within searches. Capped price-partitioned searches are samples, not complete market inventories.", "default": "price_asc" }, "minPrice": { "title": "Minimum Price", "minimum": 0, "type": "number", "description": "Optional inclusive bound. Price and HOA use USD; floor/lot size use square feet. Missing values do not match requested bounds." }, "maxPrice": { "title": "Maximum Price", "minimum": 0, "type": "number", "description": "Optional inclusive bound. Price and HOA use USD; floor/lot size use square feet. Missing values do not match requested bounds." }, "minBedrooms": { "title": "Minimum Bedrooms", "minimum": 0, "type": "number", "description": "Optional inclusive bound. Price and HOA use USD; floor/lot size use square feet. Missing values do not match requested bounds." }, "maxBedrooms": { "title": "Maximum Bedrooms", "minimum": 0, "type": "number", "description": "Optional inclusive bound. Price and HOA use USD; floor/lot size use square feet. Missing values do not match requested bounds." }, "minBathrooms": { "title": "Minimum Bathrooms", "minimum": 0, "type": "number", "description": "Optional inclusive bound. Price and HOA use USD; floor/lot size use square feet. Missing values do not match requested bounds." }, "maxBathrooms": { "title": "Maximum Bathrooms", "minimum": 0, "type": "number", "description": "Optional inclusive bound. Price and HOA use USD; floor/lot size use square feet. Missing values do not match requested bounds." }, "minSquareFeet": { "title": "Minimum Square Feet", "minimum": 0, "type": "number", "description": "Optional inclusive bound. Price and HOA use USD; floor/lot size use square feet. Missing values do not match requested bounds." }, "maxSquareFeet": { "title": "Maximum Square Feet", "minimum": 0, "type": "number", "description": "Optional inclusive bound. Price and HOA use USD; floor/lot size use square feet. Missing values do not match requested bounds." }, "minLotSquareFeet": { "title": "Minimum Lot Square Feet", "minimum": 0, "type": "number", "description": "Optional inclusive bound. Price and HOA use USD; floor/lot size use square feet. Missing values do not match requested bounds." }, "maxLotSquareFeet": { "title": "Maximum Lot Square Feet", "minimum": 0, "type": "number", "description": "Optional inclusive bound. Price and HOA use USD; floor/lot size use square feet. Missing values do not match requested bounds." }, "minYearBuilt": { "title": "Minimum Year Built", "minimum": 0, "type": "number", "description": "Optional inclusive bound. Price and HOA use USD; floor/lot size use square feet. Missing values do not match requested bounds." }, "maxYearBuilt": { "title": "Maximum Year Built", "minimum": 0, "type": "number", "description": "Optional inclusive bound. Price and HOA use USD; floor/lot size use square feet. Missing values do not match requested bounds." }, "minGarageSpaces": { "title": "Minimum Garage Spaces", "minimum": 0, "type": "number", "description": "Optional inclusive bound. Price and HOA use USD; floor/lot size use square feet. Missing values do not match requested bounds." }, "maxGarageSpaces": { "title": "Maximum Garage Spaces", "minimum": 0, "type": "number", "description": "Optional inclusive bound. Price and HOA use USD; floor/lot size use square feet. Missing values do not match requested bounds." }, "minHoaFee": { "title": "Minimum Hoa Fee", "minimum": 0, "type": "number", "description": "Optional inclusive bound. Price and HOA use USD; floor/lot size use square feet. Missing values do not match requested bounds." }, "maxHoaFee": { "title": "Maximum Hoa Fee", "minimum": 0, "type": "number", "description": "Optional inclusive bound. Price and HOA use USD; floor/lot size use square feet. Missing values do not match requested bounds." }, "amenities": { "title": "Amenities", "maxItems": 100, "type": "array", "description": "Optional filter. Text is case-insensitive. All amenities/keywords must match; any excluded keyword rejects the listing. States use two-letter codes; ZIP codes remain strings.", "items": { "type": "string" } }, "cities": { "title": "Cities", "maxItems": 100, "type": "array", "description": "Optional filter. Text is case-insensitive. All amenities/keywords must match; any excluded keyword rejects the listing. States use two-letter codes; ZIP codes remain strings.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Exclude keywords", "maxItems": 100, "type": "array", "description": "Optional filter. Text is case-insensitive. All amenities/keywords must match; any excluded keyword rejects the listing. States use two-letter codes; ZIP codes remain strings.", "items": { "type": "string" } }, "keywords": { "title": "Keywords", "maxItems": 100, "type": "array", "description": "Optional filter. Text is case-insensitive. All amenities/keywords must match; any excluded keyword rejects the listing. States use two-letter codes; ZIP codes remain strings.", "items": { "type": "string" } }, "postalCodes": { "title": "Postal codes", "maxItems": 100, "type": "array", "description": "Optional filter. Text is case-insensitive. All amenities/keywords must match; any excluded keyword rejects the listing. States use two-letter codes; ZIP codes remain strings.", "items": { "type": "string" } }, "propertyTypes": { "title": "Property types", "maxItems": 100, "type": "array", "description": "Optional property types: apartment, condo, condos, farm, land, mobile, multi_family, other, single_family, townhomes, townhouse.", "items": { "type": "string", "enum": [ "apartment", "condo", "condos", "farm", "land", "mobile", "multi_family", "other", "single_family", "townhomes", "townhouse" ] } }, "contingent": { "title": "Contingent", "enum": [ "any", "yes", "no" ], "type": "string", "description": "Any leaves this criterion unrestricted. Unknown source flags do not match yes or no.", "default": "any" }, "hasPhotos": { "title": "Has photos", "enum": [ "any", "yes", "no" ], "type": "string", "description": "Any leaves this criterion unrestricted. Unknown source flags do not match yes or no.", "default": "any" }, "newConstruction": { "title": "New construction", "enum": [ "any", "yes", "no" ], "type": "string", "description": "Any leaves this criterion unrestricted. Unknown source flags do not match yes or no.", "default": "any" }, "pending": { "title": "Pending", "enum": [ "any", "yes", "no" ], "type": "string", "description": "Any leaves this criterion unrestricted. Unknown source flags do not match yes or no.", "default": "any" }, "listedAfter": { "title": "Listed after", "type": "string", "description": "Optional inclusive ISO date/datetime, e.g. 2026-10-01T00:00:00Z. A date without time is midnight UTC." }, "listedBefore": { "title": "Listed before", "type": "string", "description": "Optional inclusive ISO date/datetime, e.g. 2026-10-01T00:00:00Z. A date without time is midnight UTC." }, "soldAfter": { "title": "Sold after", "type": "string", "description": "Optional inclusive ISO date/datetime, e.g. 2026-10-01T00:00:00Z. A date without time is midnight UTC." }, "soldBefore": { "title": "Sold before", "type": "string", "description": "Optional inclusive ISO date/datetime, e.g. 2026-10-01T00:00:00Z. A date without time is midnight UTC." }, "updatedAfter": { "title": "Updated after", "type": "string", "description": "Optional inclusive ISO date/datetime, e.g. 2026-10-01T00:00:00Z. A date without time is midnight UTC." }, "updatedBefore": { "title": "Updated before", "type": "string", "description": "Optional inclusive ISO date/datetime, e.g. 2026-10-01T00:00:00Z. A date without time is midnight UTC." }, "boundingBox": { "title": "Map bounds", "type": "object", "description": "Optional JSON with south, north, west, east coordinates. Missing coordinates do not match." }, "foreclosure": { "title": "Foreclosure", "enum": [ "any", "yes", "no" ], "type": "string", "description": "Passed to the source search as a foreclosure criterion. The source determines classification; no foreclosure flag is inferred in output.", "default": "any" }, "includeDetails": { "title": "Descriptions, amenities, HOA and open houses (+$0.25 / 1,000)", "type": "boolean", "description": "When paid pricing is active, adds $0.00025 per property only if at least one description, amenity, HOA fee or open-house entry is delivered. Partially populated groups can qualify. Missing descriptions get up to three recovery lookups, subject to source access and safety limits. Only matching property and listing IDs are accepted; recovery shares the first lookup with history when possible. Retries are not extra charge events. Silver receives 10% off this rate; Gold and higher tiers receive 20% off.", "default": false }, "includePhotos": { "title": "Photo URLs — included", "type": "boolean", "description": "Included in the base record price. Returns links only; image files are not downloaded.", "default": false }, "includeAgentDetails": { "title": "Public agent and broker details — included", "type": "boolean", "description": "Included in the base record price when selected and available from the source.", "default": false }, "includeHistory": { "title": "Source price and sale history (+$1 / 1,000)", "type": "boolean", "description": "When paid pricing is active, adds $0.001 per property only after successfully returning non-empty source history. Failed or empty histories have no add-on. Usually adds one request per property; the request allowance adjusts automatically. Source access and safety limits can reduce coverage. Silver receives 10% off this rate; Gold and higher tiers receive 20% off.", "default": false }, "maxPhotos": { "title": "Max photos", "minimum": 1, "maximum": 200, "type": "integer", "description": "Bounds retained photos or history events per property. Older observed history may be trimmed; firstSeenAt is retained.", "default": 25 }, "maxHistoryEntries": { "title": "Max history entries", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Bounds retained photos or history events per property. Older observed history may be trimmed; firstSeenAt is retained.", "default": 100 }, "resumeMode": { "title": "Batch continuation", "enum": [ "off", "continue", "restart" ], "type": "string", "description": "Off starts each search again for monitoring. Continue starts or resumes a saved session, skipping delivered IDs. For your first batch, leave the saved store empty: a progress store is saved automatically. Copy its ID or next-run input from Output → Resume instructions for the next batch. Restart replaces the session with a new scan; records can be billed again. Switch back to Continue after restarting.", "default": "off" }, "snapshotStoreId": { "title": "Saved progress / snapshot store (optional)", "type": "string", "description": "First run: leave empty. With Continue enabled, the Actor saves progress in a named store automatically and shows its ID in the logs and Output → Resume instructions. Later runs: select that same store or paste the ready-made next-run input. Reuse it for price history too." }, "changesOnly": { "title": "Export only observed changes", "type": "boolean", "description": "Only exports observed changes to the dataset. Billing still counts each unique matched property checked, including unchanged records; all observations remain in run storage.", "default": false }, "resumeKey": { "title": "Resume session key", "type": "string", "description": "Saved progress in your selected persistent store. Reuse for the next batch; use a separate key for each search. Must differ from snapshotKey. Reserved names such as INPUT, SUMMARY, RESUME_INFO, NEXT_RUN_INPUT and OBSERVATIONS-* are not allowed. Do not run simultaneous writers.", "default": "us-property-resume" }, "snapshotKey": { "title": "Snapshot record key", "type": "string", "description": "Monitoring snapshot in your saved store. Use a separate key for each tracker, different from resumeKey. Reserved output/input names and OBSERVATIONS-* or resume ID page keys are not allowed.", "default": "us-property-prices" }, "country": { "title": "Country", "pattern": "^US$", "type": "string", "description": "US listings only.", "default": "US" }, "proxyConfiguration": { "title": "Proxy connection (optional)", "type": "object", "description": "Enable Apify Proxy if direct access fails. Enabled runs always try datacenter first. Residential is used only after datacenter access denial or failed connection retries, with a traffic cap. Your group/country selections cannot override this policy. Requires proxy access; custom proxy URLs are unsupported." } } }, "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 } } } } } } } } } }