Skip to main content
POST
/
v1
/
tasks
Add Tasks
curl --request POST \
  --url https://api.lobstr.io/v1/tasks \
  --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.

Add Yelp business page URLs to collect all reviews for each business. The scraper extracts the full review text, star rating, reviewer profile, photos, and community votes.

​
Headers

​
Authorization
string
required
Your API authentication token. Value: Token YOUR_API_KEY
​
Content-Type
string
required
Request body format. Value: application/json

​
Request Body

FieldTypeRequiredDescription
squidstringYesHash of your squid configured with the Yelp Reviews Export crawler
tasksarrayYesArray of task objects, each containing a url field

​
Task Object

FieldTypeRequiredDescription
urlstringYesFull Yelp business URL — must contain /biz/<alias> (e.g., https://www.yelp.com/biz/olio-e-piu-new-york-7). Also accepts country variants (yelp.fr, yelp.co.uk, etc.)
Find the business on Yelp, then copy the URL from the address bar. Make sure it contains /biz/ — not a search URL.

​
Code Examples

curl -X POST "https://api.lobstr.io/v1/tasks" \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "squid": "YOUR_SQUID_HASH",
    "tasks": [
      {
        "url": "https://www.yelp.com/biz/olio-e-piu-new-york-7"
      }
    ]
  }'

​
Response

200
{
  "duplicated_count": 0,
  "tasks": [
    {
      "id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
      "created_at": "2026-05-12T10:00:00.000000",
      "is_active": true,
      "params": {
        "url": "https://www.yelp.com/biz/olio-e-piu-new-york-7"
      },
      "module": 116,
      "object": "task"
    }
  ]
}