{ "openapi": "3.0.1", "info": { "title": "Estately Real Estate Scraper", "description": "Scrape Estately.com real-estate listings by city, ZIP code, or state - active for-sale or recently-sold homes with price, beds/baths, square footage, photos, and full property-detail lookups by URL.", "version": "1.0", "x-build-id": "nkbgSBwEj3mchM5wy" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~estately-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-estately-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~estately-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-estately-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~estately-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-estately-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", "byPropertyUrl" ], "type": "string", "description": "What to fetch.", "default": "byLocation" }, "state": { "title": "State (mode=byLocation)", "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 the city is in. Optional when searching by `zipCode`." }, "city": { "title": "City (mode=byLocation)", "type": "string", "description": "City name, e.g. `Austin`. Provide `city` and/or `zipCode`." }, "zipCode": { "title": "ZIP code (mode=byLocation)", "type": "string", "description": "5-digit US ZIP code. Used instead of `city` if both are omitted from `city`." }, "listingStatus": { "title": "Listing status", "enum": [ "forSale", "sold" ], "type": "string", "description": "Active for-sale listings, or recently-sold/closed listings." }, "propertyType": { "title": "Property type", "enum": [ "any", "house", "condo", "townhouse", "multiFamily", "land" ], "type": "string", "description": "Restrict to one property type.", "default": "any" }, "minPrice": { "title": "Min price ($)", "minimum": 0, "maximum": 500000000, "type": "integer", "description": "Drop listings priced below this." }, "maxPrice": { "title": "Max price ($)", "minimum": 0, "maximum": 500000000, "type": "integer", "description": "Drop listings priced above this." }, "minBeds": { "title": "Min bedrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Drop listings with fewer bedrooms than this." }, "minBaths": { "title": "Min bathrooms", "minimum": 0, "maximum": 20, "type": "integer", "description": "Drop listings with fewer bathrooms than this." }, "minSqft": { "title": "Min square footage", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Drop listings smaller than this (living area, sqft)." }, "maxSqft": { "title": "Max square footage", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Drop listings larger than this (living area, sqft)." }, "propertyUrls": { "title": "Property URLs (mode=byPropertyUrl)", "type": "array", "description": "Full Estately listing-detail URLs (e.g. from a `sourceUrl` field of a byLocation run), or bare `/listings/info/...` paths.", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on emitted records.", "default": 50 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. Uses Apify's free datacenter (AUTO) proxy pool. A direct (no-proxy) fetch is used by default; this is only a fallback.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }