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

Documentation Index

Fetch the complete documentation index at: https://docs.lobstr.io/llms.txt

Use this file to discover all available pages before exploring further.

Configure your Immoweb Listings & Phone Search Export squid settings. Control pagination, result limits, and whether to fetch full listing details including phone numbers.

​
Headers

​
Authorization
string
required
Your API authentication token. Value: Token YOUR_API_KEY
​
Content-Type
string
required
Request body format. Value: application/json

​
Scraper Parameters

Set these parameters in the params object:
ParameterTypeDefaultDescription
max_pagesintegerunlimitedMaximum number of search result pages to scrape
max_resultsintegerunlimitedMaximum number of listings to collect per task
max_unique_results_per_runintegerunlimitedMaximum unique results across all tasks in the run

​
Optional Functions

Enable these in the params.functions object:
FunctionTypeDefaultDescription
product_detailsbooleantrueVisit each listing’s detail page to fetch full description, phone number, and additional attributes (4 credits per listing)

​
Squid Settings

Configure general squid settings:
SettingTypeDescription
namestringDisplay name for your squid configuration
concurrencyintegerNumber of parallel scraping threads (default: 1)
export_unique_resultsbooleanExport only unique results (deduplicated)
to_completebooleanRun until all tasks complete
no_line_breaksbooleanRemove line breaks from results
product_details is enabled by default and costs 4 additional credits per listing. Disable it if you only need listing summaries.

​
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": "Immoweb Listings & Phone (1)",
    "concurrency": 1,
    "export_unique_results": true,
    "to_complete": false,
    "no_line_breaks": true,
    "params": {
      "max_pages": 10,
      "max_results": 200,
      "functions": {
        "product_details": true
      }
    }
  }'

​
Response

201
{
  "name": "Immoweb Listings & Phone (1)",
  "concurrency": 1,
  "export_unique_results": true,
  "to_complete": false,
  "no_line_breaks": true,
  "params": {
    "max_pages": 10,
    "max_results": 200,
    "functions": {
      "product_details": true
    }
  }
}