---
title: "HAPI metadata for a given dataset"
method: GET
path: "/hapi/info"
tags: ["HAPI"]
---

# HAPI metadata for a given dataset

`GET /hapi/info`

## 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/info`
- Auth: none declared
- TypeScript: <https://skmtc.dev/ucalgary/apis/ucalgary-space-remote-sensing-api/docs/hapi/info/get.ts> (a function with typed inputs; its response is checked against the schema)

Metadata about a given dataset, in the format described by section 3.6 of the
HAPI specification.

Notes:
  - the HAPI 2.x 'id' request parameter is supported as an alias of 'dataset'
  - supplying 'parameters' limits the response to a subset of the dataset's
    parameters (the time parameter is always included)

## Query parameters

- `dataset` string, nullable
- `parameters` string, nullable
- `resolve_references` string, nullable

## Response `200`

Dataset metadata

- HAPIInfo: Wire format of the /hapi/info response, for API documentation purposes. The endpoint builds its response dict directly (via build_info_dict()) since some keys are conditionally omitted, but this model reflects the full shape.
  - `HAPI` string, required
  - `description` string, required
  - `resourceURL` string, nullable
  - `contact` string, nullable
  - `datasetCitation` string, nullable
  - `x_dataUsage` string, nullable
  - `startDate` string, required
  - `stopDate` string, required
  - `cadence` string, required
  - `maxRequestDuration` string, nullable
  - `sampleStartDate` string, nullable
  - `sampleStopDate` string, nullable
  - `geoLocation` number[], nullable
  - `x_site_uid` string, nullable
  - `x_site_full_name` string, nullable
  - `x_descriptionLong` string, nullable
  - `parameters` object[], required
  - `status` HAPIStatus, required
    - `code` integer, required
    - `message` string, required

## 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)