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 reviews are collected. These settings determine sorting, filtering, and what data is extracted.

​
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
sort_bystringnewestSort reviews: newest, most_relevant, highest_rating, or lowest_rating
fetch_sincestringnullStop scraping when items older than this threshold are reached (based on modified_at_datetime). Use a relative duration (24h, 7d, 2w) or an absolute date (YYYY-MM-DD HH:MM)
fetch_since_timezonestringnullTimezone for interpreting an absolute fetch_since date (e.g. Europe/Paris). Only applies when fetch_since is an absolute date — ignored for relative values like 24h or 7d. See supported timezones.
max_resultsinteger20Maximum number of reviews to collect per place
languagestringEnglish (United States)Language for extracted reviews
functions.get_short_review_linkbooleanfalseCollect shortened review links (1 credit per review)

​
Squid Settings

You can also configure general squid settings:
SettingTypeDescription
namestringName for your squid configuration
concurrencyintegerNumber of parallel scraping workers (1-10)
export_unique_resultsbooleanOnly export unique results (deduplicated)
run_notifystringWhen to send notifications: on_success, on_failure, always, never
timezonestringTimezone for timestamps (e.g., Europe/Paris)
Use sort_by: newest to monitor recent reviews for reputation management.
Set fetch_since to limit results to recent reviews only, reducing processing time and costs.
Enabling functions.get_short_review_link costs 1 credit per review. Only enable if you need shortened URLs.
Backward compatibility: The old function name short_link is still accepted but deprecated. Migrate to get_short_review_link.
Changes take effect on the next run. Running jobs use the settings from when they started.

​
Code Examples

curl -X POST "https://api.lobstr.io/v1/squids/b6ab0f03b02e472a8e2ab0b16b4fdd0f" \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Restaurant Reviews Paris",
    "concurrency": 1,
    "export_unique_results": true,
    "run_notify": "on_success",
    "timezone": "Europe/Paris",
    "params": {
      "sort_by": "newest",
      "fetch_since": null,
      "max_results": 20,
      "language": "English (United States)",
      "functions": {
        "get_short_review_link": false
      }
    }
  }'

​
Response

201
{
  "name": "Restaurant Reviews Paris",
  "no_line_breaks": true,
  "params": {
    "sort_by": "newest",
    "fetch_since": null,
    "max_results": 20,
    "language": "English (United States)",
    "functions": {
      "get_short_review_link": false
    }
  },
  "to_complete": false,
  "run_notify": "on_success",
  "export_unique_results": true
}