REST API

The EBV Data Portal API is a REST JSON based API. The base URL you should use is: https://portal.geobon.org/api/v1/

This API is particularly developed for the machine-readable integration, sharing and use of EBV datasets. This is the first version of the API and it contains GET requests only. Please report any issues you find with the API using the "Feedback" button.

Description URL
Get List of all EBV Classes/Names https://portal.geobon.org/api/v1/ebv
Get list of all datasets https://portal.geobon.org/api/v1/datasets
Get total count of datasets https://portal.geobon.org/api/v1/datasets/count
Get dataset by ID

https://portal.geobon.org/api/v1/datasets/:id

Example: Get dataset by id 2

https://portal.geobon.org/api/v1/datasets/2
Get datasets by filter https://portal.geobon.org/api/v1/datasets/filter?queryParam=value
  • The use of multiple query params are not supported.
  • The space character in the URL should be encoded with +
queryParam value
creator

Other: Type string

Example: Get datasets filtered by creator Matthew Hansen

https://portal.geobon.org/api/v1/datasets/filter?creator=matthew+hansen

creation date

ISO date format (YYYY-MM-DD)

Example: Get datasets filtered by creation date 2020-01-01

https://portal.geobon.org/api/v1/datasets/filter?date=2020-01-01

ebvClass

Species traits

Species populations

Genetic composition

Community composition

Ecosystem structure

Ecosystem function


Example: Get datasets filtered by EBV Class Ecosystem structure

https://portal.geobon.org/api/v1/datasets/filter?ebvClass=ecosystem+structure

ebvName

Intraspecific genetic diversity

Genetic differentiation

Effective population size

Inbreeding

Species distributions

Species abundances

Morphology

Physiology

Phenology

Movement

Community abundance

Taxonomic and phylogenetic diversity

Trait diversity

Interaction diversity

Primary productivity

Ecosystem phenology

Ecosystem disturbances

Live cover fraction

Ecosystem distribution

Ecosystem Vertical Profile

Pollination


Example: Get datasets filtered by EBV Name Ecosystem distribution

https://portal.geobon.org/api/v1/datasets/filter?ebvName=ecosystem+distribution

entityType

Species

Communities

Ecosystems

Other: Type string


Get datasets filtered by entity type Ecosystems:

https://portal.geobon.org/api/v1/datasets/filter?entityType=ecosystems

spatialScope

Global

Continental

National

Regional

Local


Example: Get datasets filtered by spatialScope Global:

https://portal.geobon.org/api/v1/datasets/filter?spatialScope=global

temporalResolution

P0010-00-00 (Decadal)

P0001-00-00 (Yearly)

P000-01-00 (Monthly)

P0000-00-07 (Weekly)

P0000-00-01 (Daily)

Other: Type ISO 8601:2004

Please specify here the other time period of the dataset.

Example: Get datasets filtered by temporal resolution every 5 years:

https://portal.geobon.org/api/v1/datasets/filter?temporalResolution=P0005-00-00

environmentalDomain

Terrestrial

Marine

Freshwater


Example: Get datasets filtered by environmentalDomain terrestrial:

https://portal.geobon.org/api/v1/datasets/filter?environmentalDomain=terrestrial