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 Leads Scraper squid settings. Control result limits and enable email enrichment or profile detail collection.

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
max_resultsinteger1000Maximum number of leads to collect per task

Optional Functions

Enable these in the params.functions object:
FunctionTypeDefaultDescription
email_enrichmentbooleantrueFind email addresses for each profile (9 credits per profile where an email is found)
scrape_profile_detailsbooleantrueCollect additional profile details from each LinkedIn profile page (1 credit per profile)

Squid Settings

Configure general squid settings:
SettingTypeDescription
namestringDisplay name for your squid configuration
concurrencyintegerNumber of parallel scraping threads (default: 1)
accountsarrayArray of linked LinkedIn account hashes (required)
export_unique_resultsbooleanExport only unique results (deduplicated)
to_completebooleanRun until all tasks complete
no_line_breaksbooleanRemove line breaks from results
Both email_enrichment and scrape_profile_details are enabled by default. Disable them if not needed to reduce credit usage.
This scraper requires a synced LinkedIn account. Add your LinkedIn cookies in the Accounts section before running.

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 Leads Scraper (1)",
    "concurrency": 1,
    "export_unique_results": true,
    "to_complete": false,
    "no_line_breaks": true,
    "params": {
      "max_results": 1000,
      "functions": {
        "email_enrichment": true,
        "scrape_profile_details": true
      }
    }
  }'

Response

201
{
  "name": "LinkedIn Leads Scraper (1)",
  "concurrency": 1,
  "export_unique_results": true,
  "to_complete": false,
  "no_line_breaks": true,
  "params": {
    "max_results": 1000,
    "functions": {
      "email_enrichment": true,
      "scrape_profile_details": true
    }
  }
}