---
title: "HAPI data for a given dataset and timeframe"
method: GET
path: "/hapi/data"
tags: ["HAPI"]
---

# HAPI data for a given dataset and timeframe

`GET /hapi/data`

## Request

- Base URL: `https://api.phys.ucalgary.ca` (the document declares no server; this is the origin it was published from)
- URL: `https://api.phys.ucalgary.ca/hapi/data`
- Auth: none declared
- TypeScript: <https://skmtc.dev/ucalgary/apis/ucalgary-space-remote-sensing-api/docs/hapi/data/get.ts> (a function with typed inputs; its response is checked against the schema)

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

## Query parameters

- `dataset` string, nullable
- `start` string, nullable
- `stop` string, nullable
- `parameters` string, nullable
- `format` string, nullable
- `include` string, nullable

## Response `200`

Dataset data

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/ucalgary/apis/ucalgary-space-remote-sensing-api.md) - [All operations](https://skmtc.dev/ucalgary/apis/ucalgary-space-remote-sensing-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ucalgary/apis/ucalgary-space-remote-sensing-api/revisions/e451a425b5eb?raw)