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

Documentation Index

Fetch the complete documentation index at: https://docs.lobstr.io/llms.txt

Use this file to discover all available pages before exploring further.

Configure the scraper parameters to control how Google Search results are collected. These settings include pagination, location, language, and device type options.

​
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:
ParameterTypeDescription
max_pagesintegerMaximum search result pages to crawl per keyword. Google limits to ~300-400 total results.
results_per_pageintegerResults per page: 10, 20, 30, 40, 50, or 100. Default: 10
countrystringSets IP origin country and Google domain (e.g., google.fr for France). Default: United States
locationstringGeographic bias for results (state, city). Use Get Geolocation to find valid values.
languagestringLanguage for search results. Defaults to English for the chosen country.
mobile_resultsbooleanIf true, returns mobile device results; otherwise desktop results.
Use the Get Geolocation endpoint to discover valid location values.
Higher max_pages values will collect more results but use more credits.

​
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 Search Scraper",
    "concurrency": 1,
    "export_unique_results": true,
    "to_complete": false,
    "no_line_breaks": true,
    "params": {
      "country": "United States",
      "language": "English",
      "max_pages": 4,
      "mobile_results": false,
      "results_per_page": 10,
      "location": "Alabama"
    }
  }'

​
Response

201
{
  "name": "Google Search Scraper",
  "no_line_breaks": true,
  "params": {
    "country": "United States",
    "language": "English",
    "max_pages": 4,
    "mobile_results": false,
    "results_per_page": 10,
    "location": "Alabama"
  },
  "to_complete": false,
  "export_unique_results": true
}