Occurrences8
This API provides services related to the retrieval of single occurrence records.
GET/occurrence/termOccurrence terms
Responses| Status | Description | Schema |
|---|
200 | OK | — |
GET/occurrence/{datasetKey}/{occurrenceId}Occurrence by dataset key and occurrence id
Parameters| Name | In | Required | Type |
|---|
datasetKey | path | yes | string |
occurrenceId | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Occurrence found | Occurrence |
400 | Invalid identifier supplied | — |
404 | Occurrence not found | — |
GET/occurrence/{datasetKey}/{occurrenceId}/fragmentOccurrence fragment by dataset key and occurrence id
Parameters| Name | In | Required | Type |
|---|
datasetKey | path | yes | string |
occurrenceId | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Occurrence fragment in JSON or XML format | — |
400 | Invalid identifier supplied | — |
404 | Occurrence not found | — |
GET/occurrence/{datasetKey}/{occurrenceId}/verbatimVerbatim occurrence by dataset key and occurrence id
Parameters| Name | In | Required | Type |
|---|
datasetKey | path | yes | string |
occurrenceId | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Verbatim occurrence found | VerbatimOccurrence |
400 | Invalid identifier supplied | — |
404 | Occurrence not found | — |
GET/occurrence/{gbifId}Occurrence by id
Parameters| Name | In | Required | Type |
|---|
gbifId | path | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | Occurrence found | Occurrence |
400 | Invalid identifier supplied | — |
404 | Occurrence not found | — |
GET/occurrence/{gbifId}/experimental/relatedRelated occurrences by gbifId
Parameters| Name | In | Required | Type |
|---|
gbifId | path | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | Occurrence found, list of related occurrences returned. | — |
400 | Invalid identifier supplied | — |
404 | Occurrence not found | — |
GET/occurrence/{gbifId}/fragmentOccurrence fragment by id
Parameters| Name | In | Required | Type |
|---|
gbifId | path | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | Occurrence fragment in JSON or XML format | — |
400 | Invalid identifier supplied | — |
404 | Occurrence not found | — |
GET/occurrence/{gbifId}/verbatimVerbatim occurrence by id
Parameters| Name | In | Required | Type |
|---|
gbifId | path | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | Verbatim occurrence found | VerbatimOccurrence |
400 | Invalid identifier supplied | — |
404 | Occurrence not found | — |
Searching occurrences19
This API provides services for searching occurrence records that have been indexed by GBIF.
In order to retrieve all results for a given search filter you need to issue individual requests for each page, which is limited to a maximum size of 300 records per page. Note that for technical reasons we also have a hard limit for any query of 100,000 records. You will get an error if the offset + limit exceeds 100,000. To retrieve all records beyond 100,000 you should use our asynchronous download service (below) instead.
GET/occurrence/searchOccurrence search
Parameters| Name | In | Required | Type |
|---|
acceptedTaxonKey | query | no | array |
associatedSequences | query | no | array |
basisOfRecord | query | no | array |
bed | query | no | array |
catalogNumber | query | no | array |
classKey | query | no | array |
checklistKey | query | no | string |
collectionCode | query | no | array |
collectionKey | query | no | array |
continent | query | no | array |
coordinateUncertaintyInMeters | query | no | — |
country | query | no | array |
crawlId | query | no | array |
datasetId | query | no | array |
datasetKey | query | no | array |
datasetName | query | no | array |
day | query | no | array |
decimalLatitude | query | no | — |
degreeOfEstablishment | query | no | array |
decimalLongitude | query | no | — |
depth | query | no | — |
distanceFromCentroidInMeters | query | no | — |
dwcaExtension | query | no | array |
earliestEonOrLowestEonothem | query | no | array |
earliestEraOrLowestErathem | query | no | array |
earliestPeriodOrLowestSystem | query | no | array |
earliestEpochOrLowestSeries | query | no | array |
earliestAgeOrLowestStage | query | no | array |
elevation | query | no | — |
endDayOfYear | query | no | array |
establishmentMeans | query | no | array |
eventDate | query | no | array |
eventId | query | no | array |
familyKey | query | no | array |
fieldNumber | query | no | array |
formation | query | no | array |
gadmGid | query | no | array |
gadmLevel0Gid | query | no | array |
gadmLevel1Gid | query | no | array |
gadmLevel2Gid | query | no | array |
gadmLevel3Gid | query | no | array |
gbifId | query | no | integer |
gbifRegion | query | no | array |
genusKey | query | no | array |
geoDistance | query | no | string |
georeferencedBy | query | no | array |
geometry | query | no | array |
group | query | no | array |
hasCoordinate | query | no | boolean |
higherGeography | query | no | array |
highestBiostratigraphicZone | query | no | array |
hasGeospatialIssue | query | no | boolean |
hostingOrganizationKey | query | no | array |
identifiedBy | query | no | array |
identifiedByID | query | no | array |
installationKey | query | no | array |
institutionCode | query | no | array |
institutionKey | query | no | array |
issue | query | no | array |
isInCluster | query | no | boolean |
island | query | no | array |
islandGroup | query | no | array |
isSequenced | query | no | boolean |
iucnRedListCategory | query | no | array |
kingdomKey | query | no | array |
lastInterpreted | query | no | array |
latestEonOrHighestEonothem | query | no | array |
latestEraOrHighestErathem | query | no | array |
latestPeriodOrHighestSystem | query | no | array |
latestEpochOrHighestSeries | query | no | array |
latestAgeOrHighestStage | query | no | array |
license | query | no | array |
lifeStage | query | no | array |
locality | query | no | array |
lowestBiostratigraphicZone | query | no | array |
measurementType | query | no | array |
measurementTypeID | query | no | array |
mediaType | query | no | array |
member | query | no | array |
modified | query | no | array |
month | query | no | array |
networkKey | query | no | array |
nucleotideSequence.nucleotideSequenceID | query | no | array |
nucleotideSequence.targetGene | query | no | array |
nucleotideSequence.sequence | query | no | array |
nucleotideSequence.sequenceLength | query | no | array |
nucleotideSequence.gcContent | query | no | array |
nucleotideSequence.nonIupacFraction | query | no | array |
nucleotideSequence.nonACGTNFraction | query | no | array |
nucleotideSequence.nFraction | query | no | array |
nucleotideSequence.nRunsCapped | query | no | array |
nucleotideSequence.naturalLanguageDetected | query | no | boolean |
nucleotideSequence.endsTrimmed | query | no | boolean |
nucleotideSequence.gapsOrWhitespaceRemoved | query | no | boolean |
nucleotideSequence.invalid | query | no | boolean |
occurrenceId | query | no | array |
occurrenceStatus | query | no | string |
orderKey | query | no | array |
organismId | query | no | array |
organismQuantity | query | no | array |
organismQuantityType | query | no | array |
otherCatalogNumbers | query | no | array |
parentEventId | query | no | array |
pathway | query | no | array |
phylumKey | query | no | array |
preparations | query | no | array |
previousIdentifications | query | no | array |
programme | query | no | array |
projectId | query | no | array |
protocol | query | no | array |
publishingCountry | query | no | array |
publishedByGbifRegion | query | no | array |
publishingOrg | query | no | array |
recordedBy | query | no | array |
recordedByID | query | no | array |
recordNumber | query | no | array |
relativeOrganismQuantity | query | no | array |
repatriated | query | no | boolean |
sampleSizeUnit | query | no | array |
sampleSizeValue | query | no | array |
samplingProtocol | query | no | array |
sex | query | no | array |
scientificName | query | no | array |
speciesKey | query | no | array |
startDayOfYear | query | no | array |
stateProvince | query | no | array |
taxonConceptId | query | no | array |
taxonKey | query | no | array |
taxonId | query | no | array |
taxonomicIssue | query | no | array |
taxonomicStatus | query | no | array |
typeStatus | query | no | array |
verbatimScientificName | query | no | array |
waterBody | query | no | array |
year | query | no | array |
geologicalTime | query | no | — |
lithostratigraphy | query | no | — |
biostratigraphy | query | no | — |
matchCase | query | no | boolean |
shuffle | query | no | string |
hl | query | no | boolean |
q | query | no | string |
limit | query | no | integer |
offset | query | no | integer |
facet | query | no | string |
facetMincount | query | no | integer |
facetMultiselect | query | no | boolean |
facetLimit | query | no | integer |
facetOffset | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Occurrence search is valid | SearchResponseOccurrenceOccurrenceSearchParameter |
400 | Invalid query, e.g. invalid vocabulary values | — |
GET/occurrence/search/catalogNumberSuggest catalogue numbers
Parameters| Name | In | Required | Type |
|---|
q | query | yes | string |
limit | query | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | OK | — |
GET/occurrence/search/collectionCodeSuggest collection codes
Parameters| Name | In | Required | Type |
|---|
q | query | yes | string |
limit | query | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | OK | — |
GET/occurrence/search/datasetNameSuggest dataset names
Parameters| Name | In | Required | Type |
|---|
q | query | yes | string |
limit | query | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | OK | — |
GET/occurrence/search/eventIdSuggest event ids
Parameters| Name | In | Required | Type |
|---|
q | query | yes | string |
limit | query | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | OK | — |
GET/occurrence/search/experimental/term/{term}Suggest values for supported terms
Parameters| Name | In | Required | Type |
|---|
term | query | yes | string |
q | query | yes | string |
limit | query | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | OK | — |
GET/occurrence/search/identifiedBySuggest identified by values
Parameters| Name | In | Required | Type |
|---|
q | query | yes | string |
limit | query | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | OK | — |
GET/occurrence/search/institutionCodeSuggest institution codes
Parameters| Name | In | Required | Type |
|---|
q | query | yes | string |
limit | query | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | OK | — |
GET/occurrence/search/localitySuggest locality strings
Parameters| Name | In | Required | Type |
|---|
q | query | yes | string |
limit | query | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | OK | — |
GET/occurrence/search/occurrenceIdSuggest occurrence ids
Parameters| Name | In | Required | Type |
|---|
q | query | yes | string |
limit | query | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | OK | — |
GET/occurrence/search/organismIdSuggest organism ids
Parameters| Name | In | Required | Type |
|---|
q | query | yes | string |
limit | query | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | OK | — |
GET/occurrence/search/otherCatalogNumbersSuggest other catalogue numbers
Parameters| Name | In | Required | Type |
|---|
q | query | yes | string |
limit | query | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | OK | — |
GET/occurrence/search/parentEventIdSuggest parent event ids
Parameters| Name | In | Required | Type |
|---|
q | query | yes | string |
limit | query | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | OK | — |
POST/occurrence/search/predicateOccurrence search using predicates
Request bodyapplication/json (required)
Responses| Status | Description | Schema |
|---|
200 | Occurrence search is valid | SearchResponseOccurrenceOccurrenceSearchParameter |
400 | Invalid query, e.g. invalid vocabulary values | — |
GET/occurrence/search/recordNumberSuggest record numbers
Parameters| Name | In | Required | Type |
|---|
q | query | yes | string |
limit | query | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | OK | — |
GET/occurrence/search/recordedBySuggest recorded by values
Parameters| Name | In | Required | Type |
|---|
q | query | yes | string |
limit | query | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | OK | — |
GET/occurrence/search/samplingProtocolSuggest sampling protocols
Parameters| Name | In | Required | Type |
|---|
q | query | yes | string |
limit | query | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | OK | — |
GET/occurrence/search/stateProvinceSuggest states/provinces
Parameters| Name | In | Required | Type |
|---|
q | query | yes | string |
limit | query | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | OK | — |
GET/occurrence/search/waterBodySuggest water bodies
Parameters| Name | In | Required | Type |
|---|
q | query | yes | string |
limit | query | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | OK | — |
Occurrence downloads17
**For a guide to making downloads through the API, see the [guide to API downloads](/en/data-use/api-downloads).** *The documentation here is automatically generated from the Java code. It is always up-to-date, but the structure for the main download request method is complex.*
This API provides services to request bulk downloads of occurrence records and retrieve information about those downloads.
Occurrence downloads are created asynchronously — the user requests a download and, once complete, is sent an email with a link to the resulting file.
It is necessary to register as a user at [GBIF.org](https://www.gbif.org/) to create a download request, and use HTTP authentication using the username (not the email) and password.
### Occurrence Download Predicates<a id="predicates"></a>
For the API reference for download predicates expand the “Schema” → `predicate` section of the request body schema on the [creation API call](#Occurrence%20downloads/requestDownload) (the first one after this text).
### Occurrence Download Limits<a id="limits"></a>
Occurrence downloads demand significant computational resources, and are monitored and limited according to the GBIF platform load. In order to avoid that downloads requested by a single user utilize most of the resources two rules have been set:
1. Download complexity limits:
* A download predicate may contain a maximum of 101,000 items (taxon keys, kingdom keys, phylum keys, catalogue numbers, occurrence ids and so on).
* A download predicate may contain a maximum of 10,000 points in any “within” predicate geometries.
2. Limits on incomplete (preparing, running) downloads:
* If the total number of incomplete downloads is fewer than 100, any single user can have no more than 3 incomplete downloads.
* If the total number of downloads is fewer than 1000 any single user may only have 1 download.
The number of user downloads currently in progress can be seen on the [System Health page](https://www.gbif.org/system-health). Your own downloads can be seen on your [My Downloads](https://www.gbif.org/user/download) page.
GET/occurrence/download/dataset/{datasetKey}List the downloads activity of a dataset.
Parameters| Name | In | Required | Type |
|---|
datasetKey | path | yes | string |
showDownloadDetails | query | no | boolean |
limit | query | no | integer |
offset | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Dataset found and download information returned | PagingResponseDatasetOccurrenceDownloadUsage |
400 | Invalid request | — |
404 | Entity or subentity not found | — |
5XX | System failure – try again | — |
POST/occurrence/download/requestRequests the creation of a download file.
Request bodyapplication/json (required)
Responses| Status | Description | Schema |
|---|
201 | Download requested, key returned. | — |
400 | Invalid query, see [predicates](#predicates). | — |
429 | Too many downloads, wait for one of your downloads to complete. See [limits](#limits) | — |
GET/occurrence/download/request/predicateConverts a plain search query into a download predicate.
Parameters| Name | In | Required | Type |
|---|
notification_address | query | no | string |
format | query | yes | string |
verbatimExtensions | query | no | string |
interpretedExtensions | query | no | string |
description | query | no | string |
machineDescription | query | no | string |
checklistKey | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | OK | DownloadRequest |
GET/occurrence/download/request/sqlConverts a plain search query into an SQL download predicate.
Parameters| Name | In | Required | Type |
|---|
notification_address | query | no | string |
description | query | no | string |
machineDescription | query | no | string |
checklistKey | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | OK | — |
POST/occurrence/download/request/sqlConverts a predicate download request into an SQL download request.
Request bodyapplication/json (required)
Responses| Status | Description | Schema |
|---|
200 | OK | — |
POST/occurrence/download/request/validate**Experimental** Validates the SQL contained in an SQL download request.
Request bodyapplication/json (required)
Responses| Status | Description | Schema |
|---|
200 | SQL is valid. | — |
400 | Invalid query, see other documentation. | — |
GET/occurrence/download/request/{key}Retrieve the resulting download file
Parameters| Name | In | Required | Type |
|---|
key | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | OK | — |
302 | Download found, follow the redirect to the data file (e.g. zip file). | — |
404 | Invalid download key. | — |
410 | Download file was erased and is no longer available. | — |
DELETE/occurrence/download/request/{key}Cancel a running download
Parameters| Name | In | Required | Type |
|---|
key | path | yes | string |
Responses| Status | Description | Schema |
|---|
204 | Download cancelled. | — |
404 | Invalid download key. | — |
GET/occurrence/download/user/{user}Lists all occurrence downloads from a user
Parameters| Name | In | Required | Type |
|---|
user | path | yes | string |
page | query | no | — |
status | query | no | array |
from | query | no | string |
statistics | query | no | boolean |
Responses| Status | Description | Schema |
|---|
200 | OK | PagingResponseDownload |
GET/occurrence/download/user/{user}/countCounts all downloads from a user
Parameters| Name | In | Required | Type |
|---|
user | path | yes | string |
status | query | no | array |
from | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | OK | — |
GET/occurrence/download/{key}Information about an occurrence download
Parameters| Name | In | Required | Type |
|---|
key | path | yes | string |
statistics | query | no | boolean |
Responses| Status | Description | Schema |
|---|
200 | Occurrence download information. | Download |
400 | Invalid request | — |
404 | Entity or subentity not found | — |
5XX | System failure – try again | — |
GET/occurrence/download/{key}/citationShows the citation for an occurrence download
Parameters| Name | In | Required | Type |
|---|
key | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Download citation. | — |
400 | Invalid request | — |
404 | Entity or subentity not found | — |
5XX | System failure – try again | — |
GET/occurrence/download/{key}/datasetsLists datasets present in an occurrence download
Parameters| Name | In | Required | Type |
|---|
key | path | yes | string |
datasetTitle | query | no | string |
sortBy | query | no | string |
sortOrder | query | no | string |
page | query | no | — |
Responses| Status | Description | Schema |
|---|
200 | OK | PagingResponseDatasetOccurrenceDownloadUsage |
GET/occurrence/download/{key}/datasets/exportExports datasets present in an occurrence download in TSV or CSV format
Parameters| Name | In | Required | Type |
|---|
key | path | yes | string |
format | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Dataset usage within an occurrence download information. | — |
400 | Invalid request | — |
404 | Entity or subentity not found | — |
5XX | System failure – try again | — |
GET/occurrence/download/{prefix}/{suffix}Information about an occurrence download
Parameters| Name | In | Required | Type |
|---|
prefix | path | yes | string |
suffix | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Occurrence download information. | Download |
400 | Invalid request | — |
404 | Entity or subentity not found | — |
5XX | System failure – try again | — |
GET/occurrence/download/{prefix}/{suffix}/citationShows the citation for an occurrence download
Parameters| Name | In | Required | Type |
|---|
prefix | path | yes | string |
suffix | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | Download citation. | — |
400 | Invalid request | — |
404 | Entity or subentity not found | — |
5XX | System failure – try again | — |
GET/occurrence/download/{prefix}/{suffix}/datasetsLists datasets present in an occurrence download
Parameters| Name | In | Required | Type |
|---|
prefix | path | yes | string |
suffix | path | yes | string |
limit | query | no | integer |
offset | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | Dataset usage within an occurrence download information. | PagingResponseDatasetOccurrenceDownloadUsage |
400 | Invalid request | — |
404 | Entity or subentity not found | — |
5XX | System failure – try again | — |
Occurrence download formats6
This API lists the fields present in the various download formats, their data types and their term identifiers.
GET/occurrence/download/describe/dwca**Experimental.** Describes the fields present in a Darwin Core Archive format download
Responses| Status | Description | Schema |
|---|
200 | Field description | DwcDownload |
GET/occurrence/download/describe/simpleAvro**Experimental.** Describes the fields present in a Simple Avro format download
Responses| Status | Description | Schema |
|---|
200 | Field description | Table |
GET/occurrence/download/describe/simpleCsv**Experimental.** Describes the fields present in a Simple CSV format download
Responses| Status | Description | Schema |
|---|
200 | Field description | Table |
GET/occurrence/download/describe/simpleParquet**Experimental.** Describes the fields present in a Simple Parquet format download
Responses| Status | Description | Schema |
|---|
200 | Field description | Table |
GET/occurrence/download/describe/speciesList**Experimental.** Describes the fields present in a Species List format download
Responses| Status | Description | Schema |
|---|
200 | Field description | Table |
GET/occurrence/download/describe/sql**Very experimental.** Describes the fields available for searching or download when using an SQL query.
Responses| Status | Description | Schema |
|---|
200 | Field description | Table |
Occurrence download statistics6
This API provides statistics about occurrence downloads.
GET/occurrence/download/statisticsProvides summarized download statistics
Parameters| Name | In | Required | Type |
|---|
fromDate | query | no | string |
toDate | query | no | string |
publishingCountry | query | no | string |
datasetKey | query | no | string |
publishingOrgKey | query | no | string |
limit | query | no | integer |
offset | query | no | integer |
Responses| Status | Description | Schema |
|---|
200 | OK | PagingResponseDownloadStatistics |
GET/occurrence/download/statistics/downloadedRecordsByDatasetSummarize downloaded records by dataset
Parameters| Name | In | Required | Type |
|---|
fromDate | query | no | string |
toDate | query | no | string |
publishingCountry | query | no | string |
datasetKey | query | no | string |
publishingOrgKey | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | OK | — |
GET/occurrence/download/statistics/downloadsByDatasetSummarize downloads by dataset
Parameters| Name | In | Required | Type |
|---|
fromDate | query | no | string |
toDate | query | no | string |
publishingCountry | query | no | string |
datasetKey | query | no | string |
publishingOrgKey | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | OK | — |
GET/occurrence/download/statistics/downloadsBySourceSummarize downloaded record totals by source
Parameters| Name | In | Required | Type |
|---|
fromDate | query | no | string |
toDate | query | no | string |
source | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Download statistics. | — |
400 | Invalid request | — |
404 | Entity or subentity not found | — |
5XX | System failure – try again | — |
GET/occurrence/download/statistics/downloadsByUserCountrySummarizes downloads by month, grouped by the user's country, territory or island
Parameters| Name | In | Required | Type |
|---|
fromDate | query | no | string |
toDate | query | no | string |
userCountry | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Download statistics. | — |
400 | Invalid request | — |
404 | Entity or subentity not found | — |
5XX | System failure – try again | — |
GET/occurrence/download/statistics/exportExport summary of occurrence downloads
Parameters| Name | In | Required | Type |
|---|
format | query | no | string |
fromDate | query | yes | string |
toDate | query | yes | string |
publishingCountry | query | yes | string |
datasetKey | query | no | string |
publishingOrgKey | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | OK | — |
Occurrence metrics2
This API provides services to retrieve various counts and metrics provided for occurrence records. The metrics that are currently supported are listed by the API itself, see [the schema method](#operation/getOccurrenceCountSchema) for details.
GET/occurrence/countOccurrence counts
Parameters| Name | In | Required | Type |
|---|
arg0 | query | yes | — |
basisOfRecord | query | no | string |
country | query | no | string |
datasetKey | query | no | string |
isGeoreferenced | query | no | boolean |
issue | query | no | string |
protocol | query | no | string |
publishingCountry | query | no | string |
taxonKey | query | no | string |
typeStatus | query | no | string |
year | query | no | integer |
checklistKey | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Count returned. | — |
400 | Invalid query. | — |
GET/occurrence/count/schemaSupported occurrence count metrics
Responses| Status | Description | Schema |
|---|
200 | Supported metrics. | — |
Occurrence inventories5
This API provides services that list all distinct values together with their occurrence count for a given occurrence property. Only a few properties are supported, each with its own service to call.
GET/occurrence/counts/basisOfRecordOccurrence inventory by basis of record
Responses| Status | Description | Schema |
|---|
200 | Inventory counts returned. | — |
GET/occurrence/counts/countriesOccurrence inventory by country
Parameters| Name | In | Required | Type |
|---|
publishingCountry | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Inventory counts returned. | — |
400 | Invalid query. | — |
GET/occurrence/counts/datasetsOccurrence inventory by dataset
Parameters| Name | In | Required | Type |
|---|
country | query | no | string |
nubKey | query | no | integer |
taxonKey | query | no | string |
checklistKey | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Inventory counts returned. | — |
400 | Invalid query. | — |
GET/occurrence/counts/publishingCountriesOccurrence inventory by publishing country
Parameters| Name | In | Required | Type |
|---|
country | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Inventory counts returned. | — |
400 | Invalid query. | — |
GET/occurrence/counts/yearOccurrence inventory by year
Parameters| Name | In | Required | Type |
|---|
year | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | Inventory counts returned. | — |
400 | Invalid query. | — |
GADM regions7
The [GADM Global Administrative Area Database](https://gadm.org) is a high-resolution database of administrative areas of countries.
Within GBIF, it is used to index occurrence data by administrative region.
This API provides services to search and browse regions and sub-regions down to the third level sub-region.
GET/geocode/gadm/browseList all top-level GADM regions
Parameters| Name | In | Required | Type |
|---|
q | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | List of GADM regions. | — |
GET/geocode/gadm/browse/{level0}First-level subdivisions of a GADM region
Parameters| Name | In | Required | Type |
|---|
level0 | path | yes | string |
q | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | List of GADM regions. | — |
404 | GADM region unknown. | — |
GET/geocode/gadm/browse/{level0}/{level1}Second-level subdivisions of a GADM region
Parameters| Name | In | Required | Type |
|---|
level0 | path | yes | string |
level1 | path | yes | string |
q | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | List of GADM regions. | — |
404 | GADM region unknown. | — |
GET/geocode/gadm/browse/{level0}/{level1}/{level2}Third-level subdivisions of a GADM region
Parameters| Name | In | Required | Type |
|---|
level0 | path | yes | string |
level1 | path | yes | string |
level2 | path | yes | string |
q | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | List of GADM regions. | — |
404 | GADM region unknown. | — |
GET/geocode/gadm/searchSearch for GADM regions.
Parameters| Name | In | Required | Type |
|---|
q | query | no | string |
gadmLevel | query | no | string |
gadmGid | query | no | string |
page | query | no | — |
Responses| Status | Description | Schema |
|---|
200 | List of GADM regions. | PagingResponseGadmRegion |
404 | GADM region unknown. | — |
GET/geocode/gadm/{gid}Details for a GADM region
Parameters| Name | In | Required | Type |
|---|
gid | path | yes | string |
Responses| Status | Description | Schema |
|---|
200 | GADM region returned. | GadmRegion |
404 | GADM region unknown. | — |
GET/geocode/gadm/{gid}/subdivisionsSubdivisions of a GADM region
Parameters| Name | In | Required | Type |
|---|
gid | path | yes | string |
q | query | no | string |
Responses| Status | Description | Schema |
|---|
200 | List of GADM regions. | — |
404 | GADM region unknown. | — |
Country usages occurrence downloads1
GET/occurrence/download/{key}/countriesLists countries present in an occurrence download
Parameters| Name | In | Required | Type |
|---|
key | path | yes | string |
sortBy | query | no | string |
sortOrder | query | no | string |
page | query | no | — |
Responses| Status | Description | Schema |
|---|
200 | OK | PagingResponseCountryOccurrenceDownloadUsage |
Organization usages occurrence downloads1
GET/occurrence/download/{key}/organizationsLists organizations present in an occurrence download
Parameters| Name | In | Required | Type |
|---|
key | path | yes | string |
organizationTitle | query | no | string |
sortBy | query | no | string |
sortOrder | query | no | string |
page | query | no | — |
Responses| Status | Description | Schema |
|---|
200 | OK | PagingResponseOrganizationOccurrenceDownloadUsage |
home-resource1
GET/
Responses| Status | Description | Schema |
|---|
200 | OK | — |
occurrence-species-multimedia-resource2
GET/occurrence/experimental/multimedia/species/{checklistKey}/{taxonKey}
Parameters| Name | In | Required | Type |
|---|
checklistKey | path | yes | string |
taxonKey | path | yes | string |
mediaType | query | yes | string |
limit | query | yes | integer |
offset | query | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | OK | TaxonMultimediaSearchResponse |
GET/occurrence/experimental/multimedia/species/{taxonKey}
Parameters| Name | In | Required | Type |
|---|
taxonKey | path | yes | string |
mediaType | query | yes | string |
limit | query | yes | integer |
offset | query | yes | integer |
Responses| Status | Description | Schema |
|---|
200 | OK | TaxonMultimediaSearchResponse |