HAPI

HAPI data for a given dataset and timeframe

Data for a given dataset and timeframe, in the format described by section 3.7 of the HAPI specification.

Notes:

  • the HAPI 2.x 'id', 'time.min', and 'time.max' request parameters are supported as aliases of 'dataset', 'start', and 'stop'
  • start and stop times use the HAPI restricted ISO 8601 format, and the timeframe is start-inclusive and stop-exclusive
  • supplying 'parameters' limits the response to a subset of the dataset's parameters (the time parameter is always included)
  • the supported output formats are csv (the default), binary, and json; binary is recommended for the large HSR datasets
  • supplying include=header prepends the dataset's info metadata as '#'-prefixed lines of JSON (csv and binary formats; the json format always includes it)
  • the response is streamed one day of data at a time, so multi-day requests do not have to buffer in memory on either side
get/hapi/data

Request

Query parameters

datasetstring nullable
startstring nullable
stopstring nullable
parametersstring nullable
formatstring nullable
includestring nullable

Response

Dataset data

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.