Examples
Update Settings
Configure the Yelp Reviews Export scraper settings
The v1 API, for batchesSquids, tasks and runs: many calls on a schedule, delivered where you work. For one call that answers in seconds, use the API v2.
POST
https://api.lobstr.io/v1/squids/{squid_hash}Configure your Yelp Reviews Export squid settings. Filter reviews by rating, sort order, language, or keyword, and use fetch_since to collect only recent reviews.
Headers
AuthorizationstringheaderrequiredYour API authentication token. Value: Token YOUR_API_KEY
Content-TypestringheaderrequiredRequest body format. Value: application/json
Scraper Parameters
Set these parameters in the params object:
| Parameter | Type | Default | Description |
|---|---|---|---|
| max_results | integer | unlimited | Maximum number of reviews to collect per business URL |
| max_unique_results_per_run | integer | unlimited | Maximum unique reviews across all tasks in the run |
| sort | string | Yelp Sort | Sort order: Yelp Sort, Newest First, Oldest First, Highest Rated, Lowest Rated, Elites |
| rating | string | All Ratings | Filter by star rating: All Ratings, 5 Stars, 4 Stars, 3 Stars, 2 Stars, 1 Star |
| language | string | — | Filter reviews by language (ISO 639-1 code, e.g. en, fr, de). Leave empty to collect all languages. |
| fetch_since | string | — | Stop scraping when reviews older than this threshold are reached. Use a relative duration (24h, 7d, 2w) or an absolute date (YYYY-MM-DD HH:MM:SS). Works best with sort: "Newest First". |
| term | string | — | Keyword to search inside review text (e.g. great service). When set, sort and rating filters are ignored. |
| collect_not_recommended_reviews | boolean | false | Also collect the reviews Yelp hides under "reviews that are not currently recommended". They are collected first and marked is_recommended = false. Yelp shows fewer details for them (no votes, photos, language or member-since), and sort does not apply to them. |
Squid Settings
Configure general squid settings:
| Setting | Type | Description |
|---|---|---|
| name | string | Display name for your squid configuration |
| concurrency | integer | Number of parallel scraping threads (default: 1) |
| export_unique_results | boolean | Export only unique results (deduplicated) |
| to_complete | boolean | Run until all tasks complete |
| no_line_breaks | boolean | Remove 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" } }