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 Auto Message Sender settings including the message template with dynamic variables that are replaced with listing-specific values.

​
Headers

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

​
Message Parameters

Configure the message content and targeting:
ParameterTypeDefaultDescription
messagestring—Template for the message sent to sellers. Supports dynamic variables (see below)
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_resultsintegernullMaximum number of listings to process before stopping
max_unique_results_per_runintegernullMaximum unique results across all tasks in a single run

​
Message Template Variables

The message parameter supports dynamic variables that are replaced with listing-specific values:
VariableDescription
#title#The listing title (e.g., “Appartement 3 pièces 88 m²”)
#pseudo#The seller’s display name/pseudonym

​
Squid Settings

Configure general squid settings:
SettingTypeDescription
namestringDisplay name for your squid configuration
concurrencyintegerNumber of parallel message sending threads (default: 1)
export_unique_resultsbooleanExport only unique results (deduplicated)
to_completebooleanRun until all tasks complete
no_line_breaksbooleanRemove line breaks from results
Example message template: “Hello #pseudo#,\n\nI am interested in your listing: #title#.\n\nPlease contact me via Leboncoin messaging.\n\nThank you!”
Keep concurrency low (1-2) to avoid rate limiting from Leboncoin.
The same message will not be sent twice to the same listing (duplicate detection via message_hash).

​
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 Auto Message Sender (4)",
    "concurrency": 1,
    "export_unique_results": true,
    "to_complete": false,
    "no_line_breaks": true,
    "params": {
      "message": "Hello #pseudo#,\n\nI want to enquire about #title#.",
      "fetch_since": 1,
      "max_results": 3,
      "max_unique_results_per_run": 10
    }
  }'

​
Response

201
{
  "name": "Leboncoin Auto Message Sender (4)",
  "concurrency": 1,
  "export_unique_results": true,
  "to_complete": false,
  "no_line_breaks": true,
  "params": {
    "message": "Hello #pseudo#,\n\nI want to enquire about #title#.",
    "max_unique_results_per_run": 20,
    "fetch_since": 1,
    "max_results": 3
  }
}