# Search for a waterbody

GET: /waterbody/{search}/{format}

POST: /waterbody

Search for a waterbody using search terms.

Parameters:

Return:

If no results are found, response will be of 404 status with message of no results found.

[
  {
    "wid": 31,
    "name": "Central Bay"
  },
  {
    "wid": 156,
    "name": "Lower South Bay"
  },
  {
    "wid": 192,
    "name": "Richardson Bay"
  },
  {
    "wid": 207,
    "name": "San Pablo Bay"
  },
  {
    "wid": 222,
    "name": "South Bay"
  },
  {
    "wid": 229,
    "name": "Suisun Bay"
  }
]

# Waterbody info

GET: /waterbody/{wid}/format

GET: /waterbody/{wid}/info/format

POST: /waterbody/info

Get the information of a waterbody.

Parameters:

Return:

If no waterbody is found for the given waterbody ID, response will be of 404 status with not found message.

{
  "wid": 53,
  "name": "Echo Lake, Upper and Lower", 
  "waterboardregion": 6, 
  "type": "Lake Perennial", 
  "usetype": "Limited", 
  "watertype": "Lake"
}

# Waterbody name

GET: /waterbody/{wid}/name/format

POST: /waterbody/name

Rerouted to waterbody info request. Deprecated but left in for backwards compatibility.

# Waterbody geometry

GET: /waterbody/{wid}/{format}

POST: /waterbody/{format}

Get the geometry of a waterbody. For it to be recognized as a geometry request, the format must be one of: geom, geometry, geojson, or kml.

Parameters:

Return:

Depending on the request format, returns GeoJSON formatted data or a KML file. If in GeoJSON format, of which some, but not necessarily all, of the main properties are listed below.

If no waterbody is found for the given waterbody ID, response will be of 404 status with not found message.

{
  "type": "MultiPolygon", 
  "crs": {
    "type": "name",
    "properties": {
      "name": "EPSG:32611"
    }
  },
  "coordinates": [[[
    [232502.646463832, 4304753.87],
    [232788.41678906, 4304753.76],
    [232802.646967078, 4304753.82],
    [232807.390391706, 4304753.84],
    /* ... */
  ]]]
}

# Single-date statistics on waterbody

GET: /{product}/{composite}/{wid}/{date}/{valuetype}/{stats}/{format}

POST: /{product} *

*POST requests to this endpoint will be interpreted based on the parameters supplied. Depending on which, the request may alternatively be interpreted as a date-span statistics request, raster request or pixel-value request.

Get the single-date, zonal waterbody statistics for the given product, composite, waterbody, and date.

Parameters:

Return:

{
  "date": "2021-09-01",
  "pixel_count": 1492,
  "min": 16.65,
  "max": 134.6,
  "mean": 95.25,
  "median": 98.49,
  "perc90": 134.6
}

# Date span statistics on waterbody

GET: /{product}/{composite}/{wid}/{datefrom}/{datetill}/{valuetype}/{stats}/format

POST: /{product} *

*POST requests to this endpoint will be interpreted based on the parameters supplied. Depending on which, the request may alternatively be interpreted as a single-date statistics request, raster request or pixel-value request.

Get the multi-date, zonal waterbody statistics for the given product, composite, waterbody, and date span.

Parameters:

Return:

[
  {
    "date": "2021-09-01",
    "pixel_count": 1767,
    "min": 0.9972436372799999,
    "max": 870.9152991480801,
    "mean": 136.66402495666,
    "median": 148.48021460236,
    "perc90": 448.60144272938
  },
  {
    "date": "2021-09-02",
    "pixel_count": 1770,
    "min": 0.9972436372799999,
    "max": 895.3250088022401,
    "mean": 152.64176591190002,
    "median": 148.48021460236,
    "perc90": 448.60144272938
  },
  {
    "date": "2021-09-03",
    "pixel_count": 1771,
    "min": 0.9972436372799999,
    "max": 895.3250088022401,
    "mean": 170.48752109134,
    "median": 152.64176591190002,
    "perc90": 461.17470049708
  },
  {
    "date": "2021-09-04",
    "pixel_count": 1767,
    "min": 0.9972436372799999,
    "max": 895.3250088022401,
    "mean": 170.48752109134,
    "median": 152.64176591190002,
    "perc90": 448.60144272938
  },
  {
    "date": "2021-09-05",
    "pixel_count": 1772,
    "min": 0.9972436372799999,
    "max": 999.9998235943,
    "mean": 175.26588535556,
    "median": 156.91995944984,
    "perc90": 461.17470049708
  }
]

# Raster information

GET: /{product}/{composite}/{date}/info

POST: /{product}/info

Get information about available raster(s) for given product, composite, and date.

Parameters:

Return:

{
  "sensor": "OLCI",
  "platform": [
    "sentinel-3a",
    "sentinel-3b"
  ],
  "product": "cicyano",
  "composite": "mosaic",
  "datestr": "20200609",
  "rasters": [
    "sentinel-3a.2020161.0609.L3.CA_mosaic.v950V20193_1_2.CIcyano.tif",
    "sentinel-3b.2020161.0609.L3.CA_mosaic.v950V20193_1_2.CIcyano.tif"
  ]
}

# Single date raster(s)

GET: /{product}/{composite}/{date}/{format}

POST: /{product} *

*POST requests to this endpoint will be interpreted based on the parameters supplied. Depending on which, the request may alternatively be interpreted as a single-date statistics request, date-span statistics request, or pixel-value request.

Get the raster(s) for given product, composite, and date. Currently only the tiff format is supported.

Parameters:

