Skip to main content
POST
/
v1
/
squids
/
{squid_hash}
Update Settings
curl --request POST \
  --url https://api.lobstr.io/v1/squids/{squid_hash} \
  --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.

Configure your Twitter User Tweets Scraper squid settings. Control the number of tweets to fetch, time filtering, and whether to include retweets and pinned tweets.

​
Headers

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

​
Scraper Parameters

Set these parameters in the params object:
ParameterTypeDefaultDescription
jsonbooleanfalseIf true, returns the complete raw JSON payload for each tweet
max_resultsintegernullMaximum number of tweets to scrape per user
fetch_sincestringnullStop scraping when items older than this threshold are reached (based on published_at). Use a relative duration (24h, 7d, 2w) or an absolute date (YYYY-MM-DD HH:MM)
fetch_since_timezonestringnullTimezone for interpreting an absolute fetch_since date (e.g. Europe/Paris). Only applies when fetch_since is an absolute date — ignored for relative values like 24h or 7d. See supported timezones.
exclude_repostsbooleanfalseIf true, excludes retweets from results
collect_pinned_tweetsbooleanfalseIf true, includes pinned tweets in results

​
Squid Settings

Configure general squid settings:
SettingTypeDescription
namestringDisplay name for your squid configuration
concurrencyintegerNumber of parallel scraping threads (default: 1)
export_unique_resultsbooleanExport only unique results (deduplicated)
to_completebooleanRun until all tasks complete
no_line_breaksbooleanRemove line breaks from results
Use fetch_since to monitor recent activity - set to 24 to only collect tweets from the last day.
Enable exclude_reposts to focus on original content only.
Pinned tweets are not collected by default - enable collect_pinned_tweets if you need them.

​
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": "Twitter User Tweets Scraper (2)",
    "concurrency": 1,
    "export_unique_results": true,
    "to_complete": false,
    "no_line_breaks": true,
    "params": {
      "json": true,
      "fetch_since": null,
      "max_results": 98,
      "exclude_reposts": true,
      "collect_pinned_tweets": true
    }
  }'

​
Response

201
{
  "name": "Twitter User Tweets Scraper (2)",
  "no_line_breaks": true,
  "params": {
    "json": true,
    "fetch_since": null,
    "max_results": 98,
    "exclude_reposts": true,
    "collect_pinned_tweets": true
  },
  "to_complete": false,
  "export_unique_results": true
}