HAPI Server Documentation

This server supports the HAPI 3.2 API specification for delivery of time series data. The server responds to GET requests to the following HAPI endpoints:

/capabilities : list the API version and output options

/about : list the server ID, title, and contact information

/catalog : list the datasets that are available

---

Dataset Information

/info : list information about parameters in a dataset, e.g.:

./hapi/info?dataset=esk/PT1M/original

./hapi/info?dataset=esk/PT1M/xyz

./hapi/info?dataset=esk/PT1M/hdz

./hapi/info?dataset=esk/PT3H/k

---

Fetching Data

/data : stream data for parameters in a dataset. Examples for Eskdalemuir (ESK):

./hapi/data?dataset=esk/PT1M/original&format=csv&start=2020-01-01T00:00:00Z&stop=2020-01-02T00:00:00Z

./hapi/data?dataset=esk/PT1M/original&format=json&start=2020-01-01T00:00:00Z&stop=2020-01-02T00:00:00Z

---

Data Request Limits

Data requests are limited in size to: