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 Twitter users to scrape tweets from by providing their screen names (usernames). The scraper will retrieve tweets from the specified user’s timeline.

​
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 Twitter User Tweets Scraper
tasksarrayYesArray of task objects, each containing a screen_name field

​
Task Object

FieldTypeRequiredDescription
screen_namestringYesTwitter username without the @ symbol (e.g., elonmusk)
You can add multiple screen names in a single request to scrape tweets from several users at once.
The screen_name should not include the @ symbol - use elonmusk not @elonmusk.

​
Code Examples

curl -X POST "https://api.lobstr.io/v1/tasks" \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "tasks": [
      {
        "screen_name": "elonmusk"
      }
    ],
    "squid": "YOUR_SQUID_HASH"
  }'

​
Response

200
{
  "duplicated_count": 0,
  "tasks": [
    {
      "id": "dea6b229a9cf67cc5363dfe6062b63ba",
      "created_at": "2025-07-07T09:36:01.623358",
      "is_active": true,
      "params": {
        "username": "elonmusk"
      },
      "module": 127,
      "object": "task"
    }
  ]
}