GEO BON logo iDiv logo Beta version

REST API

REST JSON 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 below.

Feedback

List

Get list of all datasets


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

List by ID

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

List by filter

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 +.


The following query parameters and values are available:


queryParam

value

creator

Type: string

Example: Get datasets filtered by creator Matthew Hansen

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

pubDate

≥2010

Example: Get datasets filtered by publication date 2016

https://portal.geobon.org/api/v1/datasets/filter?pubDate=2016

ebvClass

Species traits

Species populations

Genetic composition

Community composition

Ecosystem structure

Ecosystem function


Example: Get datasets filtered by EBV Class Species traits

https://portal.geobon.org/api/v1/datasets/filter?ebvClass=species+traits

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 Community abundance

https://portal.geobon.org/api/v1/datasets/filter?ebvName=community+abundance

entityType

Species

Community

Ecosystem

Type: string


Get datasets filtered by entity type vegetation:

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

spatialExtent

Global

Continental

National

Regional

Local


Example: Get datasets filtered by spatialExtent Global:

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

temporalResolution

Decadal

Yearly

Montly

Weekly

Daily

Type: string


Get datasets filtered by temporal resolution every 5 years:

https://portal.geobon.org/api/v1/datasets/filter?temporalResolution=every+5+years

environmentalDomain

Terrestrial

Marine

Freshwater


Example: Get datasets filtered by environmentalDomain terrestrial:

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

Count

Get total count of datasets


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

EBV structure

Get List of all EBV Classes and EBV names


https://portal.geobon.org/api/v1/ebv