Interface to the Global Biodiversity Information Facility API
Overview
A programmatic interface to the Web Service methods provided by the Global Biodiversity Information Facility (GBIF; https://www.gbif.org/developer/summary). GBIF is a database of species occurrence records from sources all over the globe. rgbif includes functions for searching for taxonomic names, retrieving information on data providers, getting species occurrence records, getting counts of occurrence records, and using the GBIF tile map service to make rasters summarizing huge amounts of data.
BREAKING CHANGES
**Default taxonomy changed from GBIF Backbone to COL (Catalogue of Life) Extended Release** (#895)
The following functions now use COL Extended Release (checklistKey = "7ddf754f-d193-4cc9-b351-99906754a03b") as the default taxonomy:
name_backbone()- Returns COL XR alpha-numeric taxon keys (e.g., "Q2M4") instead of numeric GBIF Backbone keysname_backbone_checklist()- Matches names against COL XR by defaultocc_search()- Searches using COL XR taxonomyocc_download()- Creates downloads with COL XR taxonomyocc_download_prep()- Prepares downloads with COL XR taxonomymap_fetch()- Fetches maps using COL XR taxonomymvt_fetch()- Fetches map vector tiles using COL XR taxonomy
DEPRECATED
Show all changes in 3.9.0Hide the rest of the changes in 3.9.0
The following functions are deprecated because they use the GBIF Backbone taxonomy, and will not work with COL XR keys.
name_lookup()- usercol::col_search()insteadname_suggest()- usercol::col_suggest()insteadname_usage()- usercol::col_usage()insteadname_issues()- usercol::col_usage()to parse and examine name issues
Additionally:
elevation()- deprecated because it relies on a non-GBIF web service (GeoNames) and will be removed in a future version (#473)
NEW FEATURE
New functions for improved API coverage:
gbif_to_col()- Convert GBIF Backbone numeric taxon keys to COL Extended Release alpha-numeric keys. Returns the full API response including usage details, classification hierarchy, and match diagnostics.occ_term()- Get occurrence term definitions from GBIF API (#857)occ_download_countries()- Get country breakdown for occurrence downloads (#876)occ_download_user_count()- Count downloads by user with optional status and date filtering (#875)occ_download_organizations()- Get organization breakdown for occurrence downloads (#877)
MINOR IMPROVEMENTS
occ_search()now returnsclassificationsas a named list of tibbles, with one tibble per checklistKey (taxonomy source). Each tibble contains one row per occurrence with taxonomic ranks pivoted into camelCase columns (checklistKey, kingdomName, kingdomKey, phylumName, phylumKey, className, classKey, etc.). This structure makes it easy to work with occurrences from different taxonomies separately while keeping the checklistKey information with the data. Known checklists (COL, backbone) are shown with friendly names, while unknown checklists use their UUID.occ_search()now detects numeric taxonomic keys (taxonKey, speciesKey, kingdomKey, etc.) and automatically switches to the GBIF Backbone taxonomy checklistKey with a warning message. These numeric keys are legacy identifiers from the GBIF Backbone taxonomy. Users are advised to migrate to COL XR identifiers usinggbif_to_col().occ_download()andocc_download_prep()now detect numeric taxonomic keys in predicates and automatically inject the GBIF Backbone checklistKey at the predicate level with a warning message. This ensures existing code using numeric keys continues to work correctly.occ_download()andocc_download_prep()now supportchecklistKeyparameter at both the root level (as a top-level argument) and within predicates usingpred(). This allows users to specify which taxonomy source to use for occurrence downloads (#841).name_usage()now warns whendatasetKeyparameter is ignored. When akeyis provided, the GBIF API ignores thedatasetKeyparameter and returns data based solely on the key. A warning is now issued to alert users of this behavior (#899).
API COVERAGE IMPROVEMENTS
Added missing parameters to improve GBIF API coverage:
dataset_search(),dataset_export(), anddataset_suggest()- Addedcategoryparameter (#845)dataset_search()- Addedcontinent,taxonKey,recordCount,modifiedDate,createdDate,contactUserId,contactEmailparameters (#859)dataset_export()- Added missing parameters for complete API coverage (#862)dataset_suggest()- Added missing parameters (#870)occ_search()andocc_count()- Added nucleotide sequence filtering parameters:isSequenced,isInCluster,hasSequenceLink,sequenceLength,gcContent,targetGene(#851)institution_search()- Added missing filter parameters (#882)collection_search()- Added missing API filters (#884)collection_export()- Added missing parameters and fixed dataset_export CI test stability (#889)institution_export()- Added missing parameters (#891)organizations()- Added missing API parameters:isEndorsed,networkKey,machineTagNamespace,machineTagName,machineTagValue,identifierType,identifier,modified,created(#894)
BUG FIXES
- Fixed ORCID and ROR syntax in DESCRIPTION file (#897)
- Replaced deleted taxon key (3119195) with valid key (5231190) in test fixtures (#843)
From NEWS.md in the release
Install
Health
- OK13 OK2026-10-15
- NOTE11 OK, 2 NOTE2026-07-16
- OK13 OK2026-06-09
- ERROR12 OK, 1 ERROR2026-06-08
- OK14 OK2026-03-10
Documentation
- Help pages
- 108 (28 internal)includes a package overview page
- Examples that run
- 4%3 run in a plain check · 72 never run · 2 hold no code
- Exported functions with examples
- 93%
- Documented parameters
- 88%
- Return-value docs
- 70%
- Help pages citing references
- 28%
Downloads
Repository
- PRs merged (all time)
- 92%
- Median days to close, 50 most recently updated closed issues
- 2
- Median days to close, 50 most recently updated closed PRs
- 0
Stars over time
Forks over time
Releases over time
Issues over time
PRs over time
Commits over time
14 development-tooling and community-health practices detected across 8 families in the upstream repository
Checks run against github.com/ropensci/rgbif on 2026-10-21.
The R CMD check workflow runs on Linux, macOS and Windows
GitHub Pages site last deployed 2019-10-15
Show all practicesHide 4 practices
This repository shows signs of AI coding tools.
- GitHub Copilotfirst seen 2025-12-11Pull request: opened by its own accountCommits: 16 by its own account · at least 16 crediting it in the message
- Copilot code reviewCommits: at least 1 accepting its review suggestions
Dependencies
Installing rgbif adds 42 packages (24 with compiled code, 38 MB of source tarballs). Heaviest: stringi 11 MB, ggplot2 6.0 MB, data.table 5.7 MB.
Show all 28 packagesHide all 28 packages
Code & Tests
People & History
Previously maintained by Scott Chamberlain (0.0.1 to 3.6.0).
Pick two releases to compare their code metrics.
- 3.9.0Latest2026-10-05 · current release · diff ↗ ·
added 5 exports
gbif_to_col, occ_download_countries, occ_download_organizations, occ_download_user_count, occ_term - RR 4.6.0 released · 2026-04-24
- 3.8.52026-03-20 · diff ↗ ·
added 6 exports
occ_download_stats, occ_download_stats_dataset, occ_download_stats_dataset_records, occ_download_stats_export, occ_download_stats_source, occ_download_stats_user_country - 3.8.42025-11-13 · diff ↗
- 3.8.32025-09-04 · diff ↗ ·
added 13 exports
collection_export, collection_search, installation_comment, installation_contact, installation_dataset, installation_endpoint, installation_identifier, installation_machinetag, installation_search, installation_tag, institution_export, institution_search, lit_export - 3.8.2
- RR 4.5.0 released · 2025-04-11
- 3.8.12024-09-27 · diff ↗ ·
added 3 exports
occ_download_sql, occ_download_sql_prep, occ_download_sql_validate - 3.8.0
- RR 4.4.0 released · 2024-04-24
- 3.7.92024-01-11 · diff ↗ ·
added 15 exports
dataset, dataset_comment, dataset_constituents, dataset_contact, dataset_doi, dataset_duplicate, dataset_endpoint, dataset_export, dataset_get, dataset_identifier, dataset_machinetag, dataset_networks, dataset_noendpoint, dataset_process, dataset_tag - 3.7.8
- RR 4.3.0 released · 2023-04-21
- 3.7.72023-04-03 · diff ↗
- 3.7.62023-03-23 · diff ↗ ·
added 6 exports
lit_count, lit_search, occ_count_basis_of_record, occ_count_country, occ_count_pub_country, occ_count_year - 3.7.52023-01-05 · diff ↗
Show 64 earlier eventsHide 64 earlier events
- 3.7.42022-12-06 · diff ↗
- 3.7.32022-09-03 · diff ↗ ·
added 5 exports
dataset_gridded, gbif_geocode, name_parse, network, network_constituents - RR 4.2.0 released · 2022-04-22
- 3.7.22022-04-11 · diff ↗
- 3.7.12022-03-16 · diff ↗
- 3.7.02022-02-08 · diff ↗ ·
added 4 exports
derived_dataset, derived_dataset_prep, name_backbone_checklist, pred_isnull - 3.6.02021-06-02 · diff ↗
- RR 4.1.0 released · 2021-05-18
- 3.5.22021-01-27 · diff ↗
- 3.5.02021-01-13 · diff ↗
- 3.4.22021-01-06 · diff ↗
- 3.4.02020-12-03 · diff ↗
- 3.3.02020-09-08 · diff ↗
- 3.2.02020-07-23 · diff ↗
- 3.1.02020-06-30 · diff ↗
- RR 4.0.0 released · 2020-04-24
- RR 3.6.0 released · 2019-04-26
- RR 3.5.0 released · 2018-04-23
- RR 3.4.0 released · 2017-04-21
- RR 3.3.0 released · 2016-05-03
- RR 3.2.0 released · 2015-04-16
- RR 3.1.0 released · 2014-04-10
- 3.0.32014-02-16 · diff ↗
- 3.0.22013-07-18 · diff ↗ ·
removed 1 export
gbifmapadded 13 exports
blanktheme, colClasses, commas_to_periods, country_codes, gbifdata, gbifmap_dens, gbifmap_list, is.gbifdens, is.gbiflist, occurrencelist_many, parseresults, stylegeojson, togeojson - 3.0.0
- RR 3.0.0 released · 2013-04-03
- 2.15.32013-03-01 · diff ↗
- RR 2.15.0 released · 2012-03-30
- 2.15.02012-03-21 · diff ↗
- 2.32020-05-28 · diff ↗
- 2.2.02020-03-09 · diff ↗
- 2.1.02020-02-13 · diff ↗
- 2.0.02020-01-31 · diff ↗ ·
added 13 exports
occ_download_wait, pred, pred_and, pred_gt, pred_gte, pred_in, pred_like, pred_lt, pred_lte, pred_not, pred_notnull, pred_or, pred_within - 1.4.02019-10-30 · diff ↗ ·
removed 1 export
occ_issues_lookupadded 2 exports
gbif_issues_lookup, mvt_fetch - 1.3.02019-05-08 · diff ↗
- 1.2.02019-02-26 · diff ↗
- 1.1.0
- 1.0.22018-07-06 · diff ↗
- 1.0.02018-07-03 · diff ↗ ·
removed 1 export
gbifmapadded 5 exports
DownReq, GbifQueue, map_fetch, occ_download_prep, occ_download_queue - 0.9.9
- 0.9.8
- 0.9.7
- 0.9.62016-12-06 · diff ↗
- 0.9.5
- 0.9.42016-06-29 · diff ↗
- 0.9.3
- 0.9.22016-02-02 · diff ↗ ·
removed 7 exports
commas_to_periods, datasetparser, gbif_capwords, gbifparser, gbifparser_verbatim, namelkupparser, parseresultsadded 1 export
occ_data - 0.9.02015-11-25 · diff ↗ ·
added 7 exports
gbif_citation, gbif_oai_get_records, gbif_oai_identify, gbif_oai_list_identifiers, gbif_oai_list_metadataformats, gbif_oai_list_records, gbif_oai_list_sets - 0.8.92015-10-07 · diff ↗
- 0.8.82015-07-24 · diff ↗
- 0.8.62015-07-03 · diff ↗ ·
added 8 exports
as.download, occ_download, occ_download_cancel, occ_download_cancel_staged, occ_download_get, occ_download_import, occ_download_list, occ_download_meta - 0.8.42015-06-08 · diff ↗ ·
removed 1 export
ldfastadded 3 exports
enumeration, enumeration_country, read_wkt - 0.8.02015-03-09 · diff ↗
- 0.7.72014-11-07 · diff ↗ ·
removed 25 exports
create_gist, density_spplist, densitylist, gbifdata, gbifmap_dens, gbifmap_list, gbifxmlToDataFrame, get_credentials, gist, is.gbifdens, is.gbiflist, is.gbiflist_na, occurrencecount, occurrencedensity, occurrenceget, occurrencelist, occurrencelist_all, occurrencelist_many, providers, resources, stylegeojson, taxoncount, taxonget, taxonsearch, togeojsonadded 5 exports
%>%, gbif_issues, gbif_names, occ_issues, occ_issues_lookup - 0.7.0
- 0.6.22014-04-24 · diff ↗
- 0.6.0
- 0.5.02014-02-16 · diff ↗ ·
removed 1 export
country_codesadded 4 exports
count_facet, elevation, installations, rgb_country_codes - 0.4.02013-11-20 · diff ↗ ·
removed 2 exports
capwords, colClassesadded 28 exports
create_gist, dataset_metrics, dataset_search, dataset_suggest, datasetparser, datasets, gbif_capwords, gbifmap, gbifparser, gbifparser_verbatim, get_credentials, gist, is.gbiflist_na, ldfast, name_backbone, name_lookup, name_suggest, name_usage, namelkupparser, nodes, occ_count, occ_get, occ_metadata, occ_search, occurrencelist_all, organizations, parsenames, suggestfields - 0.3.02013-07-19 · diff ↗
- 0.2.0
- 0.1.52012-12-04 · diff ↗ ·
removed 1 export
gbifdatauseadded 6 exports
capwords, density_spplist, densitylist, gbifmap, occurrencecount, taxonget - 0.0.12012-03-21
- RR 2.14.0 released · 2011-10-31
Package metadata
- First published
- 2012-03-21
- Total releases
- 64 / 14 yrs
- License
- MIT + file LICENSE OSI · relicensed from CC0 in 0.7.0
- Download size
- 5.0 MB
Cite
Cite this package
Run in R for the authors' preferred citation:
citation("rgbif")The package provides a citation file that builds its entry when R runs it. Run citation() to see it.
Cite the R Observatory
For a number measured here: a download total, a coverage figure, an archival date.
From data release v2026-10-25, which the citation names so these numbers can be found later. More on citing and the projects behind them.