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 Reddit URLs to collect posts, comments, user profiles, or subreddit metadata. The scraper handles post threads (with nested comments), subreddit feeds, user profile pages, and global or subreddit-scoped search results.

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

​
Task Object

FieldTypeRequiredDescription
urlstringYesReddit URL to scrape — see supported URL types below

​
Supported URL Types

TypeExample
Post threadhttps://www.reddit.com/r/Bitcoin/comments/1rcbgsa/crypto_beginners/
Subreddithttps://www.reddit.com/r/Bitcoin/
User profilehttps://www.reddit.com/user/thisisbillgates/
Global searchhttps://www.reddit.com/search/?q=bitcoin
Subreddit searchhttps://www.reddit.com/r/Bitcoin/search/?q=lightning
For post URLs, the scraper returns one row for the post itself and one row per comment. Use skip_comments or skip_posts in settings to limit output to just one type.

​
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.reddit.com/r/Bitcoin/"
      }
    ]
  }'

​
Response

200
{
  "duplicated_count": 0,
  "tasks": [
    {
      "id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
      "created_at": "2026-05-20T10:00:00.000000",
      "is_active": true,
      "params": {
        "url": "https://www.reddit.com/r/Bitcoin/"
      },
      "module": 118,
      "object": "task"
    }
  ]
}