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 Leboncoin Listings Search Export squid settings. Control pagination, result limits, time filters, and whether to include seller shop URLs.

​
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_pagesinteger99Maximum number of search result pages to crawl (max: 99)
max_resultsintegerunlimitedMaximum number of listings to collect per task
max_unique_results_per_runintegerunlimitedMaximum unique results across all tasks in the run
online_shopbooleanfalseExtract the seller’s shop URL (incurs extra requests per listing)
fetch_sincestringnullStop scraping when items older than this threshold are reached (based on last_publication_date). Use a relative duration (24h, 7d, 2w) or an absolute date (YYYY-MM-DD HH:MM)
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: 1h to monitor new listings in near real-time.
Combine with export_unique_results: true to avoid duplicates when a listing appears across multiple pages.

​
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": "Leboncoin Listings Search Export (1)",
    "concurrency": 1,
    "export_unique_results": true,
    "to_complete": false,
    "no_line_breaks": true,
    "params": {
      "max_pages": 99,
      "fetch_since": "24h",
      "online_shop": false
    }
  }'

​
Response

201
{
  "name": "Leboncoin Listings Search Export (1)",
  "concurrency": 1,
  "export_unique_results": true,
  "to_complete": false,
  "no_line_breaks": true,
  "params": {
    "max_pages": 99,
    "fetch_since": "24h",
    "online_shop": false
  }
}