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 your Trustpilot Reviews Scraper squid settings. Filter by star rating, language, date, and more to target specific review types.

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
max_resultsinteger200Maximum number of reviews to collect per company page
max_unique_results_per_runintegerunlimitedMaximum unique reviews across all tasks in the run
sort_bystringrecencySort order: recency, relevance
starsstringallFilter by star rating: all, 1, 2, 3, 4, 5
languagestringAll languagesFilter by review language. Allowed values: All languages, Arabic, Chinese (Simplified), Chinese (Traditional), Danish, Dutch, English, Finnish, French, German, Greek, Hebrew, Indonesian, Italian, Japanese, Korean, Norwegian, Polish, Portuguese, Russian, Spanish, Swedish, Thai, Turkish, Vietnamese
verifiedbooleanfalseOnly return reviews from verified purchases
repliesbooleanfalseInclude company replies in the results
searchstringnullFilter reviews by keyword
topicsstringnullFilter by Trustpilot topic tag
start_pageinteger1Page number to start scraping from
fetch_sincestringnullStop scraping when items older than this threshold are reached (based on published_at). 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.

Squid Settings

Configure general squid settings:
SettingTypeDescription
namestringDisplay name for your squid configuration
concurrencyintegerNumber of parallel scraping threads (default: 1)
export_unique_resultsbooleanExport only unique results (deduplicated)
to_completebooleanRun until all tasks complete
no_line_breaksbooleanRemove line breaks from results
Use stars: 1 combined with fetch_since: 7d to monitor recent negative reviews for reputation management.
Set verified: true to focus on reviews from confirmed customers only.

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": "Trustpilot Reviews Scraper (1)",
    "concurrency": 1,
    "export_unique_results": true,
    "to_complete": false,
    "no_line_breaks": true,
    "params": {
      "max_results": 200,
      "sort_by": "recency",
      "stars": "all",
      "language": "English",
      "verified": false,
      "replies": false,
      "fetch_since": null
    }
  }'

Response

201
{
  "name": "Trustpilot Reviews Scraper (1)",
  "concurrency": 1,
  "export_unique_results": true,
  "to_complete": false,
  "no_line_breaks": true,
  "params": {
    "max_results": 200,
    "sort_by": "recency",
    "stars": "all",
    "language": "English",
    "verified": false,
    "replies": false,
    "fetch_since": null
  }
}