{ "openapi": "3.0.1", "info": { "title": "United Real Estate Homes for Sale Scraper", "description": "Search United Real Estate for homes for sale by city, state, ZIP code, or keyword. Filter by property type, listing status, price, beds/baths, and size. Get address, price, beds/baths/sqft, photo, listing status, and listing brokerage.", "version": "1.0", "x-build-id": "r4mYj9IGqw30sGzUr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~united-real-estate-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-united-real-estate-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~united-real-estate-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-united-real-estate-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~united-real-estate-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-united-real-estate-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": { "city": { "title": "City", "type": "string", "description": "City to search, e.g. `Austin`. Leave blank to search by ZIP code or keyword instead." }, "state": { "title": "State", "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" ], "type": "string", "description": "US state to restrict the search to. Leave blank to search by ZIP code or keyword instead." }, "zipCode": { "title": "ZIP code", "type": "string", "description": "Search by ZIP code instead of city/state." }, "keyword": { "title": "Keyword", "type": "string", "description": "Free-text keyword search (searched nationwide if no city/state/ZIP is set)." }, "propertyTypes": { "title": "Property types", "uniqueItems": true, "type": "array", "description": "Restrict to one or more property types. Empty = all types.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6", "7", "8", "10", "11", "12" ], "enumTitles": [ "Single Family / Detached", "Multi-family", "Condo / Townhome / Apartment", "Farm / Ranch", "Lot and Land", "Commercial", "Mobile", "Waterfront", "Other", "Industrial", "Recreational" ] }, "default": [] }, "listingStatuses": { "title": "Listing status", "uniqueItems": true, "type": "array", "description": "Restrict to one or more listing statuses. Empty = active listings only (site default).", "items": { "type": "string", "enum": [ "10001", "10005", "10011" ], "enumTitles": [ "Active", "Pending", "Coming Soon" ] }, "default": [] }, "minPrice": { "title": "Min price (USD)", "minimum": 0, "maximum": 500000000, "type": "integer", "description": "Minimum listing price." }, "maxPrice": { "title": "Max price (USD)", "minimum": 0, "maximum": 500000000, "type": "integer", "description": "Maximum listing price." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Minimum number of bedrooms." }, "maxBedrooms": { "title": "Max bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Maximum number of bedrooms." }, "minBathrooms": { "title": "Min bathrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Minimum number of bathrooms." }, "maxBathrooms": { "title": "Max bathrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Maximum number of bathrooms." }, "minSqft": { "title": "Min square feet", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Minimum interior square footage." }, "maxSqft": { "title": "Max square feet", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Maximum interior square footage." }, "sortBy": { "title": "Sort by", "enum": [ "recommended", "PropertySize desc", "PropertySize", "YearBuilt desc", "YearBuilt", "ListPrice desc", "ListPrice" ], "type": "string", "description": "Result ordering.", "default": "recommended" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Hard cap on emitted listings. Results are fetched 250 at a time (one page); set higher than 250 to page through more of a broad search's matches.", "default": 50 } } }, "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 } } } } } } } } } }