download_bundle
Create one ZIP archive of public FERC eLibrary files from accession numbers, file IDs, or a docket number, replacing repeated individual downloads with a single bundle request.
Instructions
Zip many public files into one archive under FERC_DOWNLOAD_DIR/bundles.
Prefer this over repeated download_file calls. eLibrary's Zip & Download accepts many file IDs in a single request (including across accessions), so one call replaces N metadata lookups + N downloads + N rate-limit waits.
Provide any combination of accession_numbers (all public files on each),
file_ids (exact attachments), and/or docket (public files found via search
on that docket). Default organize_by_accession=true rewrites FERC's flat
accession_filename members into accession/filename folders.
Caps: 100 files and 500 MB by default (FERC_MAX_BUNDLE_FILES / FERC_MAX_BUNDLE_BYTES). Privileged, protected, and CEII accessions — and accessions absent from public search — are skipped and listed in skipped_accessions with a reason and category (restricted vs not_found). Does not return file bytes.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| docket | No | ||
| file_ids | No | ||
| accession_numbers | No | ||
| organize_by_accession | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||