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

​
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
countrystring—Regional context for search results (e.g., United States)
ratingsstringAny ratingFilter by rating threshold: Any rating, 4.0+, 2.5+
languagestring—Language for place names and metadata (e.g., English (United States))
max_resultsintegerunlimitedMaximum places to collect before task ends
geo_matchbooleantrueOnly return results that geographically match the searched location
category_matchbooleantrueOnly return results that match the searched business category
skip_closedbooleanfalseSkip permanently closed businesses
website_filterstringallFilter by website presence: all, with_website, without_website
skip_without_emailbooleanfalseSkip businesses where no email address was found

​
Optional Functions

Enable these in the params.functions object:
FunctionTypeDescription
extract_emails_from_websitebooleanVisit business website to extract email, Facebook, Instagram, and additional phone
fetch_business_imagesbooleanCollect all image URLs from the Google Place page
collect_business_detailsbooleanCollect 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
}