1. Home

Back to Home

API documentation

SEPA's time series hydrometric data and the associated metadata may be retrieved via an API accessed using structured HTTP requests.

This API documentation is provided to augment and expand the built-in documentation, and is divided into four sections:

  1. A description and explanation of the data that can be accessed using the API: read Before you start
  2. Reference documentation describing how data requests are constructed and all of the options within them - this includes a quick-start walk-through of exploring and returning time series data
  3. Example data requests (endpoints)
  4. Information on how to register for an access key if needed, and how to use it. Note, access keys are only required accessing large amounts of data over short periods. Using keys is complicated and we recommend that users try to access the data they need without using a key.