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 Amazon Reviews Scraper squid settings. Control how reviews are sorted, filtered, and limited.

​
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_bystringrecentSort order for reviews: recent, top_reviews
filter_by_starstringall_starsFilter by star rating: all_stars, five_star, four_star, three_star, two_star, one_star, positive, critical
reviewer_typestringall_reviewersFilter by reviewer type: all_reviewers, verified_purchase_only
media_typestringtext_image_videoFilter by review media: text_image_video, image_and_video_only
format_typestringall_variantsFilter by product variant: all_variants, current_format
filter_by_keywordstringnullOnly return reviews containing this keyword
max_resultsinteger100Maximum number of reviews to collect per product
max_unique_results_per_runintegerunlimitedMaximum unique reviews across all tasks in the run
scrape_max_reviewsbooleanfalseIf true, attempt to collect all available reviews
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
This scraper requires a synced Amazon account. Add your Amazon cookies in the Accounts section before running.
Use filter_by_star: critical to monitor negative feedback, or sort_by: recent combined with fetch_since to track new reviews.

​
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": "Amazon Reviews Scraper (1)",
    "concurrency": 1,
    "export_unique_results": true,
    "to_complete": false,
    "no_line_breaks": true,
    "params": {
      "sort_by": "recent",
      "filter_by_star": "all_stars",
      "reviewer_type": "verified_purchase_only",
      "media_type": "text_image_video",
      "format_type": "all_variants",
      "max_results": 100,
      "fetch_since": "7d"
    }
  }'

​
Response

201
{
  "name": "Amazon Reviews Scraper (1)",
  "concurrency": 1,
  "export_unique_results": true,
  "to_complete": false,
  "no_line_breaks": true,
  "params": {
    "sort_by": "recent",
    "filter_by_star": "all_stars",
    "reviewer_type": "verified_purchase_only",
    "max_results": 100,
    "fetch_since": "7d"
  }
}