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>'
Configure your SeLoger Search Export squid settings. Control pagination and enable detail page enrichment to get full descriptions and geographic coordinates.

​
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_pagesinteger400Maximum number of search result pages to crawl (max: 400)
functions.get_annonce_detailsbooleanfalseVisit each listing’s detail page to fetch full description, coordinates (lat/lng), and extra 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
Enable functions.get_annonce_details to get full property descriptions and exact GPS coordinates.
Enabling get_annonce_details increases run time as each listing requires an additional HTTP request.
Use max_pages to limit the scope of large searches and control credit usage.
Backward compatibility: The old function name annonce_details is still accepted but deprecated. Migrate to get_annonce_details.

​
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": "SeLoger Search Export (1)",
    "concurrency": 5,
    "export_unique_results": true,
    "to_complete": false,
    "no_line_breaks": true,
    "params": {
      "functions": {
        "get_annonce_details": true
      },
      "max_pages": 4
    }
  }'

​
Response

201
{
  "name": "SeLoger Search Export (1)",
  "concurrency": 5,
  "export_unique_results": true,
  "to_complete": false,
  "no_line_breaks": true,
  "params": {
    "functions": {
      "get_annonce_details": true
    },
    "max_pages": 4
  }
}