Manual

The OBIS API

This is the documentation for the OBIS API. Paged responses include the fields count, offset, limit, lastpage, and results. Some arguments accept multiple, comma-separated, values.

Occurrence

URL Description Parameters Example
/occurrence/{id} Get single occurrence
/occurrence Find occurrences scientificname,
obisid,
aphiaid,
resourceid,
areaidid,
year,
startdate,
enddate,
groupid,
startdepth,
enddepth,
geometry,
qc,
fields,
offset,
limit
http://api.iobis.org/occurrence?year=2005&scientificname=Cetacea&limit=100

http://api.iobis.org/occurrence?&scientificname=Abra,Lanice,Pectinaria&year=2005,2006

Occurrence download

Large result sets can be downloaded as a single CSV file using the download API. The initial search request will return a UUID, which can be used to retrieve the file when it is ready. Files will be removed after a few days. Alternatively, results can be downloaded synchronously by adding sync=true.

URL Description Parameters Example
/occurrence/download Find occurrences See /occurrence for parameters. offset and limit do not apply. http://api.iobis.org/occurrence/download?year=2005&scientificname=Cetacea
/download/{uuid}/status Get download status http://api.iobis.org/download/77b2c516-a20c-3850-9862-420b09b27755/status
/download/{uuid} Download file http://api.iobis.org/download/77b2c516-a20c-3850-9862-420b09b27755

Taxa

URL Description Parameters Example
/taxa Find taxa scientificname,
obisid,
aphiaid,
resourceid,
areaid,
year,
startdate,
enddate,
startdepth,
enddepth,
geometry,
offset,
limit
http://api.iobis.org/taxa?resourceid=3013

http://api.iobis.org/taxa?year=2005&scientificname=Cetacea

http://api.iobis.org/taxa?areaid=21&scientificname=Mollusca&limit=100

Taxa download

URL Description Parameters Example
/taxa/download Find taxa See /taxa for parameters. offset and limit do not apply. http://api.iobis.org/taxa/download?areaid=21&scientificname=Mollusca
/download/{uuid}/status Get download status http://api.iobis.org/download/b519d235-c324-3bad-aa67-22b52becc952/status
/download/{uuid} Download file http://api.iobis.org/download/b519d235-c324-3bad-aa67-22b52becc952

Resource

URL Description Parameters Example
/resource/{id} Get single resource /resource/3013
/resource Find resources scientificname,
obisid,
aphiaid,
areaid,
year,
startdate,
enddate,
startdepth,
enddepth,
geometry,
offset,
limit
http://api.iobis.org/resource?startdate=2010-01-01&scientificname=Cetacea

Resource download

URL Description Parameters Example
/resource/download Find resources See /resource for parameters. offset and limit do not apply. http://api.iobis.org/resource/download?year=2005&scientificname=Cetacea
/download/{uuid}/status Get download status http://api.iobis.org/download/07103de8-eb0e-3e9c-92f0-07c85bd8cf78/status
/download/{uuid} Download file http://api.iobis.org/download/07103de8-eb0e-3e9c-92f0-07c85bd8cf78

Areas

URL Description Parameters Example
/area Find areas offset,
limit
http://api.iobis.org/area

Taxonomic groups

URL Description Parameters Example
/group Find groups offset,
limit
http://api.iobis.org/group

Taxon

URL Description Parameters Example
/taxon/{id} Get single taxon
/taxon/{id}/common Get common names
/taxon Find taxon scientificname,
obisid,
aphiaid