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 Sales Navigator Companies Scraper squid settings. Control pagination depth and result limits.

​
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_pagesinteger100Maximum number of search result pages to scrape (max: 100)
max_resultsintegerunlimitedMaximum companies to collect per task (max: 5000)
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)
export_unique_resultsbooleanExport only unique results (deduplicated)
to_completebooleanRun until all tasks complete
no_line_breaksbooleanRemove line breaks from results

​
Pagination

Sales Navigator displays 25 companies per page. With max_pages set to 100 (default), you can collect up to 2,500 companies per search URL. For larger datasets, use multiple search URLs with different filters.
Set max_pages to a lower value if you only need companies from the first few pages of results.
Credits are charged per company collected (1 credit per company).

​
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 Companies Scraper (1)",
    "concurrency": 5,
    "export_unique_results": true,
    "to_complete": false,
    "no_line_breaks": true,
    "params": {
      "max_pages": 50,
      "max_results": 1000
    }
  }'

​
Response

201
{
  "name": "Sales Navigator Companies Scraper (1)",
  "concurrency": 5,
  "export_unique_results": true,
  "to_complete": false,
  "no_line_breaks": true,
  "params": {
    "max_pages": 50,
    "max_results": 1000
  }
}