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 Pages Jaunes Companies Search Export squid settings to control pagination and enable detailed company information enrichment. Enable functions to collect email addresses, social media profiles, and official business registration numbers.

​
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_pagesintegerunlimitedMaximum number of search result pages to scrape
functions.collect_emails_from_websitebooleantrueVisit each company’s website to collect email addresses and social media links (1 credit per company)
functions.collect_additional_detailsbooleantrueCollect SIRET, SIREN, NAF codes and other official business registration details (1 credit per company)

​
Function Details

When functions.collect_additional_details is enabled, the scraper collects additional structured data including SIRET number, SIREN number, NAF/APE code, and official company registration details from French business registries.

​
General Settings

Standard squid settings that apply to all scrapers:
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
Enabling functions.collect_emails_from_website or functions.collect_additional_details increases run time due to additional HTTP requests per listing.
SIRET numbers are valuable for B2B verification and can be used to look up official company information in French government databases.
Backward compatibility: The old function names collect_contacts and results_details are still accepted but deprecated. Migrate to collect_emails_from_website and collect_additional_details respectively.

​
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": "Pages Jaunes Companies Search Export (2)",
    "concurrency": 1,
    "export_unique_results": true,
    "to_complete": false,
    "no_line_breaks": true,
    "params": {
      "functions": {
        "collect_additional_details": true,
        "collect_emails_from_website": true
      },
      "max_pages": 3
    }
  }'

​
Response

201
{
  "name": "Pages Jaunes Companies Search Export (2)",
  "concurrency": 1,
  "export_unique_results": true,
  "to_complete": false,
  "no_line_breaks": true,
  "params": {
    "functions": {
      "collect_additional_details": true,
      "collect_emails_from_website": true
    },
    "max_pages": 3
  }
}