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 Profile Scraper squid settings. Control output format, concurrency, and whether to return raw JSON data from Twitter’s API.

​
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 the user profile

​
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
Enable json: true to get the complete raw API response for advanced analysis or custom field extraction.
The raw JSON contains additional fields not included in the parsed output.

​
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 Profile Scraper (2)",
    "concurrency": 1,
    "export_unique_results": true,
    "to_complete": false,
    "no_line_breaks": true,
    "params": {
      "json": true
    }
  }'

​
Response

201
{
  "name": "Twitter Profile Scraper (2)",
  "no_line_breaks": true,
  "params": {
    "json": true
  },
  "to_complete": false,
  "export_unique_results": true
}