Update Settings
Configure settings for your Realtor Listings Scraper squid
https://api.lobstr.io/v1/squids/{squid_hash}Update the configuration of your Realtor Listings Scraper squid. Pass crawler-specific settings inside the params object.
Headers
AuthorizationstringheaderrequiredYour API authentication token. Value: Token YOUR_API_KEY
Content-TypestringheaderrequiredMust be application/json. Value: application/json
Body
paramsobjectCrawler-specific settings. See fields below.
Settings Fields
params.max_resultsintegerMaximum number of listings to collect per task. Leave empty for unlimited.
params.max_unique_results_per_runintegerMaximum number of unique results across all tasks in a run. Leave empty for unlimited.
params.property_detailsbooleanVisit each listing detail page to collect the full photo gallery, agent and office details, description text, price/tax history, schools, spec sheet, risk scores, and more. Requires one additional request per listing.
params.keywordstringFilter listings by one or more keywords, comma-separated (e.g. pool, ocean view). Only listings whose description contains at least one keyword are returned.
params.fetch_sincestringOnly collect listings published after this point (based on published_at). Accepts a relative duration (e.g. "24h", "7d", "2w") or an absolute date ("YYYY-MM-DD HH:MM").
params.fetch_since_timezonestringTimezone for interpreting an absolute fetch_since date (e.g. "America/New_York"). Only applies when fetch_since is an absolute date — ignored for relative values like "24h" or "7d".
Set fetch_since to null to collect all listings, or use a relative duration ("24h", "7d", "2w") or absolute date ("YYYY-MM-DD HH:MM") to collect only recent listings. When using an absolute date, set fetch_since_timezone to interpret it in the correct timezone (e.g. "America/New_York").
Code Examples
curl -X POST "https://api.lobstr.io/v1/squids/YOUR_SQUID_HASH" \ -H "Authorization: Token YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "Realtor California Listings", "params": { "max_results": 200, "fetch_since": "7d", "fetch_since_timezone": null } }'
Response
{ "id": "YOUR_SQUID_HASH", "name": "Realtor California Listings", "crawler": { "id": "f388a9866f943bc5c29bde8b33587bd3", "name": "Realtor Iter Listings", "slug": "realtor-iter-listings" }, "params": { "max_results": 200, "fetch_since": "7d", "fetch_since_timezone": null }, "concurrency": 1, "export_unique_results": true, "to_complete": true, "no_line_breaks": false, "status": "idle", "created_at": "2025-01-20T10:15:00.000000", "updated_at": "2025-01-27T14:35:00.000000" }