Skip to content
Examples

Update Settings

Configure the Pages Jaunes Companies Search Export scraper parameters and enrichment options

The v1 API, for batchesSquids, tasks and runs: many calls on a schedule, delivered where you work. For one call that answers in seconds, use the API v2.
POSThttps://api.lobstr.io/v1/squids/{squid_hash}

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

Authorizationstringheaderrequired

Your API authentication token. Value: Token YOUR_API_KEY

Content-Typestringheaderrequired

Request body format. Value: application/json

Scraper Parameters

Set these parameters in the params object:

Parameter Type Default Description
max_pages integer unlimited Maximum number of search result pages to scrape
max_unique_results_per_run integer unlimited Maximum unique results across all tasks in the run
functions.collect_contacts boolean true Visit 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_details boolean true Collect 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:

Setting Type Description
name string Display name for your squid configuration
concurrency integer Number of parallel scraping threads (default: 1)
export_unique_results boolean Export only unique results (deduplicated)
to_complete boolean Run until all tasks complete
no_line_breaks boolean Remove 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
  }
}