---
title: "HAPI catalog of available datasets"
method: GET
path: "/hapi/catalog"
tags: ["HAPI"]
---

# HAPI catalog of available datasets

`GET /hapi/catalog`

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

The catalog of datasets available from this HAPI server, in the format described
by section 3.5 of the HAPI specification.

Notes:
  - supplying depth=all embeds the full info object for every dataset

## Query parameters

- `depth` string, nullable
- `resolve_references` string, nullable

## Response `200`

Dataset catalog

- HAPICatalog
  - `HAPI` string, required
  - `catalog` HAPICatalogDataset[], required
    - `id` string, required
    - `title` string, required
    - `info` object, nullable
  - `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)