Skip to main content
POST
/
v1
/
squids
/
{squid_hash}
Update Settings
curl --request POST \
  --url https://api.lobstr.io/v1/squids/{squid_hash} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "params": {},
  "params.max_results": 123,
  "params.max_unique_results_per_run": 123,
  "params.fetch_since": "<string>",
  "params.fetch_since_timezone": "<string>"
}
'
Update the configuration of your Realtor Listings Scraper squid. Pass crawler-specific settings inside the params object.

​
Headers

​
Authorization
string
required
Your API authentication token. Value: Token YOUR_API_KEY
​
Content-Type
string
required
Must be application/json. Value: application/json

​
Body

​
params
object
Crawler-specific settings. See fields below.

​
Settings Fields

​
params.max_results
integer
Maximum number of listings to collect per task. Leave empty for unlimited.
​
params.max_unique_results_per_run
integer
Maximum number of unique results across all tasks in a run. Leave empty for unlimited.
​
params.fetch_since
string
Only 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_timezone
string
Timezone 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

201
{
  "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"
}