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 Bien’Ici Listings Search Export squid settings. Control pagination, result limits, time filters, and whether to include sponsored listings.

​
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_pagesinteger100Maximum number of search result pages to scrape (max: 100)
max_resultsinteger50Maximum number of listings to collect per task
max_unique_results_per_runintegerunlimitedMaximum unique results across all tasks in the run
collect_adsbooleanfalseInclude sponsored/promoted listings in results
fetch_sincestringnullStop scraping when items older than this threshold are reached (based on published_at). Use a relative duration (24h, 7d, 2w) or an absolute date (YYYY-MM-DD HH:MM:SS)
fetch_since_timezonestringnullTimezone for interpreting an absolute fetch_since date (e.g. Europe/Paris). Only applies when fetch_since is an absolute date — ignored for relative values like 24h or 7d. See supported timezones.

​
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
Use fetch_since: 24h to monitor new listings published in the last day.
Keep concurrency at 1 to avoid rate limiting on Bien’Ici.

​
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": "Bien'\''ici Listings Search Export (1)",
    "concurrency": 1,
    "export_unique_results": true,
    "to_complete": false,
    "no_line_breaks": true,
    "params": {
      "max_pages": 100,
      "max_results": 50,
      "collect_ads": false,
      "fetch_since": null
    }
  }'

​
Response

201
{
  "name": "Bien'ici Listings Search Export (1)",
  "concurrency": 1,
  "export_unique_results": true,
  "to_complete": false,
  "no_line_breaks": true,
  "params": {
    "max_pages": 100,
    "max_results": 50,
    "collect_ads": false,
    "fetch_since": null
  }
}