GBIF provides two ways to get occurrence data: through the
/occurrence/search route (see
or via the
/occurrence/download route (many functions, see below).
occ_search() is more appropriate for smaller data, while
occ_download*() functions are more appropriate for larger data requests.
occ_download() to kick off a download. You'll need to
give that function settings from your GBIF profile: your user name, your
password, and your email. These three settings are required to use the
function. You can specify them in one of three ways:
Pass them to
Use R options: As options either in the current R session using the
options()function, or by setting them in your
.Rprofilefile, after which point they'll be read in automatically
Use environment variables: As env vars either in the current R session using the
Sys.setenv()function, or by setting them in your
.bash_profileor similar files, after which point they'll be read in automatically
You can not perform that many downloads, so plan wisely. See Rate limiting below.
If you try to launch too many downloads, you will receive an 420 "Enhance Your Calm" response. If there is less then 100 in total across all GBIF users, then you can have 3 running at a time. If there are more than that, then each user is limited to 1 only. These numbers are subject to change.
occ_download()- Start a download
occ_download_prep()- Prepare a download request
occ_download_queue()- Start many downloads in a queue
occ_download_cached()- Check for downloads already in your GBIF account
occ_download_meta()- Get metadata progress on a single download
occ_download_list()- List your downloads
occ_download_cancel()- Cancel a download
occ_download_cancel_staged()- Cancels any jobs with status
occ_download_get()- Retrieve a download
occ_download_import()- Import a download from local file system
occ_download_datasets()- List datasets for a download
occ_download_dataset_activity()- Lists the downloads activity of a dataset
Download query composer methods:
GBIF has a limit of 12,000 characters for a download query. This means that you can have a pretty long query, but at some point it may lead to an error on GBIF's side and you'll have to split your query into a few.
The following statuses can be found with any download:
PREPARING: just submitted by user and awaiting processing (typically only a few seconds)
RUNNING: being created (takes typically 1-15 minutes)
FAILED: something unexpected went wrong
KILLED: user decided to abort the job while it was in PREPARING or RUNNING phase
SUCCEEDED: The download was created and the user was informed
FILE_ERASED: The download was deleted according to the retention policy, see https://www.gbif.org/faq?question=for-how-long-will-does-gbif-store-downloads