API endpoint examples

Overview

An API endpoint is a particular URL that implements a data query function. Additional arguments can be added to each query function to filter the returned data records, to specify the returned data fields, and to determine the format of the returned data.

These endpoint examples, or 'use cases', offer solutions to frequent requests that we receive for our data.  They can be seen as starting points for more complex solutions.

The solutions to each use case contain a URL that can be copied into an internet browser address bar to demonstrate the output from the query.

Specific examples are provided of queries regarding stations, parameters, and time series. The titles of these pages reflects the nature of use cases addressed rather than the API function type so, for example, Time series functions appear within the Station section as they are useful to recover certain information associated with each station.