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 Yelp Reviews Export squid settings. Filter reviews by rating, sort order, or keyword, and set limits to control how many reviews are collected.

​
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 business URL
max_unique_results_per_runintegerunlimitedMaximum unique reviews across all tasks in the run
sortstringYelp SortSort order: Yelp Sort, Newest First, Oldest First, Highest Rated, Lowest Rated, Elites
ratingstringAll RatingsFilter by star rating: All Ratings, 5 Stars, 4 Stars, 3 Stars, 2 Stars, 1 Star
termstringnullKeyword to search inside review text (e.g. great service). When set, sort and rating filters are ignored

​
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 rating: "1 Star" combined with sort: "Newest First" to monitor recent negative reviews for reputation management.
When term is set, Yelp overrides the sort and rating parameters server-side — they will be ignored.

​
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": "Yelp Reviews Export (1)",
    "concurrency": 1,
    "export_unique_results": true,
    "to_complete": false,
    "no_line_breaks": true,
    "params": {
      "max_results": 500,
      "sort": "Newest First",
      "rating": "All Ratings"
    }
  }'

​
Response

201
{
  "name": "Yelp Reviews Export (1)",
  "concurrency": 1,
  "export_unique_results": true,
  "to_complete": false,
  "no_line_breaks": true,
  "params": {
    "max_results": 500,
    "sort": "Newest First",
    "rating": "All Ratings"
  }
}