{ "openapi": "3.0.1", "info": { "title": "Toll Brothers Scraper", "description": "Scrape luxury new-construction home communities, floor plans, and quick-move-in homes from Toll Brothers across 78 US states and metro areas.", "version": "1.0", "x-build-id": "dQ99j6BksPb25X14W" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~toll-brothers-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-toll-brothers-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/crawlerbros~toll-brothers-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-toll-brothers-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/crawlerbros~toll-brothers-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-toll-brothers-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "byLocation", "communityDetails" ], "type": "string", "description": "What to fetch.", "default": "byLocation" }, "location": { "title": "State / metro area (mode=byLocation)", "enum": [ "Arizona", "Atlanta-GA", "Austin-TX", "Boca-Raton-FL", "Boise-ID", "Boston-MA", "California", "Central-New-Jersey-NJ", "Charleston-SC", "Charlotte-NC", "Colorado", "Colorado-Springs-CO", "Connecticut", "Dallas-Fort-Worth-TX", "Denver-CO", "Detroit-MI", "Fairfield-County-CT", "Florida", "Fort-Collins-CO", "Georgia", "Greenville-SC", "Hilton-Head-SC", "Houston-TX", "Idaho", "Inland-Empire-CA", "Jacksonville-FL", "Las-Vegas-NV", "Long-Island-NY", "Los-Angeles-CA", "Maryland", "Massachusetts", "Michigan", "Montgomery-County-MD", "Myrtle-Beach-SC", "Naples-FL", "Nashville-TN", "Nevada", "New-Jersey", "New-York", "New-York-NY", "North-Carolina", "Northern-New-Jersey-NJ", "Northern-Virginia-VA", "Orange-County-CA", "Oregon", "Orlando-FL", "Palm-Coast-FL", "Palm-Springs-CA", "Panama-City-Beach-FL", "Pennsylvania", "Philadelphia-PA", "Phoenix-AZ", "Portland-OR", "Raleigh-NC", "Reno-NV", "Sacramento-CA", "Salt-Lake-City-UT", "San-Antonio-TX", "San-Diego-CA", "San-Francisco-CA", "San-Jose-CA", "Sarasota-FL", "Seattle-WA", "Sedona-AZ", "South-Carolina", "Spokane-WA", "Tampa-FL", "Tennessee", "Texas", "Utah", "Vancouver-WA", "Ventura-County-CA", "Virginia", "Washington", "Washington-DC", "Westchester-NY", "West-Palm-Beach-FL", "Wilmington-NC" ], "type": "string", "description": "US state or metro area to search for communities.", "default": "Florida" }, "communityUrls": { "title": "Community URLs (mode=communityDetails)", "type": "array", "description": "Toll Brothers community page URLs, e.g. `https://www.tollbrothers.com/luxury-homes-for-sale/Florida/Bartram-Ranch` (use the `communityUrl` field from mode=byLocation output).", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "includeFloorPlans": { "title": "Include floor plans", "type": "boolean", "description": "Emit a record per available floor-plan model (mode=communityDetails).", "default": true }, "includeQuickMoveIns": { "title": "Include quick move-in homes", "type": "boolean", "description": "Emit a record per already-built, move-in-ready home currently for sale (mode=communityDetails).", "default": true }, "minPrice": { "title": "Min price (USD)", "minimum": 0, "maximum": 20000000, "type": "number", "description": "Drop records priced below this." }, "maxPrice": { "title": "Max price (USD)", "minimum": 0, "maximum": 20000000, "type": "number", "description": "Drop records priced above this." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "maximum": 20, "type": "number", "description": "Drop records with fewer bedrooms than this." }, "qdhOnly": { "title": "Only communities with quick-delivery homes", "type": "boolean", "description": "Mode=byLocation only. Only keep communities that currently have quick-delivery/move-in-ready inventory.", "default": false }, "excludeFuture": { "title": "Exclude future (not-yet-open) communities", "type": "boolean", "description": "Mode=byLocation only. Drop communities still marked as upcoming/future.", "default": false }, "homeTypes": { "title": "Home types (mode=byLocation)", "uniqueItems": true, "type": "array", "description": "Only keep communities offering at least one of these home types.", "items": { "type": "string", "enum": [ "Single Family", "Townhome", "Condo" ], "enumTitles": [ "Single Family", "Townhome", "Condo" ] }, "default": [] }, "communityTypes": { "title": "Community types (mode=byLocation)", "uniqueItems": true, "type": "array", "description": "Only keep communities tagged with at least one of these community types.", "items": { "type": "string", "enum": [ "Luxury Home", "Amenities/Resort", "Active Adult", "Waterfront", "Golf", "City Living", "Future Community" ], "enumTitles": [ "Luxury Home", "Amenities/Resort", "Active Adult (55+)", "Waterfront", "Golf", "City Living", "Future Community" ] }, "default": [] }, "sortBy": { "title": "Sort order (mode=byLocation)", "enum": [ "default", "priceLowToHigh", "priceHighToLow", "mostBedrooms" ], "type": "string", "description": "Order communities before applying maxItems.", "default": "default" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on emitted records.", "default": 100 } } }, "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 } } } } } } } } } }