> ## 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 the Google Maps Leads Scraper parameters

Configure the scraper parameters to control how places are collected. These settings include language, location context, filters, and optional data collection features.

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

## Scraper Parameters

Set these parameters in the `params` object:

| Parameter                | Type    | Default    | Description                                                                                                   |
| ------------------------ | ------- | ---------- | ------------------------------------------------------------------------------------------------------------- |
| **country**              | string  | —          | Regional context for search results (e.g., `United States`)                                                   |
| **ratings**              | string  | Any rating | Minimum rating filter: `Any rating`, `2.5+`, `3.0+`, `3.5+`, `4.0+`, `4.5+`                                   |
| **max\_rating**          | string  | Any rating | Maximum rating filter. Combine with `ratings` to define a score range (e.g. collect only 3–4 star businesses) |
| **min\_reviews**         | integer | —          | Only collect places with at least this many reviews                                                           |
| **max\_reviews**         | integer | —          | Only collect places with at most this many reviews                                                            |
| **exact\_name\_match**   | boolean | false      | Only collect places whose name matches your search query — useful to target a specific brand or chain         |
| **phone\_filter**        | string  | all        | Filter by phone presence: `all`, `with_phone`, `without_phone`                                                |
| **verified\_filter**     | string  | all        | Filter by owner-claimed status: `all`, `verified_only`, `unverified_only`                                     |
| **language**             | string  | —          | Language for place names and metadata (e.g., `English (United States)`)                                       |
| **max\_results**         | integer | unlimited  | Maximum places to collect before task ends                                                                    |
| **geo\_match**           | boolean | true       | Only return results that geographically match the searched location                                           |
| **category\_match**      | boolean | true       | Only return results that match the searched business category                                                 |
| **skip\_closed**         | boolean | false      | Skip permanently closed businesses                                                                            |
| **website\_filter**      | string  | all        | Filter by website presence: `all`, `with_website`, `without_website`                                          |
| **skip\_without\_email** | boolean | false      | Skip businesses where no email address was found                                                              |

## Optional Functions

Enable these in the `params.functions` object:

| Function                           | Type    | Description                                                                                     |
| ---------------------------------- | ------- | ----------------------------------------------------------------------------------------------- |
| **extract\_emails\_from\_website** | boolean | Visit business website to extract email, Facebook, Instagram, and additional phone              |
| **fetch\_business\_images**        | boolean | Collect all image URLs from the Google Place page                                               |
| **collect\_business\_details**     | boolean | Collect additional metadata like plus\_code, poi, health, and last\_opening\_hours\_updated\_at |

<Warning>
  Enabling `extract_emails_from_website`, `fetch_business_images`, or `collect_business_details` may incur additional credits.
</Warning>

<Note>
  **Backward compatibility:** The old function names `collect_contacts`, `images`, and `details` are still accepted but deprecated. Migrate to the new names listed above.
</Note>

<Tip>
  Set `export_unique_results: true` to avoid duplicate entries when places appear multiple times in search results.
</Tip>

## 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": "Google Maps Search Export",
      "no_line_breaks": true,
      "params": {
        "country": "United States",
        "ratings": "Any rating",
        "language": "English (United States)",
        "functions": {
          "fetch_business_images": true,
          "collect_business_details": true,
          "extract_emails_from_website": true
        },
        "max_results": 200
      },
      "to_complete": false,
      "export_unique_results": 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
  response = requests.post(f"{BASE_URL}/squids/{squid_id}",
      headers=headers,
      json={
          "name": "Google Maps Search Export",
          "no_line_breaks": True,
          "params": {
              "country": "United States",
              "ratings": "Any rating",
              "language": "English (United States)",
              "functions": {
                  "fetch_business_images": True,
                  "collect_business_details": True,
                  "extract_emails_from_website": True
              },
              "max_results": 200
          },
          "to_complete": False,
          "export_unique_results": True
      }
  )

  data = response.json()
  print(f"Updated: {data['name']}")
  print(f"Max results: {data['params']['max_results']}")
  ```
</CodeGroup>

## Response

```json 201 theme={null}
{
  "name": "Google Maps Search Export",
  "no_line_breaks": true,
  "params": {
    "country": "United States",
    "ratings": "Any rating",
    "language": "English (United States)",
    "functions": {
      "fetch_business_images": true,
      "collect_business_details": true,
      "extract_emails_from_website": true
    },
    "max_results": 200
  },
  "to_complete": false,
  "export_unique_results": true
}
```