Skip to main content
POST
/
v1
/
squids
/
{id}
/
chain
Configure Squid Chain
curl --request POST \
  --url https://api.lobstr.io/v1/squids/{id}/chain \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "target_module_id": "<string>",
  "field_map": {},
  "autostart": true,
  "cluster_name": "<string>",
  "cluster_concurrency": 123
}
'
{
  "id": "<string>",
  "target_module": {
    "id": "<string>",
    "public_name": "<string>",
    "max_concurrency": 123
  },
  "target_cluster": {},
  "field_map": {},
  "is_active": true,
  "autostart": true,
  "cluster_name": {},
  "cluster_concurrency": {},
  "created_at": "<string>"
}

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.

Crawler chaining lets you connect two squids so that when a run on the source squid completes, its results are automatically extracted and queued as tasks on a target squid, triggering a new run downstream. Example use case: Run a Google Maps Leads scrape to collect place URLs, then automatically pass those URLs into a Google Maps Reviews scrape — without any manual intervention.
Chains are limited to a maximum depth of 3 squids. A squid can only have one outgoing chain at a time.

​
How it works

  1. You configure a chain on a source squid, specifying the target crawler and a field_map
  2. When a run on the source squid completes with a status of DONE, the scheduler extracts the mapped fields from its results
  3. Those values are queued as tasks on the target squid (auto-created on first trigger if it doesn’t exist yet)
  4. If autostart is true, a new run starts immediately on the target squid
The chain is only triggered when the source run reaches a status of DONE. Runs that end with ERROR or any other status will not trigger the downstream chain.

​
Path Parameters

​
id
string
required
Hash ID of the source squid. Example: "e86b29c032024b66aff529e1d43c2bd7"

​
Headers

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

​
Request Body

​
target_module_id
string
required
Hash ID of the target crawler. Use GET /v1/crawlers to find it. Example: "9a3f1c8b2e7d4a56f0e1b2c3d4e5f678"
​
field_map
object
required
Maps a result field from the source crawler to an input parameter on the target crawler. Example: {"url": "url"} — passes the url field from source results as the url input on the target.
​
autostart
boolean
If true, the downstream run starts automatically when tasks are queued. If false, tasks are queued and the run is created as paused for manual review. Defaults to true.
​
cluster_name
string
Custom name for the auto-created target squid. If omitted, defaults to "{Crawler Name} (N) (chained)".
​
cluster_concurrency
integer
Concurrency to apply to the auto-created target squid. Defaults to 1.

​
Response Fields

​
id
string
Unique chain config identifier.
​
target_module
object
Details of the target crawler.
​
target_cluster
object | null
The auto-created target squid. null until the first chain trigger fires.
​
field_map
object
The configured field mapping.
​
is_active
boolean
Whether the chain is currently active.
​
autostart
boolean
Whether downstream runs start automatically.
​
cluster_name
string | null
Configured name for the target squid.
​
cluster_concurrency
integer | null
Configured concurrency for the target squid.
​
created_at
string
ISO 8601 timestamp of when the chain was configured.

​
Code Examples

curl -X POST "https://api.lobstr.io/v1/squids/e86b29c032024b66aff529e1d43c2bd7/chain" \
  -H "Authorization: Token YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "target_module_id": "9a3f1c8b2e7d4a56f0e1b2c3d4e5f678",
    "field_map": {"url": "url"},
    "autostart": true,
    "cluster_name": "Reviews (chained)",
    "cluster_concurrency": 3
  }'

​
Response

201
{
  "id": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4",
  "target_module": {
    "id": "9a3f1c8b2e7d4a56f0e1b2c3d4e5f678",
    "public_name": "Google Maps Reviews Scraper",
    "name": "googlemapreviews_matrix",
    "max_concurrency": 10
  },
  "target_cluster": null,
  "field_map": {"url": "url"},
  "is_active": true,
  "autostart": true,
  "cluster_name": "Reviews (chained)",
  "cluster_concurrency": 3,
  "created_at": "2026-04-28T10:00:00Z"
}
400
{
  "error": "field_map is required and must be a dict."
}
409
{
  "error": "This squid already has a chain configured."
}
422
{
  "error": "Chain depth limit of 3 reached."
}