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 LinkedIn Profile Scraper squid settings. The main configurable option is email enrichment, which uses lobstr.io’s enrichment service to find email addresses for the profiles you scrape.

​
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
email_enrichmentbooleantrueEnable email enrichment to find email addresses for profiles (9 credits per profile where an email is found)

​
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

​
Email Enrichment

When email enrichment is enabled, lobstr.io will attempt to find the email address associated with each LinkedIn profile. Pricing: 9 credits per profile enriched. No email found = 0 credits charged. The enrichment service returns:
  • email: The discovered email address (if found)
  • email_status: Validation status of the email (valid, invalid, catch-all, etc.)
Email enrichment is enabled by default. Disable it before running if you don’t need email data to avoid unexpected credit usage.
If you don’t need email addresses, disable enrichment to reduce costs: set email_enrichment to false.
Backward compatibility: The old function name email is still accepted but deprecated. Migrate to email_enrichment.

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

​
Response

201
{
  "name": "LinkedIn Profile Scraper (1)",
  "concurrency": 1,
  "export_unique_results": true,
  "to_complete": false,
  "no_line_breaks": true,
  "params": {
    "email_enrichment": true
  }
}