{ "openapi": "3.0.1", "info": { "title": "Realtor Autocomplete Scraper (Cheap)", "description": "Realtor.com location autocomplete scraper that returns addresses, cities, ZIP codes, schools, and neighborhoods for any search query, so developers can build autofill UIs and validate locations affordably.", "version": "0.0", "x-build-id": "IAOePEpc74aYSoJdU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/data_api~realtor-autocomplete-scraper-cheap/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-data_api-realtor-autocomplete-scraper-cheap", "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/data_api~realtor-autocomplete-scraper-cheap/runs": { "post": { "operationId": "runs-sync-data_api-realtor-autocomplete-scraper-cheap", "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/data_api~realtor-autocomplete-scraper-cheap/run-sync": { "post": { "operationId": "run-sync-data_api-realtor-autocomplete-scraper-cheap", "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": [ "searchTerms" ], "properties": { "searchTerms": { "title": "Search terms", "type": "array", "description": "One or more things to look up. Every term fires its own autocomplete request, so you can mix partial addresses, town names, ZIP codes, neighborhoods, or schools in a single run — whatever you'd type into the Realtor.com search box. For instance: ['Seattle', '742 Evergreen Terrace', '60614', 'Denver CO', 'Harvard University'].", "items": { "type": "string" } }, "resultsLimit": { "title": "Suggestions per term", "minimum": 1, "maximum": 10000, "type": "integer", "description": "How many suggestions to keep for each search term. Realtor.com can hand back thousands, but in practice a term usually has 10 to 50 worthwhile hits. We default to 50 here. Bump it to 5 if you only want the top picks.", "default": 50 }, "showAddresses": { "title": "Street addresses", "type": "boolean", "description": "Bring back specific street addresses, like '123 Main St, Springfield, IL'. On by default.", "default": true }, "showNeighborhoods": { "title": "Neighborhoods", "type": "boolean", "description": "Bring back named neighborhoods and subdivisions, such as 'SoHo, New York, NY'. On by default.", "default": true }, "showCities": { "title": "Cities", "type": "boolean", "description": "Bring back city-wide matches, such as 'Houston, TX'. On by default.", "default": true }, "showCounties": { "title": "Counties", "type": "boolean", "description": "Bring back county-wide matches, such as 'Los Angeles County, CA'. On by default.", "default": true }, "showZipCodes": { "title": "ZIP codes", "type": "boolean", "description": "Bring back ZIP and postal code hits, such as '90210'. On by default.", "default": true }, "showStreets": { "title": "Whole streets", "type": "boolean", "description": "Bring back full-street matches with no house number, such as 'Sunset Blvd, Los Angeles, CA'. On by default.", "default": true }, "showSchools": { "title": "Schools", "type": "boolean", "description": "Bring back individual schools, such as 'Lincoln High School, Portland, OR'. On by default.", "default": true }, "showSchoolDistricts": { "title": "School districts", "type": "boolean", "description": "Bring back school district matches, such as 'Los Angeles Unified School District'. On by default.", "default": true }, "showUniversities": { "title": "Universities", "type": "boolean", "description": "Bring back colleges and universities, such as 'Stanford University, Stanford, CA'. On by default.", "default": true }, "showParks": { "title": "Parks", "type": "boolean", "description": "Bring back parks and recreation areas, such as 'Central Park, New York, NY'. On by default.", "default": true }, "showStates": { "title": "States", "type": "boolean", "description": "Bring back state-wide matches, such as 'California'. On by default.", "default": true }, "showMlsIds": { "title": "MLS IDs", "type": "boolean", "description": "Bring back MLS listing ID matches, such as 'OC22183456'. On by default.", "default": true }, "runTimeoutSeconds": { "title": "Whole-run timeout (seconds)", "minimum": 30, "maximum": 3600, "type": "integer", "description": "The longest the run is allowed to take, in seconds. Once this is hit the actor wraps up whatever it has. Defaults to 300 (five minutes); push it to 600 for bigger batches.", "default": 300 }, "requestTimeoutSeconds": { "title": "Per-request timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "How long to wait on Realtor.com's autocomplete server for any single term before giving up. Defaults to 45 seconds.", "default": 45 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Which proxies to route requests through. Out of the box this uses Apify's US datacenter proxies." } } }, "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 } } } } } } } } } }