List commonly used licenses | GitHub API (unofficial showcase)

3 parameters

featuredbooleanoptional

Whether to filter the results to featured licenses.

per_pageintegeroptional

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

Default:30

pageintegeroptional

Page number of results to retrieve. Defaults to 1 when omitted.

Default:1

2 status codes

200Returns an array of commonly used license objects, including each license's key, name, URL, SPDX identifier, and node ID.

keystringrequired

namestringrequired

urlstringrequired

spdx_idstringrequired

node_idstringrequired

html_urlstringoptional

304Returned when the response has not changed.

Error handling

featured accepts a boolean value. per_page can be at most 100; page defaults to 1 and per_page defaults to 30 when omitted.

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

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

const result = await client.licenses.list({
  featured: "example",
  perPage: 20,
  page: 1,
});

[
  {
    "key": "mit",
    "name": "MIT License",
    "spdx_id": "MIT",
    "url": "https://api.github.com/licenses/mit",
    "node_id": "MDc6TGljZW5zZW1pdA=="
  },
  {
    "key": "lgpl-3.0",
    "name": "GNU Lesser General Public License v3.0",
    "spdx_id": "LGPL-3.0",
    "url": "https://api.github.com/licenses/lgpl-3.0",
    "node_id": "MDc6TGljZW5zZW1pdA=="
  },
  {
    "key": "mpl-2.0",
    "name": "Mozilla Public License 2.0",
    "spdx_id": "MPL-2.0",
    "url": "https://api.github.com/licenses/mpl-2.0",
    "node_id": "MDc6TGljZW5zZW1pdA=="
  },
  {
    "key": "agpl-3.0",
    "name": "GNU Affero General Public License v3.0",
    "spdx_id": "AGPL-3.0",
    "url": "https://api.github.com/licenses/agpl-3.0",
    "node_id": "MDc6TGljZW5zZW1pdA=="
  },
  {
    "key": "unlicense",
    "name": "The Unlicense",
    "spdx_id": "Unlicense",
    "url": "https://api.github.com/licenses/unlicense",
    "node_id": "MDc6TGljZW5zZW1pdA=="
  },
  {
    "key": "apache-2.0",
    "name": "Apache License 2.0",
    "spdx_id": "Apache-2.0",
    "url": "https://api.github.com/licenses/apache-2.0",
    "node_id": "MDc6TGljZW5zZW1pdA=="
  },
  {
    "key": "gpl-3.0",
    "name": "GNU General Public License v3.0",
    "spdx_id": "GPL-3.0",
    "url": "https://api.github.com/licenses/gpl-3.0",
    "node_id": "MDc6TGljZW5zZW1pdA=="
  }
]

Request

Response

Errors