Skip to content
Examples

Update Settings

Configure the Google Maps Leads Scraper parameters

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 the scraper parameters to control how places are collected. These settings include language, location context, filters, and optional data collection features.

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
country string — Regional context for search results (e.g., United States)
ratings string Any rating Minimum rating filter: Any rating, 2.5+, 3.0+, 3.5+, 4.0+, 4.5+
max_rating string Any rating Maximum rating filter. Combine with ratings to define a score range (e.g. collect only 3–4 star businesses)
min_reviews integer — Only collect places with at least this many reviews
max_reviews integer — Only collect places with at most this many reviews
exact_name_match boolean false Only collect places whose name matches your search query — useful to target a specific brand or chain
phone_filter string all Filter by phone presence: all, with_phone, without_phone
verified_filter string all Filter by owner-claimed status: all, verified_only, unverified_only
language string — Language for place names and metadata (e.g., English (United States))
max_results integer unlimited Maximum places to collect before task ends
geo_match boolean true Only return results within 10 km of the search point: the task city's coordinates, or the @lat,lng center of a Google Maps URL. Same rule in every country; postal codes are not checked
category_match boolean true Only return results that match the searched business category
skip_closed boolean false Skip permanently closed businesses
website_filter string all Filter by website presence: all, with_website, without_website
skip_without_email boolean false Skip businesses where no email address was found

Optional Functions

Enable these in the params.functions object:

Function Type Description
extract_emails_from_website boolean Visit business website to extract email, Facebook, Instagram, and additional phone
fetch_business_images boolean Collect all image URLs from the Google Place page
collect_business_details boolean Collect additional metadata like plus_code, poi, health, and last_opening_hours_updated_at

Enabling extract_emails_from_website, fetch_business_images, or collect_business_details may incur additional credits.

Backward compatibility: The old function names collect_contacts, images, and details are still accepted but deprecated. Migrate to the new names listed above.

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

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": "Google Maps Search Export",
    "no_line_breaks": true,
    "params": {
      "country": "United States",
      "ratings": "Any rating",
      "language": "English (United States)",
      "functions": {
        "fetch_business_images": true,
        "collect_business_details": true,
        "extract_emails_from_website": true
      },
      "max_results": 200
    },
    "to_complete": false,
    "export_unique_results": true
  }'

Response

201
{
  "name": "Google Maps Search Export",
  "no_line_breaks": true,
  "params": {
    "country": "United States",
    "ratings": "Any rating",
    "language": "English (United States)",
    "functions": {
      "fetch_business_images": true,
      "collect_business_details": true,
      "extract_emails_from_website": true
    },
    "max_results": 200
  },
  "to_complete": false,
  "export_unique_results": true
}