Skip to main content
GET
/
v1
/
runs
List Runs
curl --request GET \
  --url https://api.lobstr.io/v1/runs \
  --header 'Authorization: <authorization>'
{
  "total_results": 123,
  "limit": 123,
  "page": 123,
  "total_pages": 123,
  "data": [
    {}
  ],
  "data[].id": "<string>",
  "data[].status": "<string>",
  "data[].is_done": true,
  "data[].total_results": 123,
  "data[].duration": 123,
  "data[].credit_used": 123,
  "data[].done_reason": {},
  "next": {},
  "previous": {}
}

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.

This endpoint retrieves a paginated list of all runs for a specific squid. Use this to view run history and track past executions.

​
Headers

​
Authorization
string
required
Your API authentication token. Value: Token YOUR_API_KEY

​
Query Parameters

ParameterTypeRequiredDescription
squidstringYesThe squid hash ID to list runs for
pageintegerNoPage number for pagination. Default: 1
limitintegerNoResults per page. Default: 50, Max: 100

​
Response Field Explanations

​
total_results
integer
Total number of runs. Example: 4
​
limit
integer
Maximum results per page. Example: 50
​
page
integer
Current page number. Example: 1
​
total_pages
integer
Total number of pages. Example: 1
​
data
array
Array of run objects. Example: [...]
​
data[].id
string
Unique run identifier. Example: "381cfbb47e474782857ddc035298b6f3"
​
data[].status
string
Current run status. Example: "done"
​
data[].is_done
boolean
Whether the run has completed. Example: true
​
data[].total_results
integer
Number of results collected. Example: 156
​
data[].duration
float
Run duration in seconds. Example: 3.1849
​
data[].credit_used
float
Credits consumed. Example: 3.1849
​
data[].done_reason
string | null
Reason for completion. Example: "tasks_done"
​
next
string | null
URL for next page (null if last page). Example: null
​
previous
string | null
URL for previous page (null if first page). Example: null
Use this endpoint to monitor all past and current runs for a squid.
Runs are returned in reverse chronological order (newest first).
Check is_done to quickly filter completed vs. active runs.

​
Code Examples

curl -X GET "https://api.lobstr.io/v1/runs?squid=b6c56d18cb0046949461ba9ca278e8ad&page=1&limit=50" \
  -H "Authorization: Token YOUR_API_KEY"

​
Response

200
{
  "total_results": 4,
  "limit": 50,
  "page": 1,
  "total_pages": 1,
  "result_from": 1,
  "result_to": 4,
  "data": [
    {
      "id": "381cfbb47e474782857ddc035298b6f3",
      "object": "run",
      "squid": "b6c56d18cb0046949461ba9ca278e8ad",
      "is_done": true,
      "started_at": "2025-02-04T10:25:13Z",
      "total_results": 156,
      "total_unique_results": 156,
      "next_launch_at": null,
      "ended_at": "2025-02-04T10:25:21Z",
      "duration": 8.0415,
      "credit_used": 8.0415,
      "origin": "user",
      "force_launch": false,
      "status": "done",
      "export_done": true,
      "export_count": 1,
      "export_time": "2025-02-04T10:25:25Z",
      "email_done": null,
      "email_time": null,
      "created_at": "2025-02-04T10:25:13Z",
      "done_reason": "tasks_done",
      "done_reason_desc": null
    },
    {
      "id": "3aa75b3f05c144f6a87f8397e229024e",
      "object": "run",
      "squid": "b6c56d18cb0046949461ba9ca278e8ad",
      "is_done": true,
      "started_at": "2025-01-29T09:53:27Z",
      "total_results": 0,
      "total_unique_results": 0,
      "next_launch_at": null,
      "ended_at": "2025-01-29T09:53:33Z",
      "duration": 0.0466,
      "credit_used": 0.0466,
      "origin": "user",
      "force_launch": false,
      "status": "done",
      "export_done": true,
      "export_count": 1,
      "export_time": "2025-01-29T09:53:37Z",
      "email_done": null,
      "email_time": null,
      "created_at": "2025-01-29T09:53:27Z",
      "done_reason": "tasks_done",
      "done_reason_desc": null
    }
  ],
  "next": null,
  "previous": null
}