{ "openapi": "3.0.1", "info": { "title": "Realtor.com Agent Directory Scraper", "description": "Scrape agent profiles from the realtor.com directory: photo, phone, brokerage, licence, ratings and sales stats. Export to CSV, Excel, JSON or XML.", "version": "0.2", "x-build-id": "aXJf47iGCwYNdVA7j" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~realtor-agent-directory-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-realtor-agent-directory-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/parseforge~realtor-agent-directory-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-realtor-agent-directory-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/parseforge~realtor-agent-directory-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-realtor-agent-directory-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": "Directory or profile URLs", "type": "array", "description": "Optional realtor.com agent directory URLs, for example https://www.realtor.com/realestateagents/austin_tx or https://www.realtor.com/realestateagents/austin_tx/sort-ratings/pg-2. Individual agent profile URLs work too. Filter segments in the URL (sort-, lang-, price-, agentname-, intent-, pg-) are read and applied. Leave empty to use the Locations field below.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchTerms": { "title": "Locations", "type": "array", "description": "Cities with a state, or 5 digit ZIP codes. Examples: \"Austin, TX\", \"Brooklyn, NY\", \"90210\". Each one is resolved through the realtor.com location lookup, so plain city names work. Ignored when Directory or profile URLs are given.", "items": { "type": "string" } }, "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Free users: Limited to 10 items (preview). Paid users: Optional, max 1,000,000" }, "agentName": { "title": "Agent name contains", "type": "string", "description": "Optional full text search on the agent name, for example \"Smith\". Combines with the location." }, "sortBy": { "title": "Sort by", "enum": [ "relevantagents", "activity", "activelistings", "ratings", "recommendations" ], "type": "string", "description": "Ordering used by the realtor.com directory itself. A URL that carries a sort- segment overrides this.", "default": "relevantagents" }, "agentType": { "title": "Agent works with", "enum": [ "any", "BUYER", "SELLER" ], "type": "string", "description": "Keep only agents that represent buyers or only agents that represent sellers.", "default": "any" }, "languages": { "title": "Languages spoken", "uniqueItems": true, "type": "array", "description": "Keep only agents who list one of these languages. Values come from the realtor.com language list.", "items": { "type": "string", "enum": [ "spanish", "chinese", "french", "amharic", "arabic", "aramaic", "portuguese", "hindi", "russian", "afrikaans", "albanian", "asl american sign language", "armenian", "bengali", "bosnian", "bulgarian", "croatian", "czech/slovak", "danish", "dutch", "english", "estonian", "farsi", "filipino", "finnish", "gaelic", "georgian", "german", "greek", "gujarati", "hawaiian", "hebrew", "hmong", "hungarian", "indonesian", "italian", "japanese", "khmer", "korean", "lao", "latvian", "lithuanian", "malay", "malayalam", "mandarin", "nepali", "norwegian", "pashto", "polish", "punjabi", "romanian", "serbian", "sindhi", "singhalese", "slovenian", "somali", "swahili", "swedish", "tagalog", "taiwanese", "tamil", "telugu", "thai", "turkish", "ukrainian", "urdu", "vietnamese", "yiddish", "yugoslavian" ], "enumTitles": [ "Spanish", "Chinese", "French", "Amharic", "Arabic", "Aramaic", "Portuguese", "Hindi", "Russian", "Afrikaans", "Albanian", "ASL American Sign Language", "Armenian", "Bengali", "Bosnian", "Bulgarian", "Croatian", "Czech/Slovak", "Danish", "Dutch", "English", "Estonian", "Farsi", "Filipino", "Finnish", "Gaelic", "Georgian", "German", "Greek", "Gujarati", "Hawaiian", "Hebrew", "Hmong", "Hungarian", "Indonesian", "Italian", "Japanese", "Khmer", "Korean", "Lao", "Latvian", "Lithuanian", "Malay", "Malayalam", "Mandarin", "Nepali", "Norwegian", "Pashto", "Polish", "Punjabi", "Romanian", "Serbian", "Sindhi", "Singhalese", "Slovenian", "Somali", "Swahili", "Swedish", "Tagalog", "Taiwanese", "Tamil", "Telugu", "Thai", "Turkish", "Ukrainian", "Urdu", "Vietnamese", "Yiddish", "Yugoslavian" ] } }, "priceMin": { "title": "Minimum listing price (USD)", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Keep only agents whose listing price range reaches this figure. Leave empty for no floor." }, "priceMax": { "title": "Maximum listing price (USD)", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Keep only agents whose listing price range stays under this figure. Leave empty for no ceiling." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "The realtor.com directory API answers plain HTTP requests, so the proxy is off by default. Switch it on for very large runs or if your network is rate limited.", "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 } } }, "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 } } } } } } } } } }