POST/v1/squids/{squid_hash}

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

KeyValueRequired
AuthorizationToken YOUR_API_KEYYes
Content-Typeapplication/jsonYes

Scraper Parameters

country
Type:
string
Description:
Regional context for search results (e.g., `United States`)
ratings
Type:
string
Description:
Filter by rating threshold: `Any rating`, `4.0+`, `2.5+`
language
Type:
string
Description:
Language for place names and metadata (e.g., `English (United States)`)
max_results
Type:
integer
Description:
Maximum places to collect before task ends

Optional Functions

collect_contacts
Type:
boolean
Description:
Visit business website to extract email, Facebook, Instagram, and additional phone
images
Type:
boolean
Description:
Collect all image URLs from the Google Place page
details
Type:
boolean
Description:
Collect additional metadata like plus_code, poi, health, and last_opening_hours_updated_at
Warning

Warning

Enabling `collect_contacts`, `images`, or `details` may incur additional credits.
Pro Tip

Pro Tip

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