{ "openapi": "3.0.1", "info": { "title": "Zillow Price Drop & New Listing Monitor", "description": "Watch Zillow ZIP codes for what changed since your last run: new listings, price cuts, price increases, removed listings and back-on-market. Built for a daily or weekly schedule plus a webhook, so you get alerts, not full dumps.", "version": "0.1", "x-build-id": "iFY5uc4ljwifxiDQV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lukehunter~zillow-price-drop-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lukehunter-zillow-price-drop-monitor", "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/lukehunter~zillow-price-drop-monitor/runs": { "post": { "operationId": "runs-sync-lukehunter-zillow-price-drop-monitor", "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/lukehunter~zillow-price-drop-monitor/run-sync": { "post": { "operationId": "run-sync-lukehunter-zillow-price-drop-monitor", "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": [ "zipCodes" ], "properties": { "zipCodes": { "title": "ZIP codes to watch", "maxItems": 50, "type": "array", "description": "US ZIP codes to monitor, five digits each, e.g. \"90210\". A pasted https://www.zillow.com/homes/for_sale/90210/ URL is also accepted and reduced to its ZIP. Maximum 50 ZIP codes per run. Run this on a schedule (daily or weekly) to get change events over time.", "items": { "type": "string" } }, "eventTypes": { "title": "Event types to deliver", "type": "array", "description": "Which change event types to deliver and charge for. The free zip_summary row is always included regardless of this filter.", "items": { "type": "string", "enum": [ "new_listing", "price_cut", "price_increase", "removed", "back_on_market" ], "enumTitles": [ "New listing", "Price cut", "Price increase", "Removed from search results", "Back on market" ] }, "default": [ "new_listing", "price_cut", "price_increase", "removed", "back_on_market" ] }, "minPriceChangePct": { "title": "Minimum price change to report (%)", "minimum": 0, "maximum": 100, "type": "number", "description": "Ignore price_cut/price_increase events smaller than this absolute percentage of the previous price, e.g. 1 to ignore rounding-sized changes below 1%. Default 0 (report every price change).", "default": 0 }, "maxPagesPerZip": { "title": "Maximum pages per ZIP code", "minimum": 1, "maximum": 20, "type": "integer", "description": "Safety cap on how many search result pages are fetched per ZIP code per run (each page holds roughly 41 listings), 1-20, default 20. A ZIP with more pages than this cannot have its removed listings detected reliably that run (see Limitations in the README) — Zillow's own page count for the ZIP stops the run earlier whenever it is smaller.", "default": 20 }, "stateStoreName": { "title": "State store name", "type": "string", "description": "Name of the named, cross-run key-value store this Actor uses to remember each ZIP's last snapshot. Leave as the default unless you are running several independent watch lists and want them to keep separate history.", "default": "zillow-price-drop-monitor-state" }, "emitBaselineAsNew": { "title": "Emit first-run listings as new_listing events", "type": "boolean", "description": "By default, the first run for a ZIP only saves a baseline snapshot and delivers no change events (there is nothing to compare against yet). Turn this on to instead deliver every listing found on that first run as a new_listing event — useful if you want a complete initial dump, but note it is charged like any other change event.", "default": false }, "maxEvents": { "title": "Maximum change events per run", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on the number of change events delivered (and charged) across all ZIP codes in one run, 1-5000, default 200. Free zip_summary rows do not count toward this cap.", "default": 200 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }