GEO BON logo

API

REST JSON API

The BON in a Box API is a REST JSON based API. The base URL you should use is: http://boninabox.geobon.org/api


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 tools


https://boninabox.geobon.org/api/tools

List by ID

Get tool by ID

https://boninabox.geobon.org/api/tools/:id


Example: Get tool by ID 45

https://boninabox.geobon.org/api/tools/45

List by filter

Get tools by filter

https://boninabox.geobon.org/api/tools/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

author

Type: string

Example: Get tools filtered by author Angelica Díaz

https://boninabox.geobon.org/api/tools/filter?author=angelica+díaz

year

≥2000

Example: Get tools filtered by year 2015

https://boninabox.geobon.org/api/tools/filter?year=2015

technicalStatus

Finish and with constant technical support

Finish without technical support

In development

Unknown

monitoringComponents

Observation design

Data reporting

Data management

Data collection

Data analysis


Example: Get tools filtered by Data management

https://boninabox.geobon.org/api/tools/filter?monitoringComponents=data+management

ebvClass

Species traits

Species populations

Genetic composition

Community composition

Ecosystem structure

Ecosystem function


Example: Get tools filtered by EBV Class Species traits

https://boninabox.geobon.org/api/tools/filter?ebvClass=species+traits

theme

Terrestrial

Marine

Freshwater

Ecosystem services

Citizen Science

Invasive

Migratory

Traditional Knowledge


Example: Get tools filtered by theme terrestrial:

https://boninabox.geobon.org/api/tools/filter?theme=terrestrial

monitoringTechnic

Bioacoustics

Metagenomics

Camera Trapping

Drones

Transect counts

Fruit baiting

Large area monitoring

Garden monitoring

Point observation

Mark-release-recapture

Distance sampling

Puddling

Other technic


Example: Get tools filtered by technic Metagenomics:

https://boninabox.geobon.org/api/tools/filter?monitoringTechnic=metagenomics

taxonomicGroup

Plants

Birds

Mammals

Fishes

Reptiles

Amphibians

Butterflies

Macroinvertebrates

Other Invertebrates


Get tools filtered by taxonomic group mammals:

https://boninabox.geobon.org/api/tools/filter?taxomomicGroup=mammals

Count

Get total count of tools


https://boninabox.geobon.org/api/tools/count