API Help Documentation

Introduction

The BioNet API is currently in development. It is usable in its current state, but the functionality of any portion of the API may change or be removed without notice. If you have any questions or specific needs for the API, please contact the data steward.
This notification will be updated when the API is released.

The current version of the API is v1.

The BioNet API is a web service: it uses a RESTful API with a JSON payload to give you access to various data within the database.

Understanding the fields parameter

The fields parameter filters the API response so that the response only includes a specific set of fields. The fields parameter lets you remove nested properties from an API response and thereby reduce bandwidth usage. The following rules explain the supported syntax for the fields parameter value:

Use a comma-separated list (fields=a,b) to select multiple fields.
Use an asterisk (fields=*) as a wildcard to identify all fields.
Use parentheses (fields=a(b,c)) to specify a group of nested properties that will be included in the API response.
Use a forward slash (fields=a/b) to identify a nested property.

Sites

API	Description
GET api/v1/sites?f={f}&offset={offset}&limit={limit}&sort={sort}&order={order}&filter={filter}	Get all sites in the database.
GET api/v1/sites/{id}?f={f}	Get a single site
GET api/v1/sites/types	Returns list of all possible site types
GET api/v1/sites/statuses	Returns list of all possible site statuses
GET api/v1/sites/tags	Returns list of existing site project tags
GET api/v1/sites/tags/{id}	No documentation available.
GET api/v1/sites/by_type/{id}?f={f}	Returns list of sites by site type.
GET api/v1/sites/by_status/{id}?f={f}	Get all sites having requested status
GET api/v1/sites/by_huc8/{id}?f={f}	Return all sites within a HUC8 watershed
GET api/v1/sites/on_segment/{id}?f={f}	Returns list of sites on a 305(b) assessment segment
GET api/v1/sites/by_tag/{id}?f={f}	Return all sites with a project tag
GET api/v1/sites/ecoregions	List EcoRegions of Iowa
GET api/v1/sites/ecoregions/{id}/details	Returns details of an EcoRegion
GET api/v1/sites/counties?f={f}	No documentation available.

Inverts

API	Description
GET api/v1/inverts/taxa?f={f}&offset={offset}&limit={limit}&sort={sort}&order={order}&filter={filter}	Returns a list of all macroinvertebrate taxa
GET api/v1/inverts/taxa/{id}	Return a single macroinvertebrate taxa
GET api/v1/inverts/ffg	Returns list of all Functional Feeding Groups
GET api/v1/inverts/at_sites/{id}?f={f}	Return list of all sites where a benthic invertebrate taxa has been collected
GET api/v1/inverts/spatial_temporal_distribution/{id}	Data stream designed for spatial (GIS) and temporal (time slider widget) display of invertebrate taxa distribution history
GET api/v1/inverts/bmibi/{type}	Returns all Benthic Macroinvertebrate Index of Biotic Integrity (BMIBI) scores by type

Habitat

API	Description
GET api/v1/habitat/fhimetrics	Return all hab metrics used to calculate the Fish Habitat Index
GET api/v1/habitat/fhiscores	Return all Fish Habitat Index scores
GET api/v1/habitat/wasteload_inputs/{id}	Returns habitat parameters for wasteload input calculations.

Fish

API	Description
GET api/v1/fish/species?f={f}&offset={offset}&limit={limit}&sort={sort}&order={order}&filter={filter}	Return list of all fish species
GET api/v1/fish/species/{id}	Return a single fish species
GET api/v1/fish/at_sites/{id}?f={f}	Return list of all sites where a fish species has been collected
GET api/v1/fish/spatial_temporal_distribution/{id}	Data stream designed for spatial (GIS) and temporal (time slider widget) display of fish species distribution history
GET api/v1/fish/fibi?year={year}&program={program}	Return list of FIBI (Fish Index of Biotic Integrity) scores
GET api/v1/fish/fibi/by_site/{id}?year={year}&program={program}	Return all FIBI scores for a given site sampled within the requested calendar year.