Skip to content
Examples

Update Settings

Configure Zillow Property Listings Scraper settings

The v1 API, for batchesSquids, tasks and runs: many calls on a schedule, delivered where you work. For one call that answers in seconds, use the API v2.
POSThttps://api.lobstr.io/v1/squids/{squid_hash}

Configure your Zillow Property Listings Scraper squid settings.

Headers

Authorizationstringheaderrequired

Your API authentication token. Value: Token YOUR_API_KEY

Content-Typestringheaderrequired

Must be application/json. Value: application/json

Squid Parameters

Parameter Type Default Description
price_min integer — Only collect homes at or above this price, in USD
price_max integer — Only collect homes at or below this price, in USD
beds string Any Minimum number of bedrooms (Any, 1+, 2+, 3+, 4+, 5+)
baths string Any Minimum number of bathrooms
home_type string Any Property type filter
status string For sale For sale, Sold, or For rent
days_on_site string Any "Listed or Sold Within" filter: only listings published (or sold, in Sold mode) within this window. The API param name stays days_on_site.
max_results integer 1000 Max listings per search (Zillow serves ~980 per search)
max_unique_results_per_run integer — Max unique results across all tasks in the run
property_details boolean false Visit each listing page to collect full description, agent contacts, MLS info, year built, HOA fees, price history

Setting property_details: true enables additional detail fields in results.

Code Examples

curl -X POST https://api.lobstr.io/v1/squids/ed06bb5ca6544bbb638c544bac48ede1 \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "price_min": 500000,
    "price_max": 1000000,
    "beds": "2+",
    "home_type": "CONDO",
    "status": "For sale",
    "property_details": true,
    "max_results": 1000
  }'

Response

201
{"params": {"price_min": 500000, "price_max": 1000000, "beds": "2+", "home_type": "CONDO", "status": "For sale", "property_details": true, "max_results": 1000}}