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>' \
  --data '
{
  "params": {},
  "params.max_results": 123,
  "params.max_unique_results_per_run": 123,
  "params.max_pages": 123,
  "params.fetch_since": "<string>",
  "params.fetch_since_timezone": "<string>",
  "params.get_annonce_details": true
}
'

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.

Update the configuration of your ParuVendu Listings Scraper squid. Pass crawler-specific settings inside the params object.

Headers

Authorization
string
required
Your API authentication token. Value: Token YOUR_API_KEY
Content-Type
string
required
Must be application/json. Value: application/json

Body

params
object
Crawler-specific settings. See fields below.

Settings Fields

params.max_results
integer
Maximum number of listings to collect per task. Leave empty for unlimited.
params.max_unique_results_per_run
integer
Maximum number of unique results across all tasks in a run. Leave empty for unlimited.
params.max_pages
integer
Maximum number of search result pages to crawl per task. Default: 100, max: 100.
params.fetch_since
string
Only collect listings published after this point. Accepts a relative duration (e.g. "24h", "7d", "2w") or an absolute date ("YYYY-MM-DD HH:MM").
params.fetch_since_timezone
string
Timezone for interpreting an absolute fetch_since date (e.g. "Europe/Paris"). Only applies when fetch_since is an absolute date — ignored for relative values like "24h" or "7d".
Set fetch_since to null to collect all listings, or use a relative duration ("24h", "7d", "2w") or absolute date ("YYYY-MM-DD HH:MM") to collect only recent listings. When using an absolute date, set fetch_since_timezone to interpret it in the correct timezone (e.g. "Europe/Paris").

Optional Functions

Functions are optional add-ons that enable extra data extraction. Each incurs additional credits per row.
params.get_annonce_details
boolean
Fetch additional details by visiting each listing’s detail page: full description, features, seller info, and phone number. Default: false. Extra cost: 4 credits per listing.

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": "ParuVendu BMW Listings",
    "params": {
      "max_results": 100,
      "max_pages": 10,
      "fetch_since": "7d",
      "fetch_since_timezone": null,
      "get_annonce_details": false
    }
  }'

Response

201
{
  "id": "YOUR_SQUID_HASH",
  "name": "ParuVendu BMW Listings",
  "crawler": {
    "id": "6a564030e814e6de4931637f7fb0c06e",
    "name": "ParuVendu Listings Scraper",
    "slug": "paruvendu-listings-scraper"
  },
  "params": {
    "max_results": 100,
    "max_pages": 10,
    "fetch_since": "7d",
    "fetch_since_timezone": null,
    "get_annonce_details": false
  },
  "concurrency": 1,
  "export_unique_results": true,
  "to_complete": true,
  "no_line_breaks": false,
  "status": "idle",
  "created_at": "2025-01-20T10:15:00.000000",
  "updated_at": "2025-01-27T14:35:00.000000"
}