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 squid settings for the Leboncoin Listings & Phone Search Export scraper. This scraper extends the standard Leboncoin scraper with phone number extraction capabilities.

​
Headers

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

​
Phone Extraction Parameter

Enable phone number extraction:
ParameterTypeDefaultDescription
functions.get_phone_numbersbooleantrueExtract phone numbers from listings (6 credits per listing)

​
Scraper Parameters

Set these parameters in the params object:
ParameterTypeDefaultDescription
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.
max_pagesintegernullMaximum number of result pages to crawl
max_resultsintegernullTotal number of listings to collect before stopping
max_unique_results_per_runintegernullMaximum unique results across all tasks in a single run
online_shopbooleanfalseExtract seller’s shop URL (incurs extra requests/credits)

​
Squid Settings

Configure general squid settings:
SettingTypeDescription
namestringDisplay name for your squid configuration
concurrencyintegerNumber of parallel scraping workers (default: 1)
export_unique_resultsbooleanExport only unique results (deduplicated)
to_completebooleanRun until all tasks complete
no_line_breaksbooleanRemove line breaks from results
Enabling functions.get_phone_numbers adds extra requests per listing, significantly increasing run time and credit usage.
Only enable phone extraction when phone numbers are actually required for your use case.
Phone numbers are only available when the seller has enabled phone contact on their listing.
Backward compatibility: The old function name phone is still accepted but deprecated. Migrate to get_phone_numbers.

​
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 & Phone Search Export (1)",
    "concurrency": 1,
    "export_unique_results": true,
    "to_complete": false,
    "no_line_breaks": true,
    "params": {
      "functions": {
        "get_phone_numbers": true
      },
      "max_pages": 99,
      "fetch_since": null,
      "max_results": null,
      "online_shop": true
    }
  }'

​
Response

201
{
  "name": "Leboncoin Listings & Phone Search Export (1)",
  "no_line_breaks": true,
  "params": {
    "functions": {
      "get_phone_numbers": true
    },
    "max_pages": 99,
    "fetch_since": null,
    "max_results": null,
    "online_shop": true
  },
  "to_complete": false,
  "export_unique_results": true
}