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 Listing Scraper squid settings. Enable phone number extraction to retrieve the seller’s phone number from each listing page.

Headers

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

Optional Functions

Enable these in the params.functions object:
FunctionTypeDefaultDescription
get_phone_numbersbooleantrueFetch the seller’s phone number from the listing page (6 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
Phone number extraction is enabled by default. Disable it if you only need listing data to avoid extra credit charges.
Phone numbers are only available when the seller has enabled phone contact on their listing.

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 Listing Scraper (1)",
    "concurrency": 5,
    "export_unique_results": true,
    "to_complete": false,
    "no_line_breaks": true,
    "params": {
      "functions": {
        "get_phone_numbers": true
      }
    }
  }'

Response

201
{
  "name": "Leboncoin Listing Scraper (1)",
  "concurrency": 5,
  "export_unique_results": true,
  "to_complete": false,
  "no_line_breaks": true,
  "params": {
    "functions": {
      "get_phone_numbers": true
    }
  }
}