Skip to content
Examples

Update Settings

Configure Yelp Search Export scraper settings

The v1 API, for batchesSquids, tasks and runs: many calls on a schedule, delivered where you work. For one call that answers in seconds, use the API v2.
POSThttps://api.lobstr.io/v1/squids/{squid_hash}

Configure your Yelp Search Export squid settings. Control result limits, contact harvesting, and search filters such as price range, distance, and business amenities.

Headers

Authorizationstringheaderrequired

Your API authentication token. Value: Token YOUR_API_KEY

Content-Typestringheaderrequired

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
min_star_rating float null Only show businesses with at least this star rating (e.g. 3.5, 4.0)
min_reviews integer null Only show businesses with at least this many reviews

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

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