GET/v1/squids

List Squids

Retrieve a paginated list of all your squids with filtering and search capabilities

This endpoint returns a paginated list of all squids belonging to the authenticated user. You can search by name and control pagination with query parameters.

Headers

Key	Value	Required
Authorization	Token YOUR_API_KEY	Yes

Response Structure

total_results

integer

Total number of squids matching the query

Example: 15

limit

integer

Number of results per page

Example: 50

page

integer

Current page number

Example: 1

total_pages

integer

Total number of pages available

Example: 1

result_from

integer

Starting index of results in current page

Example: 1

result_to

integer

Ending index of results in current page

Example: 15

data

array

Array of squid objects with comprehensive details

stringnull

Full URL to the next page (null if on last page)

Example: null

stringnull

Full URL to the previous page (null if on first page)

Example: null

Squid Object Fields

data[].id

string

Unique squid identifier

Example: c106a44a98044ef18acc59986ae10967

data[].name

string

Display name of the squid

Example: Google Maps (1)

data[].created_at

string

Timestamp when the squid was created

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

data[].is_active

boolean

Whether the squid is active and can run

Example: true

data[].is_ready

boolean

Whether the squid has tasks and is ready to run

Example: true

data[].crawler

string

Unique identifier of the associated crawler

Example: 4734d096159ef05210e0e1677e8be823

data[].crawler_name

string

Display name of the crawler

Example: Google Maps Search Export

data[].icon

string

URL to the crawler's icon image

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

data[].is_public

boolean

Whether the crawler is publicly available

Example: true

data[].concurrency

integer

Number of concurrent tasks the squid runs

Example: 2

data[].params

object

Crawler-specific parameter configuration object

Example: {language: en}

data[].to_complete

boolean

Whether to stop after completing all tasks

Example: false

data[].export_unique_results

boolean

Whether to export only unique results

Example: true

data[].no_line_breaks

boolean

Whether to remove line breaks from exported data

Example: false

data[].last_run_status

string

Status of the most recent run (completed, running, error, etc.)

Example: DONE

data[].last_run_at

string

Timestamp of the most recent run

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

data[].total_runs

integer

Total number of times the squid has been executed

Example: 5

data[].next_launch_at

stringnull

Scheduled time for the next automated run (null if not scheduled)

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

data[].google_sheet_fields

objectnull

Google Sheets integration configuration (null if not configured)

Example: null

data[].ftp_fields

objectnull

FTP integration configuration (null if not configured)

Example: null

data[].s3_fields

objectnull

AWS S3 integration configuration (null if not configured)

Example: null

data[].webhook_fields

objectnull

Webhook integration configuration (null if not configured)

Example: null

data[].schedule

stringnull

Cron expression for scheduled runs (null if not scheduled)

Example: 0 10 * * *

data[].schedule_time

string

Human-readable schedule description

Example: Daily at 10:00 AM

data[].download_url

stringnull

Temporary signed URL to download results (null if no results available)

Example: https://storage.lobstr.io/downloads/xyz123...

Parameters

namestring

Optional

Filter squids by name (case-insensitive partial match)

Example: Google

limitinteger

Optional

Number of results per page

Example: 10

pageinteger

Optional

Page number for pagination

Example: 2

Pro Tip

Use the 'name' query parameter to quickly find squids. It performs a case-insensitive partial match on squid names.

Note

The 'next' and 'previous' fields contain full URLs for easy pagination. Use them directly to navigate through pages.

Pro Tip

Check 'last_run_status' to see if a squid has completed, is running, or encountered errors. Useful for monitoring multiple squids.

Warning

Squids with 'is_ready: false' haven't been configured with tasks yet. Add tasks before starting a run.

Pro Tip

The 'download_url' field provides a temporary signed URL to download results. URLs expire after a certain time period.