Download Run
Get a temporary download URL for run results
https://api.lobstr.io/v1/runs/{run_hash}/downloadThis endpoint generates a temporary download URL for the results of a specific run. The URL provides direct access to the exported data file.
Headers
AuthorizationstringheaderrequiredYour API authentication token. Value: Token YOUR_API_KEY
Path Parameters
run_hashstringpathrequiredThe unique identifier (hash) of the run to download. Example: 300e9c5c127d421c90f431478d9a2cfb
Query Parameters
file_formatstringqueryExport file format. One of csv, xlsx, json, jsonl. Defaults to csv — omit this parameter to get CSV.
fieldsstringqueryComma-separated list of result columns to include, e.g. fields=name,url,email. Omit to include all columns.
omitstringqueryComma-separated list of result columns to exclude, e.g. omit=raw_html. Ignored if fields is also set.
Response Field Explanations
s3stringTemporary signed URL to download the results file, in the requested file_format. Example: "https://s3.eu-west-1.amazonaws.com/api.lobstr.io/temporary/..."
Download URLs are temporary: they work for 7 days at most, and never past the run's expires_at. Generate a new URL if the link expires.
Results are kept as long as your plan says: Free 7 days, paid plans 45, plans of 1,000,000 credits a month or more 90. Each run's expires_at (Get Run, List Runs) gives the date. From that date this endpoint answers 400 with DataRetentionPeriodExceeded, and a message with the date: Your plan keeps results 45 days: this run's expired on 22 Mar 2025. Upgrading opens older runs again, within 90 days of their export.
The run must have export_done: true before a download URL can be generated.
For automated workflows, consider using delivery configurations (Email, S3, SFTP, Webhook) instead of manual downloads.
Results are exported in CSV format by default. Pass file_format to get XLSX, JSON, or JSONL (newline-delimited JSON) instead.
Code Examples
curl -X GET "https://api.lobstr.io/v1/runs/300e9c5c127d421c90f431478d9a2cfb/download" \ -H "Authorization: Token YOUR_API_KEY"
Response
{ "s3": "https://s3.eu-west-1.amazonaws.com/api.lobstr.io/temporary/lobstrc106a44a98044ef18acc59986ae10967/eebce7802e7740979a0b8450de10c99e.csv?response-content-disposition=attachment%3B%20filename%3Dmy-cool-squid_20250305_0927.csv&AWSAccessKeyId=AKIA3X7XNQGAHJ4R5SEQ&Signature=9CB7fDmysbdySN9a%2F7b9DDa6zhg%3D&Expires=1741771664" }
{ "error": { "message": "Run not found or export not ready", "type": "not_found_error", "param": "run_hash" } }
{ "errors": { "message": "Your plan keeps results 45 days: this run's expired on 22 Mar 2025.", "type": "DataRetentionPeriodExceeded", "code": 400 } }