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.property_details": true,
  "params.keyword": "<string>",
  "params.fetch_since": "<string>",
  "params.fetch_since_timezone": "<string>"
}
'

import requests

url = "https://api.lobstr.io/v1/squids/{squid_hash}"

payload = {
    "params": {},
    "params.max_results": 123,
    "params.max_unique_results_per_run": 123,
    "params.property_details": True,
    "params.keyword": "<string>",
    "params.fetch_since": "<string>",
    "params.fetch_since_timezone": "<string>"
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "<content-type>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({
    params: {},
    'params.max_results': 123,
    'params.max_unique_results_per_run': 123,
    'params.property_details': true,
    'params.keyword': '<string>',
    'params.fetch_since': '<string>',
    'params.fetch_since_timezone': '<string>'
  })
};

fetch('https://api.lobstr.io/v1/squids/{squid_hash}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lobstr.io/v1/squids/{squid_hash}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'params' => [
        
    ],
    'params.max_results' => 123,
    'params.max_unique_results_per_run' => 123,
    'params.property_details' => true,
    'params.keyword' => '<string>',
    'params.fetch_since' => '<string>',
    'params.fetch_since_timezone' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: <content-type>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lobstr.io/v1/squids/{squid_hash}"

	payload := strings.NewReader("{\n  \"params\": {},\n  \"params.max_results\": 123,\n  \"params.max_unique_results_per_run\": 123,\n  \"params.property_details\": true,\n  \"params.keyword\": \"<string>\",\n  \"params.fetch_since\": \"<string>\",\n  \"params.fetch_since_timezone\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "<content-type>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.lobstr.io/v1/squids/{squid_hash}")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "<content-type>")
  .body("{\n  \"params\": {},\n  \"params.max_results\": 123,\n  \"params.max_unique_results_per_run\": 123,\n  \"params.property_details\": true,\n  \"params.keyword\": \"<string>\",\n  \"params.fetch_since\": \"<string>\",\n  \"params.fetch_since_timezone\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.lobstr.io/v1/squids/{squid_hash}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = '<content-type>'
request.body = "{\n  \"params\": {},\n  \"params.max_results\": 123,\n  \"params.max_unique_results_per_run\": 123,\n  \"params.property_details\": true,\n  \"params.keyword\": \"<string>\",\n  \"params.fetch_since\": \"<string>\",\n  \"params.fetch_since_timezone\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

POST

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.property_details": true,
  "params.keyword": "<string>",
  "params.fetch_since": "<string>",
  "params.fetch_since_timezone": "<string>"
}
'

import requests

url = "https://api.lobstr.io/v1/squids/{squid_hash}"

payload = {
    "params": {},
    "params.max_results": 123,
    "params.max_unique_results_per_run": 123,
    "params.property_details": True,
    "params.keyword": "<string>",
    "params.fetch_since": "<string>",
    "params.fetch_since_timezone": "<string>"
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "<content-type>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': '<content-type>'},
  body: JSON.stringify({
    params: {},
    'params.max_results': 123,
    'params.max_unique_results_per_run': 123,
    'params.property_details': true,
    'params.keyword': '<string>',
    'params.fetch_since': '<string>',
    'params.fetch_since_timezone': '<string>'
  })
};

fetch('https://api.lobstr.io/v1/squids/{squid_hash}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lobstr.io/v1/squids/{squid_hash}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'params' => [
        
    ],
    'params.max_results' => 123,
    'params.max_unique_results_per_run' => 123,
    'params.property_details' => true,
    'params.keyword' => '<string>',
    'params.fetch_since' => '<string>',
    'params.fetch_since_timezone' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: <content-type>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lobstr.io/v1/squids/{squid_hash}"

	payload := strings.NewReader("{\n  \"params\": {},\n  \"params.max_results\": 123,\n  \"params.max_unique_results_per_run\": 123,\n  \"params.property_details\": true,\n  \"params.keyword\": \"<string>\",\n  \"params.fetch_since\": \"<string>\",\n  \"params.fetch_since_timezone\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "<content-type>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.lobstr.io/v1/squids/{squid_hash}")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "<content-type>")
  .body("{\n  \"params\": {},\n  \"params.max_results\": 123,\n  \"params.max_unique_results_per_run\": 123,\n  \"params.property_details\": true,\n  \"params.keyword\": \"<string>\",\n  \"params.fetch_since\": \"<string>\",\n  \"params.fetch_since_timezone\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.lobstr.io/v1/squids/{squid_hash}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = '<content-type>'
request.body = "{\n  \"params\": {},\n  \"params.max_results\": 123,\n  \"params.max_unique_results_per_run\": 123,\n  \"params.property_details\": true,\n  \"params.keyword\": \"<string>\",\n  \"params.fetch_since\": \"<string>\",\n  \"params.fetch_since_timezone\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

Update the configuration of your Realtor Listings Scraper squid. Pass crawler-specific settings inside the params object.

Headers

string

required

Your API authentication token. Value: Token YOUR_API_KEY

string

required

Must be application/json. Value: application/json

Body

object

Crawler-specific settings. See fields below.

Settings Fields

integer

Maximum number of listings to collect per task. Leave empty for unlimited.

integer

Maximum number of unique results across all tasks in a run. Leave empty for unlimited.

boolean

Visit 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.

string

Filter listings by one or more keywords, comma-separated (e.g. pool, ocean view). Only listings whose description contains at least one keyword are returned.

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").

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
    }
  }'

import requests

API_KEY = "YOUR_API_KEY"
BASE_URL = "https://api.lobstr.io/v1"
headers = {"Authorization": f"Token {API_KEY}"}

squid_hash = "YOUR_SQUID_HASH"

response = requests.post(f"{BASE_URL}/squids/{squid_hash}",
    headers=headers,
    json={
        "name": "Realtor California Listings",
        "params": {
            "max_results": 200,
            "fetch_since": "7d",  # relative: "24h", "7d", "2w" | absolute: "2026-01-01 00:00:00"
            "fetch_since_timezone": None  # e.g. "America/New_York" — only used with absolute fetch_since
        }
    }
)

data = response.json()
print(f"Squid updated: {data['name']}")

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

Add Tasks Get Results

​Headers

​Body

​Settings Fields

​Code Examples

​Response

Headers

Body

Settings Fields

Code Examples

Response