GET/v1/squids/{squid_hash}

Get Squid Details

Retrieve comprehensive details about a specific squid including configuration, status, and integrations

This endpoint retrieves comprehensive details about a specific squid, including its configuration settings, operational status, integration options, run statistics, and associated crawler information.

Core Information Fields

string

Unique identifier for the squid

Example: c106a44a98044ef18acc59986ae10967

name

string

Display name of the squid

Example: Google Maps (1)

created_at

string

Timestamp when the squid was created

Example: 2024-01-15T10:30:00Z

is_active

boolean

Whether the squid is active and can run

Example: true

is_ready

boolean

Whether the squid has tasks and is ready to run

Example: true

crawler

string

Unique identifier of the associated crawler

Example: 4734d096159ef05210e0e1677e8be823

crawler_name

string

Display name of the crawler

Example: Google Maps Search Export

icon

string

URL to the crawler's icon image

Example: https://cdn.lobstr.io/icons/google-maps.png

concurrency

integer

Number of concurrent tasks the squid runs

Example: 2

params

object

Crawler-specific parameter configuration object

Example: {}

to_complete

boolean

Whether to stop after completing all tasks

Example: false

message

string

Important operational information or error messages

Example: ""

Run Status & History Fields

last_run_status

string

Current status of the most recent run (DONE, RUNNING, ERROR, etc.)

Example: DONE

last_run

string

ID of the most recent run

Example: abc123

last_run_at

string

Timestamp of the last execution

Example: 2024-01-20T15:45:00Z

last_run_done_reason

string

Why the run ended (tasks_done, credits_exhausted, user_stopped, error)

Example: tasks_done

total_runs

integer

Total number of runs executed for this squid

Example: 5

next_launch_at

stringnull

Scheduled time for next run (null if not scheduled)

Example: 2024-01-21T10:00:00Z

Export & Download Fields

download_url

stringnull

Temporary signed URL to download latest results (expires after a time period)

Example: null

export_runs

boolean

Whether to export runs

Example: true

export_unique_results

boolean

Only export unique results, removing duplicates

Example: true

no_line_breaks

boolean

Remove newlines from exported data

Example: false

Integration Configuration Fields

google_sheet_fields

objectnull

Google Sheets integration configuration (null if not configured). Contains is_active flag.

Example: null

ftp_fields

objectnull

SFTP delivery settings (null if not configured). Contains is_active flag.

Example: null

s3_fields

objectnull

Amazon S3 export configuration (null if not configured). Contains is_active flag.

Example: null

webhook_fields

objectnull

Webhook notifications setup (null if not configured). Contains is_active flag.

Example: null

slack_fields

objectnull

Slack integration settings (null if not configured). Contains is_active flag.

Example: null

Scheduling Fields

schedule

objectnull

Cron schedule object with expression and timezone (null if not scheduled)

Example: null

schedule_time

string

Next scheduled execution time in human-readable format

Example: Daily at 10:00 AM

Notification Fields

string

Email address for notifications

Example: user@example.com

notifications

boolean

Whether notifications are enabled

Example: true

notifications_params

object

Notification configuration object containing run_notify setting (on_success, on_error, or null)

Example: {run_notify: on_success}

Headers

Key	Value	Required
Authorization	Token YOUR_API_KEY	Yes

Parameters

squid_hashstring

Required

The unique identifier (hash) of the squid

Example: c106a44a98044ef18acc59986ae10967

Pro Tip

Check 'is_ready' before starting a run. If false, you need to add tasks to the squid first.

Note

The 'message' field contains important operational information or error messages. Check this if a squid isn't behaving as expected.

Warning

The 'download_url' is a temporary signed URL that expires. Download results promptly or generate a new URL by re-fetching squid details.

Pro Tip

Use 'last_run_done_reason' to understand why a run stopped. Common reasons: tasks_done, credits_exhausted, user_stopped, error.

Pro Tip

Integration fields (google_sheet_fields, etc.) show 'is_active: true' if enabled. Configure these to automate result delivery.