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>'
Configure your Twitter Followers/Following Scraper squid settings. Choose whether to scrape followers, following, or both for each target account.

​
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
scrape_followersbooleanfalseIf true, collect the account’s followers list
scrape_followingbooleanfalseIf true, collect the accounts the user is following
max_unique_results_per_runintegerunlimitedMaximum unique results across all tasks in the run

​
Squid Settings

Configure general squid settings:
SettingTypeDescription
namestringDisplay name for your squid configuration
concurrencyintegerNumber of parallel scraping threads (default: 1)
accountsarrayArray of linked Twitter account hashes (required)
export_unique_resultsbooleanExport only unique results (deduplicated)
to_completebooleanRun until all tasks complete
no_line_breaksbooleanRemove line breaks from results
This scraper requires a synced Twitter/X account. Add your Twitter cookies in the Accounts section before running.
Enable both scrape_followers and scrape_following to get a complete picture of an account’s network.

​
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 Followers/Following Scraper (1)",
    "concurrency": 1,
    "export_unique_results": true,
    "to_complete": false,
    "no_line_breaks": true,
    "params": {
      "scrape_followers": true,
      "scrape_following": false
    }
  }'

​
Response

201
{
  "name": "Twitter Followers/Following Scraper (1)",
  "concurrency": 1,
  "export_unique_results": true,
  "to_complete": false,
  "no_line_breaks": true,
  "params": {
    "scrape_followers": true,
    "scrape_following": false
  }
}