---
title: "Retrieve list of URLs for a given dataset"
method: GET
path: "/api/v1/data_distribution/urls"
tags: ["Data Distribution"]
---

# Retrieve list of URLs for a given dataset

`GET /api/v1/data_distribution/urls`

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

Retrieve list of URLs for a given dataset and timeframe.

Notes:
  - start and end times are inclusive
  - start and end time format is YYYY-mm-ddTHH:MM:SS. Excluding values from the right to 
    the left result in default values being used (eg. YYYY-mm-ddTHH results in YYYY-mm-ddTHH:00:00)
  - dataset matching is case insensitive
  - site_uid is expected to be the 4-letter site code, and is case insensitive
  - device_uid is expected to be the instrument identifier such as "themis02", "rego-657", or "rgb-07",
    and is case insensitive

## Query parameters

- `name` string, required
- `start` string, date-time, required
- `end` string, date-time, required
- `site_uid` string, nullable
- `device_uid` string, nullable
- `include_total_bytes` boolean

## Response `200`

URLs

- FileListingResponse
  - `urls` string[], required
  - `path_prefix` string, required
  - `count` integer, required
  - `total_bytes` integer, nullable, required
  - `dataset` union, required
    - Dataset
      - `name` string, required
      - `short_description` string, required
      - `long_description` string, required
      - `data_tree_url` string, required
      - `file_listing_supported` boolean, required
      - `level` string, required
      - `doi` string, nullable
      - `doi_details` string, nullable
      - `citation` string, nullable
      - `supported_libraries` string[]
      - `file_time_resolution` '1min' | '1hr' | '1day' | 'not_applicable', required
    - DatasetLegacy1: Dataset object for queries from PyAuroraX v1.3.3 or earlier
      - `name` string, required
      - `short_description` string, required
      - `long_description` string, required
      - `data_tree_url` string, required
      - `file_listing_supported` boolean, required
      - `level` string, required
      - `doi` string, nullable
      - `doi_details` string, nullable
      - `citation` string, nullable
    - DatasetLegacy2: Dataset object for queries from PyAuroraX v1.3.3 or earlier
      - `name` string, required
      - `short_description` string, required
      - `long_description` string, required
      - `data_tree_url` string, required
      - `file_listing_supported` boolean, required
      - `level` string, required
      - `doi` string, nullable
      - `doi_details` string, nullable
      - `citation` string, nullable
      - `supported_libraries` string[]

## Other responses

- `400`: Invalid request
- `404`: Dataset not found
- `422`: Validation Error
- `500`: Data retrieval 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)