time data api

time-data-api 0.1

time-data-api is a specification for APIs providing non-spatial time-series data. APIs that conform to this specification will be supported by TerriaJS (and hence the National Map).

Document Status: Under development. This document will evolve.

APIs that conform to this specification understand and respond to the query parameters described below, at the endpoints corresponding to individual datasets.

Example

www.example.com/time-data-api/1.0/ABC?start=2016-01-01T00:00:00&frequency=12h&format=csv

time,temperature,pressure
2016-01-01T00:00:00,16,101.1
2016-01-01T12:00:00,22,103.2
2016-01-02T00:00:00,18,102.3
2016-01-02T12:00:00,26,102.6

www.example.com/time-data-api/1.0/ABC?description

{
    "supportedFormats": ["json","csv","xml"],
    "start": "2010-01-01T00:00:00",
    "end": "2016-02-03T17:00:00",
    "frequency": "5m",
    "columnNames": ["time","temperature","pressure"],
    "timeColumnIndex": 0,
    "timeFormat": "ISO8601",
    "supportedFrequencies": ["5m","10m","15m",...,"h","D","M","Y"],
    "supportedTransforms": ["min","max","mean","single"]
}