POST/v1/squids/{squid_hash}

Update Settings

Configure Yelp Search Export scraper settings

Configure your Yelp Search Export squid settings. Control result limits and enable contact harvesting to extract email addresses from business websites.

Headers

KeyValueRequired
AuthorizationToken YOUR_API_KEYYes
Content-Typeapplication/jsonYes

Scraper Parameters

max_results
Type:
integer
Default:
null
Description:
Maximum number of businesses to collect before stopping
collect_contacts
Type:
boolean
Default:
false
Description:
Visit each business's website to extract email addresses and social links

Squid Settings

name
Type:
string
Description:
Display name for your squid configuration
concurrency
Type:
integer
Description:
Number of parallel scraping threads (default: 1)
export_unique_results
Type:
boolean
Description:
Export only unique results (deduplicated)
to_complete
Type:
boolean
Description:
Run until all tasks complete
no_line_breaks
Type:
boolean
Description:
Remove line breaks from results
Pro Tip

Pro Tip

Enable `collect_contacts` to extract email addresses from business websites for outreach campaigns.
Warning

Warning

Enabling `collect_contacts` adds extra HTTP requests per business, increasing total run time and credit usage.
Note

Note

Use `max_results` to limit the scope of large searches and control costs.