literature module

literature module API:

  • search

Example usage:

from pygbif import literature as lit
lit.search(q='climate change', limit=5)

literature API

literature.search(countriesOfCoverage=None, countriesOfResearcher=None, doi=None, gbifDatasetKey=None, gbifDownloadKey=None, gbifHigherTaxonKey=None, gbifNetworkKey=None, gbifOccurrenceKey=None, gbifProjectIdentifier=None, gbifProgrammeAcronym=None, gbifTaxonKey=None, literatureType=None, openAccess=None, peerReview=None, publisher=None, publishingOrganizationKey=None, relevance=None, source=None, topics=None, websites=None, year=None, language=None, added=None, published=None, discovered=None, modified=None, hl=None, limit=100, offset=0, facet=None, facetMincount=None, facetMultiselect=None, facetLimit=None, facetOffset=None, q=None, **kwargs)

Search for literature indexed by GBIF

Parameters:

  • citationType – [str] The manner in which GBIF is cited in a paper.

  • countriesOfCoverage – [str], Countries of coverage

  • countriesOfResearcher – [str] Country or area of institution with which author is affiliated.

  • doi – [str] Digital Object Identifier (DOI) of the literature item.

  • gbifDatasetKey – [str] GBIF dataset key uuid referenced in publication.

  • gbifDownloadKey – [str] GBIF download referenced in publication.

  • gbifHigherTaxonKey – [str] All parent keys of any taxon that is the focus of the paper.

  • gbifNetworkKey – [str] GBIF network referenced in publication.

  • gbifOccurrenceKey – [str] Any GBIF occurrence keys directly mentioned in a paper.

  • gbifProjectIdentifier – [str] GBIF dataset referenced in publication.

  • gbifProgrammeAcronym – [str] GBIF dataset referenced in publication.

  • gbifTaxonKey – [str] Key(s) from the GBIF backbone of taxa that are the focus of a paper.

  • literatureType – [str] Type of literature, e.g. journal article.

  • openAccess – [bool] Is the publication Open Access?

  • peerReview – [bool] Has the publication undergone peer review?

  • publisher – [str] Publisher of journal.

  • publishingOrganizationKey – [str] Publisher whose dataset is referenced in publication.

  • relevance – [str] Relevance to GBIF community.

  • source – [str] Journal of publication.

  • topics – [str] Topic of publication.

  • websites – [str] Website of publication.

  • year – [str] Year of publication. This can be a single range such as “2019,2021”.

  • language – [str] 3 letter language code of publication. e.g. “eng”

  • added – [str] Date or date range when the publication was added. Format is ISO 8601, e.g., ‘2024-07-14’ or ‘2024-07-14,2024-08-14’.

  • published – [str] Date or date range when the publication was published. Format is ISO 8601, e.g., ‘2024-02-22’ or ‘2024-02-22,2024-03-22’.

  • discovered – [str] Date or date range when the publication was discovered. Format is ISO 8601, e.g., ‘2024-02-26’ or ‘2024-02-26,2024-03-26’.

  • modified – [str] Date or date range when the publication was discovered. Format is ISO 8601, e.g., ‘2024-07-26’ or ‘2024-07-26,2024-10-26’.

  • hl – [str] Set hl=true to highlight terms matching the query when in fulltext search fields.

  • limit – [int] Controls the number of results in the page.

  • offset – [int] Determines the offset for the search results.

  • facet – [str] A facet name used to retrieve the most frequent values for a field.

  • facetMincount – [int] Used in combination with the facet parameter. Set facetMincount={#} to exclude facets with a count less than {#}.

  • facetMultiselect – [bool] Used in combination with the facet parameter. Set facetMultiselect=true to still return counts for values that are not currently filtered.

  • facetLimit – [int] Limit the number of facet values returned.

  • facetOffset – [int] Facet parameters allow paging requests using the parameters facetOffset and facetLimit.

  • q – [str] Full text query.

Returns:

A dictionary

Usage:

from pygbif import literature as lit
lit.search(limit=10) # basic search for 10 records

# search for a specific download key
lit.search(gbifDownloadKey="0235283-220831081235567") 

# search for a year range
lit.search(year="2010,2024", limit=10)

# search for count only 
lit.search(year="2010,2024", limit=0)["count"]