Update Settings

curl --request POST \
  --url https://api.lobstr.io/v1/squids/{squid_hash} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>'

import requests

url = "https://api.lobstr.io/v1/squids/{squid_hash}"

headers = {
    "Authorization": "<authorization>",
    "Content-Type": "<content-type>"
}

response = requests.post(url, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': '<content-type>'}
};

fetch('https://api.lobstr.io/v1/squids/{squid_hash}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lobstr.io/v1/squids/{squid_hash}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: <content-type>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lobstr.io/v1/squids/{squid_hash}"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "<content-type>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.lobstr.io/v1/squids/{squid_hash}")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "<content-type>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.lobstr.io/v1/squids/{squid_hash}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = '<content-type>'

response = http.request(request)
puts response.read_body

POST

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>'

import requests

url = "https://api.lobstr.io/v1/squids/{squid_hash}"

headers = {
    "Authorization": "<authorization>",
    "Content-Type": "<content-type>"
}

response = requests.post(url, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': '<content-type>'}
};

fetch('https://api.lobstr.io/v1/squids/{squid_hash}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.lobstr.io/v1/squids/{squid_hash}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: <content-type>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.lobstr.io/v1/squids/{squid_hash}"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "<content-type>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.lobstr.io/v1/squids/{squid_hash}")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "<content-type>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.lobstr.io/v1/squids/{squid_hash}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = '<content-type>'

response = http.request(request)
puts response.read_body

Configure your Leboncoin Boutiques Scraper squid settings. Enable enrichment functions to collect additional store details, phone numbers, and business registration data.

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:

Parameter	Type	Default	Description
get_details	boolean	true	Fetch full store data: address, SIREN/SIRET, GPS coordinates, opening hours, description, and ratings (1 credit per store)
get_phone_numbers	boolean	true	Retrieve phone numbers for each store. No account required (1 credit per store)
max_results	integer	unlimited	Maximum stores collected per URL
max_pages	integer	99	Maximum number of pages to crawl per URL
max_unique_results_per_run	integer	unlimited	Maximum unique results across all tasks in the run

Squid Settings

Configure general squid settings:

Setting	Type	Description
name	string	Display name for your squid configuration
concurrency	integer	Number of parallel scraping threads (default: 1)
export_unique_results	boolean	Export only unique results (deduplicated)
to_complete	boolean	Run until all tasks complete
no_line_breaks	boolean	Remove line breaks from results

Enabling get_details or get_phone_numbers adds an extra request per store, increasing run time and credit usage.

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 Boutiques Scraper (1)",
    "concurrency": 2,
    "export_unique_results": true,
    "to_complete": true,
    "params": {
      "get_details": true,
      "get_phone_numbers": true,
      "max_results": 500,
      "max_pages": 10
    }
  }'

import requests

API_KEY = "YOUR_API_KEY"
BASE_URL = "https://api.lobstr.io/v1"
headers = {"Authorization": f"Token {API_KEY}"}

squid_id = "YOUR_SQUID_HASH"

response = requests.post(f"{BASE_URL}/squids/{squid_id}",
    headers=headers,
    json={
        "name": "Leboncoin Boutiques Scraper (1)",
        "concurrency": 2,
        "export_unique_results": True,
        "to_complete": True,
        "params": {
            "get_details": True,
            "get_phone_numbers": True,
            "max_results": 500,
            "max_pages": 10
        }
    }
)

print(f"Settings updated: {response.json()['name']}")

Response

201

{
  "name": "Leboncoin Boutiques Scraper (1)",
  "concurrency": 2,
  "export_unique_results": true,
  "to_complete": true,
  "params": {
    "get_details": true,
    "get_phone_numbers": true,
    "max_results": 500,
    "max_pages": 10
  }
}

Add Tasks Get Results

​Headers

​Scraper Parameters

​Squid Settings

​Code Examples

​Response

Headers

Scraper Parameters

Squid Settings

Code Examples

Response