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 squid settings for the Sales Navigator Leads Scraper. This scraper supports email enrichment and requires linked Sales Navigator accounts.

​
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
functions.email_enrichmentbooleanfalseEnable email enrichment using lobstr.io’s service (9 credits per profile where an email is found)
functions.mobile_enrichmentbooleanfalseEnable mobile phone enrichment (300 credits per profile where a mobile number is found)
profiles_per_pageinteger25Number of leads to scrape per page (max: 25)
max_pagesinteger100Maximum number of pages to crawl (max: 100)
max_resultsintegernullTotal leads to collect before stopping (null = no limit)

​
Squid Settings

Configure general squid settings:
SettingTypeDescription
namestringDisplay name for your squid configuration
accountsarrayArray of linked Sales Navigator account hashes (required)
export_unique_resultsbooleanExport only unique results (deduplicated)
to_completebooleanRun until all tasks complete
no_line_breaksbooleanRemove line breaks from results
Enabling functions.email_enrichment incurs additional credit costs for email enrichment.
Use multiple Sales Navigator accounts in the accounts array to increase throughput and avoid rate limits.
Sales Navigator limits search results to 2,500 leads. Use more specific filters to access different lead segments.
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": "Sales Navigator Leads Scraper (1)",
    "accounts": ["YOUR_SALES_NAV_ACCOUNT_HASH"],
    "no_line_breaks": true,
    "export_unique_results": true,
    "to_complete": false,
    "params": {
      "functions": {
        "email_enrichment": true
      },
      "profiles_per_page": 25,
      "max_pages": 100,
      "max_results": null
    }
  }'

​
Response

201
{
  "name": "Sales Navigator Leads Scraper (1)",
  "no_line_breaks": true,
  "params": {
    "functions": {
      "email_enrichment": true
    },
    "max_pages": 100,
    "max_results": null,
    "profiles_per_page": 25
  },
  "to_complete": false,
  "export_unique_results": true
}