> ## 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 Yelp Search Export scraper settings
Configure your Yelp Search Export squid settings. Control result limits, contact harvesting, and search filters such as price range, distance, and business amenities.
## Headers
Your API authentication token. Value: `Token YOUR_API_KEY`
Request body format. Value: `application/json`
## Scraper Parameters
Set these parameters in the `params` object:
| Parameter | Type | Default | Description |
| ---------------------------------- | ------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
| **max\_results** | integer | 240 | Maximum number of businesses to collect per task. Yelp displays up to 240 results per search |
| **max\_unique\_results\_per\_run** | integer | null | Maximum unique results across all tasks in the entire run |
| **collect\_contacts** | boolean | true | Visit each business's website to extract email addresses and social links (1 credit per business) |
| **sort** | string | Recommended | How results are ordered: `Recommended`, `Highest Rated`, or `Review Count` |
| **distance** | string | Any Distance | Maximum search radius: `Any Distance`, `Bird's-eye View`, `Driving (25 mi.)`, `Biking (6 mi.)`, `Walking (1 mi.)`, or `Within 4 blocks` |
| **price\_1** | boolean | false | Include businesses with price level \$ (inexpensive) |
| **price\_2** | boolean | false | Include businesses with price level \$\$ (moderate) |
| **price\_3** | boolean | false | Include businesses with price level \$\$\$ (pricey) |
| **price\_4** | boolean | false | Include businesses with price level \$\$\$\$ (very expensive) |
| **hot\_and\_new** | boolean | false | Only show businesses tagged as Hot and New by Yelp |
| **open\_now** | boolean | false | Only show businesses that are open at the time of the search |
| **good\_for\_kids** | boolean | false | Only show businesses marked as good for kids |
| **good\_for\_groups** | boolean | false | Only show businesses marked as good for groups |
| **free\_wifi** | boolean | false | Only show businesses that offer free Wi-Fi |
| **dogs\_allowed** | boolean | false | Only show businesses that allow dogs |
| **wheelchair\_accessible** | boolean | false | Only show businesses that are wheelchair accessible |
| **open\_to\_all** | boolean | false | Only show businesses tagged as open to all |
| **accepts\_credit\_cards** | boolean | false | Only show businesses that accept credit cards |
| **accepts\_cryptocurrency** | boolean | false | Only show businesses that accept cryptocurrency |
| **accepts\_apple\_pay** | boolean | false | Only show businesses that accept Apple Pay |
| **offers\_military\_discount** | boolean | false | Only show businesses that offer a military discount |
## 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 |
Filter parameters (`price_1`, `open_now`, etc.) apply when tasks use `keyword` + `location` as input. When a full URL is provided, Yelp applies the filters embedded in that URL instead.
Enable `collect_contacts` to extract email addresses from business websites for outreach campaigns.
Enabling `collect_contacts` adds extra HTTP requests per business, increasing total run time and credit usage.
## Code Examples
```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": "Yelp Search Export (1)",
"concurrency": 1,
"export_unique_results": true,
"to_complete": false,
"no_line_breaks": true,
"params": {
"max_results": 240,
"collect_contacts": true,
"sort": "Highest Rated",
"distance": "Driving (25 mi.)",
"price_1": true,
"price_2": true,
"open_now": false,
"good_for_kids": false
}
}'
```
```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"
payload = {
"name": "Yelp Search Export (1)",
"concurrency": 1,
"export_unique_results": True,
"to_complete": False,
"no_line_breaks": True,
"params": {
"max_results": 240,
"collect_contacts": True,
"sort": "Highest Rated",
"distance": "Driving (25 mi.)",
"price_1": True,
"price_2": True,
"open_now": False,
"good_for_kids": False
}
}
response = requests.post(f"{BASE_URL}/squids/{squid_id}", headers=headers, json=payload)
print(f"Settings updated: {response.json()['name']}")
```
## Response
```json 201 theme={null}
{
"name": "Yelp Search Export (1)",
"concurrency": 1,
"export_unique_results": true,
"to_complete": false,
"no_line_breaks": true,
"params": {
"max_results": 240,
"collect_contacts": true,
"sort": "Highest Rated",
"distance": "Driving (25 mi.)",
"price_1": true,
"price_2": true,
"open_now": false,
"good_for_kids": false
}
}
```