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 search URLs to scrape business listings. The scraper extracts business details including contact information, ratings, reviews, categories, and location data.

​
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 Search Export crawler
tasksarrayYesArray of task objects, each containing a url field

​
Task Object

FieldTypeRequiredDescription
urlstringYesYelp search URL (e.g., https://www.yelp.com/search?find_desc=Restaurants&find_loc=New+York)
Perform your search on Yelp first, apply filters (category, location, price range), then copy the URL to preserve all parameters.
Yelp search URLs use find_desc for the search term and find_loc for the location.

​
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/search?find_desc=Restaurants&find_loc=New+York%2C+NY"
      }
    ]
  }'

​
Response

200
{
  "duplicated_count": 0,
  "tasks": [
    {
      "id": "82367f24d9450b2222080eed91662968",
      "created_at": "2025-07-17T09:06:47.287893",
      "is_active": true,
      "params": {
        "url": "https://www.yelp.com/search?find_desc=Restaurants&find_loc=New+York%2C+NY"
      },
      "module": 115,
      "object": "task"
    }
  ]
}