gbif_occurrence_download_request
Request asynchronous downloads for large GBIF occurrence datasets exceeding pagination limits (100,000+ records). Returns a download key to check status; requires authentication.
Instructions
Request an asynchronous download for large occurrence datasets beyond pagination limits (100,000+ records). Returns a download key for checking status. REQUIRES AUTHENTICATION: Set GBIF_USERNAME and GBIF_PASSWORD environment variables.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| format | No | Download format. DWCA (Darwin Core Archive) = Full format with metadata and extensions, most comprehensive. SIMPLE_CSV = Simplified CSV format, easier to work with in spreadsheets. SPECIES_LIST = List of unique species only, no occurrence records. Default: SIMPLE_CSV. | SIMPLE_CSV |
| creator | Yes | GBIF username (creator of the download). This is your GBIF.org username. Example: "john.smith". Required for download attribution and access control. | |
| predicate | No | Download predicate defining filters (REQUIRED). Complex JSON structure specifying which records to include. Use gbif_occurrence_download_predicate_builder tool to construct this from simple search parameters, or build manually following GBIF download API predicate format. Example: {type: "equals", key: "TAXON_KEY", value: "212"} for all bird records. | |
| sendNotification | No | Send email notification on completion. Set to true (default) to receive email when download is ready, false to skip notifications. Recommended: true for downloads that take more than a few minutes. | |
| notificationAddresses | No | Email addresses to notify when download completes. Receives notification with download link when processing is finished. Example: ["user@example.com"]. Optional, but highly recommended for large downloads that may take hours to process. |