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>'
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
max_unique_results_per_runintegerunlimitedMaximum unique results across all tasks in the run
functions.collect_contactsbooleantrueVisit each company’s detail page to collect enriched data: opening hours, images, social links, payment methods, services, reviews and more (1 credit per company)
functions.results_detailsbooleantrueCollect official business registration details: SIRET, SIREN, NAF codes, legal form, and other registry data (1 credit per company)

​
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_contacts or functions.results_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.

​
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_contacts": true,
        "results_details": 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_contacts": true,
      "results_details": true
    },
    "max_pages": 3
  }
}