GET/v1/runs/{run_hash}

Get Run

Retrieve detailed information about a specific run

This endpoint retrieves detailed information about a specific run using its hash ID. A run represents an execution instance of a squid's tasks, tracking progress, status, and results.

Headers

KeyValueRequired
AuthorizationToken YOUR_API_KEYYes

Response Field Explanations

id
string
Unique identifier of the squid run
Example: 0393be3ea6f74986906153df1c3f9894
object
string
Type of returned object (always "run")
Example: run
created_at
string
Date and time when the run was initially created (ISO 8601)
Example: 2025-02-04T10:26:50.847633
started_at
string
Date and time when the scraping run started executing
Example: 2025-02-04T10:25:41.623683
ended_at
stringnull
Date and time when the scraping run completed or stopped
Example: 2025-02-04T10:26:52.222239
duration
float
Duration of the scraping run in seconds
Example: 50.1833
credit_used
float
Total credits consumed during the run
Example: 50.1833
origin
string
Origin of the run initiation (e.g., "user", "schedule")
Example: user
status
string
Current status of the squid run (see statuses table)
Example: done
total_results
integer
Total number of results collected
Example: 40
total_unique_results
integer
Number of unique results collected
Example: 40
export_done
boolean
Indicates if the export was successfully generated
Example: true
export_time
stringnull
Date and time when export was generated
Example: 2025-02-04T10:26:53.780636
done_reason
stringnull
Reason indicating why the run finished (see done reasons table)
Example: tasks_done
done_reason_desc
stringnull
Additional description providing context for done_reason
Example: null
squid
string
Identifier of the squid this run belongs to
Example: e445405ef4ab41208ef7d29b92a1a9dd
crawler_id
string
Identifier of the specific crawler used
Example: 4734d096159ef05210e0e1677e8be823
next_launch_at
stringnull
Scheduled date/time for the next execution (if recurring)
Example: null
shared
boolean
Indicates if the run result is shared publicly
Example: false

Run Statuses

PENDING
Phase:
Waiting
Description:
Run is created and waiting to start execution
RUNNING
Phase:
In Progress
Description:
Run is currently collecting data
UPLOADING
Phase:
In Progress
Description:
Data collection is complete, now uploading/exporting results
PAUSED
Phase:
In Progress
Description:
Run has been temporarily paused; it can resume or be aborted
ABORTED
Phase:
Completed
Description:
Run was manually stopped before completion
DONE
Phase:
Completed
Description:
Run finished all tasks and exported the results successfully
ERROR
Phase:
Completed
Description:
Run failed due to an error

Done Reasons

tasks_done
Description:
All assigned tasks completed successfully
aborted
Description:
Scraping run manually aborted by user
no_credits_left
Description:
No credits remaining
no_account_available
Description:
No available accounts; refresh required
no_accounts
Description:
No scraper-linked accounts available to initiate run
cookies_expired
Description:
Scraper-linked account cookies expired; renewal required
wrong_credentials
Description:
Account credentials invalid
checkpoint_reached
Description:
Account is blocked at a checkpoint (manual verification required)
otp_needed
Description:
OTP verification required; please re-sync accounts
limit_exceeded
Description:
Scraper-linked account limit exceeded
slots_limit_exceeded
Description:
Scraping slots limit exceeded
too_many_requests
Description:
Run stopped due to excessive requests
batch_wait
Description:
Current batch completed; awaiting timeout
deactivated
Description:
Run has been deactivated
maintenance_fees_not_paid
Description:
Maintenance fees for this custom module have not been paid
last_invoice_not_paid
Description:
Previous invoice payment pending
export_fix
Description:
Export regenerated successfully after previous failure

Parameters

run_hashstring
Required
The unique identifier (hash) of the run
Example: 0393be3ea6f74986906153df1c3f9894
Pro Tip

Pro Tip

Use the status field to track run progress. Poll this endpoint periodically for long-running scrapes.
Note

Note

The done_reason field provides insight into why a run ended - useful for debugging failed runs.
Warning

Warning

Runs with status 'error' or unexpected done_reasons may indicate account issues that need attention.