{ "openapi": "3.0.1", "info": { "title": "Realtor Auto Suggestion (AutoFill)", "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": "8N96Tf7glMiaU9NMb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kawsar~realtor-auto-suggestion/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kawsar-realtor-auto-suggestion", "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/kawsar~realtor-auto-suggestion/runs": { "post": { "operationId": "runs-sync-kawsar-realtor-auto-suggestion", "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/kawsar~realtor-auto-suggestion/run-sync": { "post": { "operationId": "run-sync-kawsar-realtor-auto-suggestion", "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": [ "queries" ], "properties": { "queries": { "title": "Search queries", "type": "array", "description": "One or more location search terms to look up. Each query triggers a separate autocomplete call. You can search for partial addresses, city names, ZIP codes, neighborhoods, schools, or anything you would type into the Realtor.com search bar. Example: ['New York', '11150 Glenoaks', '90210', 'Austin TX', 'Stanford University'].", "items": { "type": "string" } }, "limit": { "title": "Max suggestions per query", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of autocomplete suggestions to return per search query. The Realtor.com API can return up to 10,000 suggestions per query, but most queries only have 10-50 useful matches. Default is 100. Example: 50 for quick lookups.", "default": 100 }, "includeAddress": { "title": "Include addresses", "type": "boolean", "description": "Include specific street addresses in the autocomplete results. Example: '123 Main St, Springfield, IL'. Default is enabled.", "default": true }, "includeNeighborhood": { "title": "Include neighborhoods", "type": "boolean", "description": "Include named neighborhoods and subdivisions. Example: 'SoHo, New York, NY'. Default is enabled.", "default": true }, "includeCity": { "title": "Include cities", "type": "boolean", "description": "Include city-level results. Example: 'Houston, TX'. Default is enabled.", "default": true }, "includeCounty": { "title": "Include counties", "type": "boolean", "description": "Include county-level results. Example: 'Los Angeles County, CA'. Default is enabled.", "default": true }, "includePostalCode": { "title": "Include postal codes", "type": "boolean", "description": "Include ZIP/postal code results. Example: '90210'. Default is enabled.", "default": true }, "includeStreet": { "title": "Include streets", "type": "boolean", "description": "Include whole-street results (without a specific house number). Example: 'Sunset Blvd, Los Angeles, CA'. Default is enabled.", "default": true }, "includeSchool": { "title": "Include schools", "type": "boolean", "description": "Include individual schools. Example: 'Lincoln High School, Portland, OR'. Default is enabled.", "default": true }, "includeSchoolDistrict": { "title": "Include school districts", "type": "boolean", "description": "Include school district results. Example: 'Los Angeles Unified School District'. Default is enabled.", "default": true }, "includeUniversity": { "title": "Include universities", "type": "boolean", "description": "Include college and university results. Example: 'Stanford University, Stanford, CA'. Default is enabled.", "default": true }, "includePark": { "title": "Include parks", "type": "boolean", "description": "Include parks and recreation areas. Example: 'Central Park, New York, NY'. Default is enabled.", "default": true }, "includeState": { "title": "Include states", "type": "boolean", "description": "Include state-level results. Example: 'California'. Default is enabled.", "default": true }, "includeMlsId": { "title": "Include MLS IDs", "type": "boolean", "description": "Include MLS listing ID matches. Example: 'OC22183456'. Default is enabled.", "default": true }, "timeoutSecs": { "title": "Overall timeout (seconds)", "minimum": 30, "maximum": 3600, "type": "integer", "description": "Maximum runtime for the entire actor in seconds. The actor stops when this time is exceeded. Default is 300 (5 minutes). Example: 600 for larger batches.", "default": 300 }, "requestTimeoutSecs": { "title": "Per-request timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Maximum time to wait for the Realtor.com autocomplete server per query. Default is 30 seconds.", "default": 30 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings for requests. Default uses Apify 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 } } } } } } } } } }