Download a repository ZIP archive | GitHub API (unofficial showcase)

3 parameters

ownerstringrequired

The account that owns the repository; the name is not case-sensitive.

repostringrequired

The repository name without the `.git` extension; the name is not case-sensitive.

refstringrequired

The branch, tag, or commit to archive. Defaults to the repository’s default branch when omitted.

1 status code

302Redirects to a URL for downloading the repository ZIP archive. Follow the redirect or use the `Location` header to make a second GET request.

Error handling

Use the owner path parameter and repo path parameter to identify the repository, and the ref path parameter to select the revision. If you omit ref, the repository’s default branch is used; links for private repositories expire after five minutes.

import { Client } from "@octridev/github";

const client = new Client({
  baseUrl: "https://api.github.com",
});

const result = await client.zipball.get({
  owner: "octocat",
  repo: "hello-world",
  ref: "main",
});

Request

Response

Errors