> ## 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.

# Update Settings

> Configure scraper settings for Leboncoin Listings & Phone Search Export

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

<ParamField header="Authorization" type="string" required>
  Your API authentication token. Value: `Token YOUR_API_KEY`
</ParamField>

<ParamField header="Content-Type" type="string" required>
  Request body format. Value: `application/json`
</ParamField>

## Phone Extraction Parameter

Enable phone number extraction:

| Parameter                         | Type    | Default | Description                                                 |
| --------------------------------- | ------- | ------- | ----------------------------------------------------------- |
| **functions.get\_phone\_numbers** | boolean | true    | Extract phone numbers from listings (6 credits per listing) |

## Scraper Parameters

Set these parameters in the `params` object:

| Parameter                          | Type    | Default | Description                                                                                                                                                                                                                       |
| ---------------------------------- | ------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **fetch\_since**                   | string  | null    | Stop 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:SS)                                                |
| **fetch\_since\_timezone**         | string  | null    | Timezone 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](/docs/timezones). |
| **max\_pages**                     | integer | null    | Maximum number of result pages to crawl                                                                                                                                                                                           |
| **max\_results**                   | integer | null    | Total number of listings to collect before stopping                                                                                                                                                                               |
| **max\_unique\_results\_per\_run** | integer | null    | Maximum unique results across all tasks in a single run                                                                                                                                                                           |
| **online\_shop**                   | boolean | false   | Extract seller's shop URL (incurs extra requests/credits)                                                                                                                                                                         |

## Squid Settings

Configure general squid settings:

| Setting                     | Type    | Description                                      |
| --------------------------- | ------- | ------------------------------------------------ |
| **name**                    | string  | Display name for your squid configuration        |
| **concurrency**             | integer | Number of parallel scraping workers (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                  |

<Warning>
  Enabling `functions.get_phone_numbers` adds extra requests per listing, significantly increasing run time and credit usage.
</Warning>

<Tip>
  Only enable phone extraction when phone numbers are actually required for your use case.
</Tip>

<Note>
  Phone numbers are only available when the seller has enabled phone contact on their listing.
</Note>

<Note>
  **Backward compatibility:** The old function name `phone` is still accepted but deprecated. Migrate to `get_phone_numbers`.
</Note>

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  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
      }
    }'
  ```

  ```python Python theme={null}
  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"

  # Update scraper settings with phone extraction enabled
  response = requests.post(f"{BASE_URL}/squids/{squid_id}",
      headers=headers,
      json={
          "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  # Enable phone number extraction
              },
              "max_pages": 99,
              "fetch_since": None,
              "max_results": None,
              "online_shop": True
          }
      }
  )

  print(response.json())
  ```
</CodeGroup>

## Response

```json 201 theme={null}
{
  "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
}
```
