Biositing Tool API (v1)¶
The Biositing Tool API is an open API for programatically accessing data in our geospatial platform based on REpresentational State Transfer (REST) principles. In a RESTful system, information is organized into resources, each of which is uniquely identified via a uniform resource identifier (URI). This page documents the first release (v1) of the Biositing API and provides examples of common use-cases.
Authentication¶
SSL Encryption All requests to the Biositing API must be done over HTTPS. Non-secure http requests are not allowed and will result in a HTTP 403 (Forbidden) response.
Security¶
You agree not to use automated scripts to collect large fractions of the database and disseminate them. You may collect large fractions of the database for analysis and to present processed results with proper attribution. If you plan to download large datasets, please email lead.jbei@gmail.com with the email address associated with your account and with your use case so that we can avoid flagging your account as abusing the service. We may also suggest an efficient way for you to obtain the data you need. We reserve the right to disable API access as a security precaution against bots.
API Reference¶
General URI Format¶
All URIs in the Biositing API are of the general form
https://biositing.jbei.org/api/v1/{resource_type}[?{parameters}]
-
The initial part of the URI (https://biositing.jbei.org/api/v1/) is a preamble, specifying a https REST request. The v1 denotes version 1 of the API, to provide flexibility to support multiple versions of the API in the future.
-
{resource_type}specifies the kind of information or operation being requested. -
{parameters}specifies optional query parameters in the formatkey=value. When specifying mulitple query parameters in a URIthey must be separated by&characters e.g.key1=value1&key2=value2&key3=value3
Resources¶
In the Biositing API, resources refer to specific types of data in the tool that can be accessed programatically with a URI endpoint. Currently supported endpoints (v1 of the REST API) include the following:
ethanol_biorefineries¶
Request Template¶
GET https://biositing.jbei.org/api/v1/ethanol_biorefineries
Obtain dataset of ethanol biorefineries in the continental U.S. Attributes include name, address, latitude, longitude, capacity, operational status, etc.
renewable_diesel_saf_plants¶
Request Template¶
GET https://biositing.jbei.org/api/v1/renewable_diesel_saf_plants
Obtain dataset of renewable diesel and SAF plants in the continental U.S. Attributes include name, address, latitude, longitude, capacity, operational status, etc.
biosolids_facilities¶
Request Template¶
GET https://biositing.jbei.org/api/v1/biosolids_facilities
Obtain dataset of biosolids facilities in the continental U.S.
biodiesel_plants¶
Request Template¶
GET https://biositing.jbei.org/api/v1/biodiesel_plants
Obtain dataset of biodiesel plants in the continental U.S.
livestock_anaerobic_digesters¶
Request Template¶
GET https://biositing.jbei.org/api/v1/livestock_anaerobic_digesters
Obtain dataset of livestock anaerobic digesters in the continental U.S.
nass_manure¶
Request Template¶
GET https://biositing.jbei.org/api/v1/nass_manure
Obtain dataset of sub-county point source estimates of manure in the continental U.S. downscaled from county-level data from the 2022 USDA NASS Census of Agriculture.
cafos¶
Request Template¶
GET https://biositing.jbei.org/api/v1/cafos
Obtain dataset of CAFO locations and production amounts for the continental U.S.
nass_ag_residues¶
Request Template¶
GET https://biositing.jbei.org/api/v1/nass_ag_residues
Obtain dataset of sub-county point source estimates of agricultural residues in the continental U.S. downscaled from county-level data from the 2022 USDA NASS Census of Agriculture.
fats_oils_greases¶
Request Template¶
GET https://biositing.jbei.org/api/v1/fats_oils_greases
Obtain dataset of fats, oils, and greases estimates at the county level for the continental U.S.
rtr_geo_storage¶
Request Template¶
GET https://biositing.jbei.org/api/v1/rtr_geo_storage
Obtain dataset of geologic storage potential in the continental U.S. based on the Roads to Removal Report.
rcsp_saline_geo_storage¶
Request Template¶
GET https://biositing.jbei.org/api/v1/rcsp_saline_geo_storage
Obtain dataset of geologic storage potential in saline formations across the continental U.S. based on data from the Regional Carbon Sequestration Partnership.
usgs_coal_geo_storage¶
Request Template¶
GET https://biositing.jbei.org/api/v1/usgs_coal_geo_storage
Obtain dataset of geologic storage potential in coal formations across the continental U.S. based on data from the U.S. Geological Survey.
cejst_ej_indicators¶
Request Template¶
GET https://biositing.jbei.org/api/v1/cejst_ej_indicators
Obtain dataset of U.S. census tract level environmental justice indicators based on the Climate and Economic Justice Screening Tool.
grid_transmission_regions¶
Request Template¶
GET https://biositing.jbei.org/api/v1/grid_transmission_regions
Obtain dataset of simplified grid transmission regions based on the 2023 National Transmission Needs Study by U.S. Department of Energy.
site_buffer¶
Request Template¶
GET https://biositing.jbei.org/api/v1/site_buffer?latitude={LATITUDE}&longitude={LONGITUDE}&radius={RADIUS}
Obtain an inventory of bioeconomy resources (e.g. biomass, municipal solid waste, plastic waste etc.) within a defined buffer radius of a point location specified by latitude and longitude coordinates.
Required Parameters¶
The following query parameters must be specified in the GET request URI.
latitude
- Latitude coordinate of buffer zone centroid in in decimal degrees format
e.g.
39.44869283589919
longitude
- Longitude coordinate of buffer zone centroid in in decimal degrees format.
e.g.
-92.48419980931273
radius
- Radial distance (in kilometers) to define the buffer zone around the point
specified by
latitudeandlongitude
Optional Parameters¶
The following optional parameters may also be specified:
summarize=true
- Whether to return sum totals resource types
within the site buffer zone instead of returning individual point-level
resource estimates. Note: this is a fixed parameter for which the only
allowable value is
true.
Example Usage¶
GET https://biositing.jbei.org/api/v1/site_buffer?latitude=39.44869283589919&longitude=-92.48419980931273&radius=20