Literature API
https://api.gbif.org/v1/
This API enables you to search for literature indexed by GBIF, including peer-reviewed papers, citing GBIF datasets and downloads. It powers the Literature search on GBIF.org.
Literature search
| Resource URL | Method | Response | Description | Paging | Parameters |
|---|---|---|---|---|---|
| /literature/search | GET | LiteratureSearchResult | Full text search across all literature. | true | q, countriesOfResearcher, countriesOfCoverage, literatureType, relevance, year, topics, gbifDatasetKey, publishingOrganizationKey, peerReview, openAccess, gbifDownloadKey, doi, source, publisher |
| /literature/{id} | GET | Literature | Gets details for the single literature. | false |
Query parameters explained
The following parameters are for use exclusively with the Literature API described above.
| Parameter | Description |
|---|---|
| countriesOfCoverage | Country of focus of study, e.g. BR (for Brazil). Country codes are listed in our Country enum. |
| countriesOfResearcher | Country of institution with which author is affiliated, e.g. DK (for Denmark). Country codes are listed in our Country enum. |
| doi | Digital Object Identifier (DOI) |
| facetMincount | Used in combination with the facet parameter. Set facetMincount={#} to exclude facets with a count less than {#}, e.g. /search?facet=type&limit=0&facetMincount=10000 only shows the type value 'OCCURRENCE' because 'CHECKLIST' and 'METADATA' have counts less than 10000. |
| facetMultiselect | Used in combination with the facet parameter. Set facetMultiselect=true to still return counts for values that are not currently filtered, e.g. /search?facet=type&limit=0&type=CHECKLIST&facetMultiselect=true still shows type values 'OCCURRENCE' and 'METADATA' even though type is being filtered by type=CHECKLIST |
| gbifDatasetKey | GBIF dataset referenced in publication |
| gbifDownloadKey | Download referenced in publication |
| hl | Set hl=true to highlight terms matching the query when in fulltext search fields. The highlight will be an emphasis tag of class 'gbifH1' e.g. /search?q=plant&hl=true. Fulltext search fields include: title, keyword, country, publishing country, publishing organization title, hosting organization title, and description. One additional full text field is searched which includes information from metadata documents, but the text of this field is not returned in the response. |
| literatureType | Type of literature, e.g. journal article |
| openAccess | Is publication Open Access? |
| peerReview | Has publication undergone peer-review? |
| publisher | Publisher of journal |
| publishingOrganizationKey | Publisher whose dataset is referenced in publication |
| q | Simple full text search parameter. The value for this parameter can be a simple word or a phrase. Wildcards are not supported |
| relevance | Relevance to GBIF community, see literature relevance. |
| source | Journal of publication |
| topics | Topic of publication |
| year | Year of publication |