Water Atlas API Docs

Introduction

Sample output for some APIs may not be available, incomplete or inaccurate in the documentation below. To get sample outputs or to try out the APIs available, please use the API Sandbox.

List of all Available APIs.

AppPages

API to get content for Dynamic pages

API	Description
GET AppPages/{appId}/Content/{pageId}?siteId={siteId}	Returns Page Content for SPA driven by the CMS
GET AppPages/{appId}?siteId={siteId}	Returns All pages Content

Basins

Basin details and params.

API	Description
GET basins/{id}/Photos?s={s}&random={random}&limit={limit}	Get Photos for a basin
GET basins/{id}/RelatedLinks?s={s}&showAll={showAll}	This API returns Related Links according to the category name
GET basins/{id}/Announcements?s={s}	This API returns waterbody News Article details
GET basins/{id}/GeographyLandUse?s={s}	No documentation available.
GET basins/GetGroundwaterQuantityARI?numYears={numYears}	Returns ARI Data

Bay Conditions

API to get Bay Conditions data

API	Description
GET BayConditions/Reports/Years?siteId={siteId}	No documentation available.
GET BayConditions/Reports/{year}?siteId={siteId}	No documentation available.
GET BayConditions/Reports/All/{reportId}?siteId={siteId}	No documentation available.

Biological Assessments

Endpoints for Biological Assessments data

API	Description
GET biological-assessments/lvi/{id}	Get details about a Lake Vegetation Index (LVI) assessment
GET biological-assessments/sci/{id}	Get details about a Stream Condition Index (SCI) assessment

CoastalWaterQualityConcerns

Geo JSon API for water quality Concerns

API	Description
GET CoastalWaterQualityConcerns?s={s}&param={param}	Returns Coastal WaterQuality latest sampling events and locations as a GeoJSON Object
GET CoastalWaterQualityConcerns/historic?datasource={datasource}&stationId={stationId}&param={param}&s={s}	Returns Historic Coastal Water Quality Smapling Data for a Station/location
GET CoastalWaterQualityConcerns/PublicNoticesOfPollution	No documentation available.

Contour Mapping

Water Atlas contour mapping API endpoints for supported Atlases (sites)

API	Description
GET ContourMapping/Parameters/{siteId}	Returns a list of contour parameters for the specified Atlas/site
GET ContourMapping/Years/{siteId}	Returns a list of years for which contour mapping reports (and images) are available for the specified Atlas/site
GET ContourMapping/ParameterImages/{siteId}/{contourParamterShortName}/{year}	Returns contour parameter information and image URLs for the specified Atlas/site, parameter, and year.

Creek Conditions

API to get Creek Conditions data

API	Description
GET CreekConditions/Report/{reportId}/Indicator/{indicatorId}/stations	No documentation available.

Data Mapper

Datamapper details

API	Description
GET DataMapper/Stations/All	No documentation available.
GET DataMapper/Stations/All/Refresh	No documentation available.
GET DataMapper/Stations/All/Minimized	No documentation available.
GET DataMapper/Agency/{datasource}/Station/{stationId}	Returns the station details
GET DataMapper/Agency/{datasource}/Station/{stationId}/LatestData	Returns the latest data for the selected station
GET DataMapper/Agency/{datasource}/Station/{stationId}/Parameter/{parameter}/GraphData?numberOfDays={numberOfDays}&endDate={endDate}	Returns the last X days of data for the selected station and parameter. A null endDate will return the last X days of data from the last sample date on record.
GET DataMapper/Agency/{datasource}/Station/{stationId}/Hydrology/LatestData	Returns the latest data for the selected station
GET DataMapper/Agency/{datasource}/Station/{stationId}/Hydrology/Flow/GraphData?numberOfDays={numberOfDays}	Returns the last X days of data for the selected station.
GET DataMapper/Agency/{datasource}/Station/{stationId}/Hydrology/Levels/GraphData?numberOfDays={numberOfDays}	Returns the last X days of levels data for the selected station.

DataDownload

Data Download Methods

API	Description
GET datadownload/request/{id}	Gets the data download request by its ID.
GET datadownload/list?id={id}	Get Stations information for a ID generated previously.
POST datadownload/list	Get Stations information for a list of stations.
POST datadownload/update	Updates an existing data download request
GET datadownload/graph?requestId={requestId}&parameterId={parameterId}	Returns graphing data for a specific request/parameter combination
POST datadownload/create	Create a data download request
POST datadownload/{id}/Execute	Queues a given request for execution

DataMapper

Datamapper details

API	Description
GET DataMapper/datamapper/get_samples?dataSource={dataSource}&stationId={stationId}&status={status}	Get the latest sample data for the selected station

Library

Digital Library Search

