Skip to content
Examples

Update Settings

Configure SeLoger Search Export scraper settings

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 SeLoger Search Export squid settings. Control pagination and enable detail page enrichment to get full descriptions and geographic coordinates.

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 400 Maximum number of search result pages to crawl (max: 400)
max_unique_results_per_run integer unlimited Maximum unique results across all tasks in the run
functions.get_annonce_details boolean false Visit each listing's detail page to fetch full description, coordinates (lat/lng), and extra attributes (4 credits per listing)

Squid Settings

Configure general squid settings:

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

Enable functions.get_annonce_details to get full property descriptions and exact GPS coordinates.

Enabling get_annonce_details increases run time as each listing requires an additional HTTP request.

Use max_pages to limit the scope of large searches and control credit usage.

Backward compatibility: The old function name annonce_details is still accepted but deprecated. Migrate to get_annonce_details.

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": "SeLoger Search Export (1)",
    "concurrency": 5,
    "export_unique_results": true,
    "to_complete": false,
    "no_line_breaks": true,
    "params": {
      "functions": {
        "get_annonce_details": true
      },
      "max_pages": 4
    }
  }'

Response

201
{
  "name": "SeLoger Search Export (1)",
  "concurrency": 5,
  "export_unique_results": true,
  "to_complete": false,
  "no_line_breaks": true,
  "params": {
    "functions": {
      "get_annonce_details": true
    },
    "max_pages": 4
  }
}