v1

latestOpenAPI 3.0.1OGL 32026-07-232225170.8 KB
id

List of all monitoring stations can be filtered by name, location and other parameters.

get/id/stations

Query parameters

{"stackTrail":"paths:/id/stations:get:parameters:0:schema","oasType":"schema","type":"unknown"}

Identifier for the station, as used by River Levels On the Internet.

{"stackTrail":"paths:/id/stations:get:parameters:1:schema","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/id/stations:get:parameters:2:schema","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/id/stations:get:parameters:3:schema","oasType":"schema","type":"unknown"}

Area of the catchment related to this sampling point in km^2

{"stackTrail":"paths:/id/stations:get:parameters:4:schema","oasType":"schema","type":"unknown"}

The name of the river catchment which this site is related to, if any

{"stackTrail":"paths:/id/stations:get:parameters:5:schema","oasType":"schema","type":"unknown"}

Link to a station at same location (same SUID)

{"stackTrail":"paths:/id/stations:get:parameters:6:schema","oasType":"schema","type":"unknown"}

Provides some explanation of the data quality statement of the station.

{"stackTrail":"paths:/id/stations:get:parameters:7:schema","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/id/stations:get:parameters:8:schema","oasType":"schema","type":"unknown"}

The date on which the station closed

{"stackTrail":"paths:/id/stations:get:parameters:9:schema","oasType":"schema","type":"unknown"}

The date on which the station opened

{"stackTrail":"paths:/id/stations:get:parameters:10:schema","oasType":"schema","type":"unknown"}

The datum level for the measurement point on OS datum

eastingstring
{"stackTrail":"paths:/id/stations:get:parameters:12:schema","oasType":"schema","type":"unknown"}

A name for the item

latstring
longstring
{"stackTrail":"paths:/id/stations:get:parameters:15:schema","oasType":"schema","type":"unknown"}

The set of measurement types available from the station

{"stackTrail":"paths:/id/stations:get:parameters:16:schema","oasType":"schema","type":"unknown"}

Short, cannonical, name of the quantity being measured e.g. "level", "flow" or "temperature".

{"stackTrail":"paths:/id/stations:get:parameters:17:schema","oasType":"schema","type":"unknown"}

The period between successive readings, in seconds.

{"stackTrail":"paths:/id/stations:get:parameters:18:schema","oasType":"schema","type":"unknown"}

Indicates whether the values in a time series represent mean, min, max, instananteous or other statistics over the measurement interval.

northingstring
{"stackTrail":"paths:/id/stations:get:parameters:20:schema","oasType":"schema","type":"unknown"}

A string or other literal which uniquely identifies the item.

{"stackTrail":"paths:/id/stations:get:parameters:21:schema","oasType":"schema","type":"unknown"}

ID of corresponding station in NRFA

{"stackTrail":"paths:/id/stations:get:parameters:22:schema","oasType":"schema","type":"unknown"}

URL for corresponding station in NRFA

{"stackTrail":"paths:/id/stations:get:parameters:23:schema","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/id/stations:get:parameters:24:schema","oasType":"schema","type":"unknown"}

Name of river, or other water body, associated with this monitoring station (when available)

{"stackTrail":"paths:/id/stations:get:parameters:25:schema","oasType":"schema","type":"unknown"}

URL for information on this station from River Levels On the Internet service

{"stackTrail":"paths:/id/stations:get:parameters:26:schema","oasType":"schema","type":"unknown"}

A larger feature which sampling point measures, samples or represents

{"stackTrail":"paths:/id/stations:get:parameters:27:schema","oasType":"schema","type":"unknown"}

A name for the item

{"stackTrail":"paths:/id/stations:get:parameters:28:schema","oasType":"schema","type":"unknown"}

Station UID, may differ from notation if SUID was ambiguous

{"stackTrail":"paths:/id/stations:get:parameters:29:schema","oasType":"schema","type":"unknown"}

Identifier for the telemetry feed used by the Environment Agency's National Flood Forecasting System

{"stackTrail":"paths:/id/stations:get:parameters:30:schema","oasType":"schema","type":"unknown"}

Indicates whether a station is active, suspended or closed

{"stackTrail":"paths:/id/stations:get:parameters:31:schema","oasType":"schema","type":"unknown"}

A name for the item

{"stackTrail":"paths:/id/stations:get:parameters:32:schema","oasType":"schema","type":"unknown"}

Provides some explanation of the status or change in status of the station.

{"stackTrail":"paths:/id/stations:get:parameters:33:schema","oasType":"schema","type":"unknown"}

Name of the nearest town (or named place) to the station

{"stackTrail":"paths:/id/stations:get:parameters:34:schema","oasType":"schema","type":"unknown"}

The class, or classes, of this item

{"stackTrail":"paths:/id/stations:get:parameters:35:schema","oasType":"schema","type":"unknown"}

Identifier for the station in the WISKI hydrology dataset

_projectionstring

Lets you return a subset of properties that are specified by the endpoint view. All the properties returned by an endpoint are defined in the model below.

distnumber

Should be used in combination with "lat" and "long": lat={x}&long={y}&dist={d}, or "easting" and "northing": easting={x}&northing={y}&dist={d}

eastingnumber

Should be used in combination with "northing" and "dist": easting={x}&northing={y}&dist={d}

latnumber

Should be used in combination with "long" and "dist": lat={x}&long={y}&dist={d}

longnumber

Should be used in combination with "lat" and "dist": lat={x}&long={y}&dist={d}

northingnumber

Should be used in combination with "easting" and "dist": easting={x}&northing={y}&dist={d}

_limitinteger

Return only a given number of items from the list, some endpoints may impose a default limit and/or a maximum to which the limit can be set. In particular, sampling points, samples and measurements default to a soft limit of 50 items but that can be overridden.

_offsetinteger

Return the list of items starting with the xth item, together with _limit this enables paging through a long set of results. Though it often cheaper to simply return all that you want in one go or to use filters to reduce the list to a subset of interest.

searchstring

Will filter the list for only those whose label or comment fields contain a matching word. The search keywords will be filtered to remove punctuation characters meaningful to the underlying search engine, so only plain alphanumeric keywords can be reliably used as search terms.

_sortstring

Reorder the list of returned results by the value of the named property of the results. Use -{property} to sort in descending instead of ascending order. Multiple sort parameters can be given.

Response

Success