API	Description
GET library/search?q={q}&s={s}&wbodyid={wbodyid}&wshedid={wshedid}&sType={sType}&rType={rType}&start={start}&length={length}&sortCol={sortCol}&sortDir={sortDir}	Library search query (paged) Example GET: /library/search?q=History
GET library/photos?s={s}&q={q}&sortDir={sortDir}&sortCol={sortCol}&filterType={filterType}&pageLen={pageLen}&pageNum={pageNum}	Get photos library

Metadata

Meta Data of Datasource and station

API	Description
GET DataSource/{id}?s={s}	DataSource Meta Data
GET DataSource/{id}/Station/{stationId}?s={s}	Station Metadata

Rainfall

Realtime Rainfall Data

API	Description
GET rainfall/latest?s={s}	Get the latest rainfall information 24 h ,7 day and 30 day totals for each site id
GET rainfall/estimates/overview/{geographyLevel}?s={s}&val={val}	Returns the rainfall overview for a geography level
GET rainfall/estimates/monthly/{geographyLevel}?s={s}&val={val}	Gets the monthly average rainfall data
GET rainfall/estimates/annual/{geographyLevel}?s={s}&val={val}	Gets the annual rainfall data for all the years up untill the current year
GET rainfall/estimates/singleyear/{geographyLevel}?s={s}&year={year}&val={val}	Gets the rainfall data for the entire year, monthwise.
GET rainfall/actual/overview?s={s}	Returns the actual rainfall (per SWFWMD) overview for a site/atlas
GET rainfall/actual/monthly?s={s}	Gets the actual monthly average rainfall data (per SWFWMD)
GET rainfall/actual/annual?s={s}	Gets the actual annual rainfall data (per SWFWMD) for all the years up until the current year
GET rainfall/actual/singleyear?s={s}&year={year}	Gets the actual rainfall data (per SWFWMD) for the entire year, month-wise.

Search

Search the Water Atlas.

API	Description
GET search/waterbodies?s={s}&q={q}&type={type}&sortDir={sortDir}&sortCol={sortCol}&pageLen={pageLen}&pageNum={pageNum}	Search Water body Details
GET Search?q={q}&s={s}	Search for Pages and Sections of the Water Atlas.

Water Clarity Report

Water Clarity Reports

API	Description
GET WaterClarity?siteID={siteID}	Get Water Clarity Reports Data

Water Quality Hotspots

Water Quality Trends

API	Description
GET WQHotspots?siteID={siteID}&param={param}&year={year}	Get Water Quality Trends.

Water Quality Trends

API	Description
GET WQTrends/Results?siteID={siteID}	Get Water Quality Trends Raw Data.
GET WQTrends?siteID={siteID}&datasource={datasource}&param={param}&por={por}	Get Water Quality Trends.
GET WQLocationTrends?siteID={siteID}&param={param}&por={por}	Get Water Quality Location Trends.
GET WQTrends/Params?siteID={siteID}	Get a list of all available Parameters which are supported by Water Quality Trends. If siteID is provided, returns parameters specific to that site.
GET WQTrends/Datasources?siteID={siteID}	Get a list of all Datasources which have Water Quality Trends available.
GET WQTrends/Stations?siteID={siteID}	Get a list of all Sampling Locations which have Water Quality Trends available.

Waterbodies

Waterbody details and params.

API	Description
GET waterbodies/{id}/core-details?s={s}	Get core information about a Waterbody for a given waterbody id.
GET waterbodies/{id}/details?s={s}	Get the Waterbody details for a given waterbody id.
GET waterbodies/{id}/WaterQuality?s={s}	Get the Water Quality Parameter details and Digital library links for a Waterbody.
GET waterbodies/{id}/LevelsFlows?s={s}	Get the Water Levels data and Digital library links for a Waterbody.
GET waterbodies/{id}/Hydrology/Stations	No documentation available.
GET waterbodies/{id}/Ecology?s={s}	Get the Habitat/Ecology data and Digital library links for a Waterbody.
GET waterbodies/{id}/Photos?s={s}&t={t}&random={random}&limit={limit}	Get Photos for a water body
GET waterbodies/{id}/RelatedLinks?s={s}&showAll={showAll}	Returns Related Links according to the category name
GET waterbodies/{id}/Announcements?s={s}	This API returns waterbody News Article details
GET waterbodies/bay/{id}/details?s={s}	This API returns waterbody bay details
GET waterbodies/river/{id}/details?s={s}	This API returns waterbody river details
GET waterbodies/lake/{id}/details?s={s}	This API returns waterbody river details
GET waterbodies/closest?lat={lat}&lng={lng}&accuracy={accuracy}&len={len}&s={s}	Returns the list of 20 waterbodies closest to the queried location.