Services summary

Introduction

The Netherlands Biodiversity API offers web services for free text search and specific indexed field(s) search in multiple taxonomy and specimen occurrence data sources. Searches can be done on either taxa, specimen occurrences, and, multimedia linked to either a taxon or a specimen occurrence. The searchable data is stored as text documents in Elasticsearch document store. In nearly all cases an API request returns data as a JSON-formatted document.

For each type of data, i.e. taxon, specimen occurrence and multimedia, one or more http GET services - data acquisition operations - are available. Each service is described in this document.

Taxonomic data services

TAXON search  
Description
This direct search service returns TAXON documents. Available direct search types are a. free text search, and b. indexed field search.
Examples
Examples of both free text and indexed field taxon searches can be found in the taxon Examples section
Request












More details in the
taxon Requests section
  Free text search Indexed field search
HTTP support GET GET
Searchable fields list of indexed taxon document fields are queried list of indexed taxon document fields can be queried
Geospatial search Not available Not available
Meta parameters Paging and sorting parameters are available.
Paging and sorting parameters are available.

Additional logical operator _andOr for indexed field search.
Details
Request examples are listed in the taxon free text search section
Request examples are listed in the taxon indexed field search section
Response


More details in the
taxon Responses section
  Free text search Indexed field search
Data format JSON JSON
Details
A response example can be viewed after calling a request example in the taxon free text search section
A response example can be viewed after calling a request example in the taxon indexed field search section

Specimen Occurrence data services

SPECIMEN search  
Description
This direct search service returns SPECIMEN documents. Available direct search types are a. free text search, and b. indexed field search.
Examples
Examples of both free text and indexed field taxon searches can be found in the specimen Examples section
Request










More details in
the specimen Requests section
  Free text search Indexed field search
HTTP support GET GET
Searchable fields list of indexed specimen document fields are queried list of indexed specimen document fields can be queried
Geospatial search Geosearch is available. Combined geo - free text search uses default the boolean operator AND. Sec geosearch is also possible. Geosearch is available. Combined geo - indexed field search uses default the boolean operator AND. Sec geosearch is also possible.
Meta parameters Paging and sorting parameters are available.
Paging and sorting parameters are available.

Additional logical operator _andOr for indexed field search.
Details
Request examples are listed in the specimen free text search section
Request examples are listed in the specimen indexed field search section
Response



More details in
the specimen Responses section
  Free text search Indexed field search
Data format JSON JSON
Details
A response example can be viewed after calling a request example in the specimen free text search section
A response example can be viewed after calling a request example in the indexed field search section

SPECIMEN NAME search  
Description
This combined direct and indirect search service returns SPECIMEN documents. Available direct search types are a. free text search, and b. indexed field search. The indirect search service is an in-built name resolution service which is default active. Name resolution can not be deactivated.
Examples
Examples of both free text and indexed field taxon searches can be found in the specimen Examples section
Request














More details in
the Requests section
  Free text search Indexed field search
HTTP support GET GET
Searchable fields list of indexed specimen document fields for specimen name search are queried. There is no overlap between this list and the list of selected fields for specimen seaerch. list of indexed specimen document fields for specimen name search can be queried. There is no overlap between this list and the list of selected fields for specimen seaerch.
Geospatial search Geosearch is available. Combined geo - free text search uses default the boolean operator AND. Sec geosearch is also possible. Geosearch is available. Combined geo - indexed field search uses default the boolean operator AND. Sec geosearch is also possible.
Meta parameters Paging and sorting parameters are available.
Paging and sorting parameters are available.

Additional logical operator _andOr for indexed field search.
Details
Request examples are listed in the specimen name free text search section
Request examples are listed in the specimen name indexed field search section
Response



More details in
the specimen Responses section
  Free text search Indexed field search
Data format JSON JSON
Details
A response example can be viewed after calling a request example in the specimen name free text search section
A response example can be viewed after calling a request example in the specimen name indexed field search section

SPECIMEN COLLECTION search  
Description
This direct search service returns a DwCA zip file containing all available SPECIMEN occurrences of a Naturalis Collection. All DwCA zip files have a similar internal file structure and comply to multiple data standards.
Examples
Examples of DwCA file downloads can be found in the specimen collection Examples section
Request


More details in
the Requests section
HTTP support GET
Downloadable collections list of Naturalis collections which are available for download. The list is living document.
Geospatial search Not available
Meta parameters No specific meta parameters are available
Details Request examples are listed in the specimen collection Examples section
Response

More details in
the Responses section
Data format DwCA
Details The basic structure of a DwCA file can be viewed after calling a request example in the specimen collection Examples section

Multimedia data services

MULTIMEDIA search  
Description
This combined direct and indirect search service returns MULTIMEDIA documents. Available direct search types are a. free text search, and b. indexed field search. The indirect search service is an in-built name resolution service which is default active. Name resolution can not be deactivated.
Examples
Examples of both free text and indexed field taxon searches can be found in the multimedia Examples section
Request










More details in
the multimedia Requests section
  Free text search Indexed field search
HTTP support GET GET
Searchable fields list of indexed multimedia document fields are queried list of indexed multimedia document fields can be queried
Geospatial search Geosearch is available. Combined geo - free text search uses default the boolean operator AND. Sec geosearch is also possible. Geosearch is available. Combined geo - indexed field search uses default the boolean operator AND. Sec geosearch is also possible.
Meta parameters Paging and sorting parameters are available.
Paging and sorting parameters are available.

Additional logical operator _andOr for indexed field search.
Details
Request examples are listed in the multimedia free text search section
Request examples are listed in the multimedia indexed field search section
Response


More details in
the Responses section
  Free text search Indexed field search
Data format JSON JSON
Details
The basic structure of the responses can be viewed in the multimedia free text search section
The basic structure of the responses can be viewed in the multimedia indexed field search section