Return:

The raster or rasters will be return in the format provided. If multiple rasters are returned, the file will be served as a zip file. Multiple files may result for mosaic products requests if overflights from both Sentinel-3A and Sentinel-3B are present.

Mosaic rasters are provided in the filename format:

Composite rasters are provided in the filename format:

Composite rasters will have a date span indicating the start and end dates of the composite window (inclusive). The requested date will correspond to the end date of this window.

Rasters are provided with a color table for symbology. Pixel values are 0-255 and map to the values as indicated in the pixel values table.

Example:

GET: https://fhab-api.sfei.org/chlorophyll/1daymax/20220826/tif

Get the raster on the date August 26th, 2022 for the chlorophyll product using the 1-day pixel maximum composite.

Results:

ts.20220826_20220826.L4.CA_mosaic.chl_gil_rhos.MAX_1day.tif

# Monthly rasters

GET: /{product}/{composite}/{month}/{format}

POST: /{product} *

*POST requests to this endpoint will be interpreted based on the parameters supplied. Depending on which, the request may alternatively be interpreted as a single-date statistics request, date-span statistics request, or pixel-value request.

Get the raster for given product, composite, and date. Currently only the tiff format is supported.

Parameters:

Return:

Results will be provided as a zipfile with all rasters contained in the format provided. Zipfiles will be in the filename format:

Mosaic rasters are provided in the filename format:

Composite rasters are provided in the filename format:

Rasters are provided with a color table for symbology. Pixel values are 0-255 and map to the values as indicated in the pixel values table.

# Single date raster(s) clipped to waterbody

GET: /{product}/{composite}/{date}/{wid}/{format}

POST: /{product} *

*POST requests to this endpoint will be interpreted based on the parameters supplied. Depending on which, the request may alternatively be interpreted as a single-date statistics request, date-span statistics request, or pixel-value request.

Get the raster(s) for given product, composite, and date. Currently only the tiff format is supported.

Parameters:

Return:

The raster will be return in the format provided. If multiple rasters are returned, the file will be served as a zip file. Multiple files may result for mosaic products requests if overflights from both Sentinel-3A and Sentinel-3B are present.

Mosaic rasters are provided in the filename format:

Composite rasters are provided in the filename format:

Composite rasters will have a date span indicating the start and end dates of the composite window (inclusive). The requested date will correspond to the end date of this window.

Rasters are provided with a color table for symbology. Pixel values are 0-255 and map to the values as indicated in the pixel values table.

# Pixel value

GET: /{product}/{composite}/{date}/lon/{longitude}/lat/{latitude}/format

GET: /{product}/{composite}/{date}/lat/{latitude}/lon/{longitude}/format

POST: /{product} *

*POST requests to this endpoint will be interpreted based on the parameters supplied. Depending on which, the request may alternatively be interpreted as a single-date statistics request, date-span statistics request, or raster request.

Get pixel value at a specific longitude and latitude for the given product, composite, and date.

Parameters:

Return:

[
  {
    "platform": "sentinel-3b",
    "raw": 220,
    "ci": 0.027609365,
    "ci_modified": 436.3709835107,
    "pixel": [-122.839181,39.054876,-122.835509,39.057392]
  },
  {
    "platform":"sentinel-3a",
    "raw": 255,
    "ci": null,
    "ci_modified": null,
    "pixel": [-122.839181,39.054876,-122.835509,39.057392]
  }
]

# Pixel value histogram

GET: /{product}/{composite}/{wid}/{date}/histogram/{valuetype}/{format}

POST: /{product}/histogram

Get histogram of pixel values for the given product, composite, waterbody, and date.

Parameters:

Return:

Note that if raw pixel values are returned, high counts for the value 252 may result. This value is the no-data value for land (see pixel values table) and almost always captured as waterbody boundaries are given a two-pixel buffer so as not to potentially exclude any valid pixels. Most of the time, however, it is simply counting pixels in the land mask.

Otherwise (for returns in cyano index, modified cyano index, or chlorophyll), no-data pixels are excluded from the returned data.

[
  {
    "value": 0,
    "count": 1112
  },
  /* ... */
  {
    "value": 245,
    "count": 1
  },
  {
    "value": 246,
    "count": 1
  },
  {
    "value": 247,
    "count": 0
  },
  {
    "value": 248,
    "count": 0
  },
  {
    "value": 249,
    "count": 1
  },
  {
    "value": 250,
    "count": 3
  },
  {
    "value": 251,
    "count": 0
  },
  {
    "value": 252,
    "count": 770
  },
  {
    "value": 253,
    "count": 0
  },
  {
    "value": 254,
    "count": 0
  },
  {
    "value": 255,
    "count": 90
  }
]

# Composite

The type of data composite. 1-day and 10-day pixel-max composites are created by compiling all available images over the 1-day and 10-day period and using the maximum observed value at each pixel location in the composite image. Note: 1-day composites have only been processed for the OLCI imagery (those data starting in 2016 onward). It is not currently available for the MERIS datasets.

# Platform

The satellite platform which made the observation. Which platform was available depends on the date of the request being made. Note: There exists a significant data gap between 2012 and 2016, after contact was lost with Envisat and before Sentinel-3A become operational.

# Product

The data product type, which at current is either cyano index or chlorophyll. Note: Chlorophyll products have only been processed for the OLCI imagery (those data starting in 2016 onward). It is not currently available for the MERIS datasets.

# Statistic

The statistical measure. Supported types listed below. In most use cases, multiple types may be provided, separated by commas.

# Value type

The units for the return data. Note that some units are only applicable to a specific product type.