Get all repository topics | GitHub API (unofficial showcase)

4 parameters

ownerstringrequired

The account owner of the repository; the name is not case-sensitive.

repostringrequired

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

pageintegeroptional

The page number of results to retrieve. Defaults to 1 when omitted.

Default:1

per_pageintegeroptional

The number of results per page, up to 100. Defaults to 30 when omitted.

Default:30

2 status codes

200Returns an object containing the repository's topic names.

namesarray<string>required

404Returned when the repository cannot be found.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

Error handling

A 404 is returned when owner and repo do not identify an existing repository. Use page and per_page to paginate the results.

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

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

const result = await client.topics.list({
  owner: "octocat",
  repo: "hello-world",
  page: 1,
  perPage: 20,
});

{
  "names": [
    "octocat",
    "atom",
    "electron",
    "api"
  ]
}

Request

Response

Errors