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 TripAdvisor Reviews Scraper squid settings to control review collection limits and apply filters by language, rating, and recency. These settings help you target specific review types and optimize credit usage.

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_resultsintegerunlimitedMaximum number of reviews to collect per listing
max_unique_results_per_runintegerunlimitedMaximum unique reviews across all tasks in the run
languagestringAll languagesFilter reviews by language (e.g., English, French, German)
ratingsstringAll ratingsFilter by star rating: 1, 2, 3, 4, 5
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.

General Settings

Standard squid settings that apply to all scrapers:
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 the language and ratings filters to collect only high-quality reviews in your target language, reducing noise and credit consumption.
Set fetch_since to null for all reviews, or use a relative duration ("24h", "7d", "2w") or absolute date ("YYYY-MM-DD HH:MM") to collect only recent reviews. When using an absolute date, set fetch_since_timezone to interpret it in the correct timezone (e.g. "Europe/Paris").
Reviews include subratings (Value, Rooms, Location, Cleanliness, Service, Sleep Quality) for hotels, providing detailed insights beyond the overall rating.

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": "TripAdvisor Reviews - NYC Hotels",
    "params": {
      "max_results": 100,
      "language": "English",
      "ratings": "5",
      "fetch_since": null,
      "fetch_since_timezone": null
    }
  }'

Response

201
{
  "id": "c7ea965333d54a949a9e74ba62029098",
  "name": "TripAdvisor Reviews - NYC Hotels",
  "crawler": {
    "id": 132,
    "name": "TripAdvisor Reviews Scraper",
    "slug": "tripadvisor-reviews-scraper"
  },
  "params": {
    "max_results": 100,
    "language": "English",
    "ratings": "5",
    "fetch_since": null,
    "fetch_since_timezone": null
  },
  "concurrency": 5,
  "export_unique_results": true,
  "to_complete": true,
  "no_line_breaks": false,
  "status": "idle",
  "created_at": "2025-01-20T10:15:00.000000",
  "updated_at": "2025-01-27T14:35:00.000000"
}