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>'
Configure your Yelp Search Export squid settings. Control result limits, contact harvesting, and search filters such as price range, distance, and business amenities.

​
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:
ParameterTypeDefaultDescription
max_resultsinteger240Maximum number of businesses to collect per task. Yelp displays up to 240 results per search
max_unique_results_per_runintegernullMaximum unique results across all tasks in the entire run
collect_contactsbooleantrueVisit each business’s website to extract email addresses and social links (1 credit per business)
sortstringRecommendedHow results are ordered: Recommended, Highest Rated, or Review Count
distancestringAny DistanceMaximum search radius: Any Distance, Bird's-eye View, Driving (25 mi.), Biking (6 mi.), Walking (1 mi.), or Within 4 blocks
price_1booleanfalseInclude businesses with price level $ (inexpensive)
price_2booleanfalseInclude businesses with price level $$ (moderate)
price_3booleanfalseInclude businesses with price level $$$ (pricey)
price_4booleanfalseInclude businesses with price level $$$$ (very expensive)
hot_and_newbooleanfalseOnly show businesses tagged as Hot and New by Yelp
open_nowbooleanfalseOnly show businesses that are open at the time of the search
good_for_kidsbooleanfalseOnly show businesses marked as good for kids
good_for_groupsbooleanfalseOnly show businesses marked as good for groups
free_wifibooleanfalseOnly show businesses that offer free Wi-Fi
dogs_allowedbooleanfalseOnly show businesses that allow dogs
wheelchair_accessiblebooleanfalseOnly show businesses that are wheelchair accessible
open_to_allbooleanfalseOnly show businesses tagged as open to all
accepts_credit_cardsbooleanfalseOnly show businesses that accept credit cards
accepts_cryptocurrencybooleanfalseOnly show businesses that accept cryptocurrency
accepts_apple_paybooleanfalseOnly show businesses that accept Apple Pay
offers_military_discountbooleanfalseOnly show businesses that offer a military discount

​
Squid Settings

Configure general squid settings:
SettingTypeDescription
namestringDisplay name for your squid configuration
concurrencyintegerNumber of parallel scraping threads (default: 1)
export_unique_resultsbooleanExport only unique results (deduplicated)
to_completebooleanRun until all tasks complete
no_line_breaksbooleanRemove 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

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

​
Response

201
{
  "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
  }
}