# @octokit/plugin-rest-endpoint-methods

> Octokit plugin adding one method for all of api.github.com REST API endpoints

Latest version **18.0.0** (published 2026-08-01) · MIT license · 0 weekly downloads

## Install

```sh
npm install @octokit/plugin-rest-endpoint-methods
pnpm add @octokit/plugin-rest-endpoint-methods
yarn add @octokit/plugin-rest-endpoint-methods
bun add @octokit/plugin-rest-endpoint-methods
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 18.0.0 |
| Published | 2026-08-01 |
| First published | 2019-11-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Node | >= 20 |
| Dependencies | 1 |
| Unpacked size | 1.4 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 135 |
| Author | Gregor Martynus |
| Maintainers | octokitbot, gr2m, wolfy1339 |
| Keywords | github, api, sdk, toolkit |

## Links

- npm: https://www.npmjs.com/package/@octokit/plugin-rest-endpoint-methods
- Repository: https://github.com/octokit/plugin-rest-endpoint-methods.js
- Homepage: https://github.com/octokit/plugin-rest-endpoint-methods.js#readme
- Issues: https://github.com/octokit/plugin-rest-endpoint-methods.js/issues
- npm.io page: https://npm.io/package/@octokit/plugin-rest-endpoint-methods

## Dependencies (1)

- [@octokit/types](https://npm.io/package/@octokit/types.md) ^17.0.0

## Alternatives

- [lodash.assign](https://npm.io/package/lodash.assign.md) — 2.3M weekly downloads
- [lodash.chunk](https://npm.io/package/lodash.chunk.md) — 1.8M weekly downloads
- [react-native-ios-utilities](https://npm.io/package/react-native-ios-utilities.md) — 138.5K weekly downloads
- [@technically/lodash](https://npm.io/package/@technically/lodash.md) — 50.9K weekly downloads
- [@fluid-topics/ft-icon](https://npm.io/package/@fluid-topics/ft-icon.md) — 20.6K weekly downloads

## Recent versions

- 18.0.0 (latest) — 2026-08-01
- 13.5.0 (release-13.x) — 2025-03-18
- 13.3.2-cjs.1 (cjs) — 2025-02-26
- 10.4.1 (release-10.x) — 2024-03-01
- 8.0.0-beta.3 (beta) — 2023-06-20
- 7.2.3 (release-7.x) — 2023-06-14
- 6.8.1 (release-6.x) — 2023-01-21
- 5.16.2 (release-5.x) — 2022-07-05
- 4.15.1 (release-4.x) — 2021-04-21
- 2.4.1 (release-2.x) — 2020-10-07
- 3.9.0 (release-3.x) — 2020-05-05
- 17.0.0 — 2025-10-31
- 16.1.1 — 2025-10-20
- 16.1.0 — 2025-09-16
- 16.0.0 — 2025-05-25
- … 198 more at https://npm.io/package/@octokit/plugin-rest-endpoint-methods/versions

## README

# plugin-rest-endpoint-methods.js

> Octokit plugin adding one method for all of api.github.com REST API endpoints

[![@latest](https://img.shields.io/npm/v/@octokit/plugin-rest-endpoint-methods.svg)](https://www.npmjs.com/package/@octokit/plugin-rest-endpoint-methods)
[![Build Status](https://github.com/octokit/plugin-rest-endpoint-methods.js/workflows/Test/badge.svg)](https://github.com/octokit/plugin-rest-endpoint-methods.js/actions?workflow=Test)

## Usage

<table>
<tbody valign=top align=left>
<tr><th>
Browsers
</th><td width=100%>

Load `@octokit/plugin-rest-endpoint-methods` and [`@octokit/core`](https://github.com/octokit/core.js) (or core-compatible module) directly from [esm.sh](https://esm.sh)

```html
<script type="module">
  import { Octokit } from "https://esm.sh/@octokit/core";
  import { restEndpointMethods } from "https://esm.sh/@octokit/plugin-rest-endpoint-methods";
</script>
```

</td></tr>
<tr><th>
Node
</th><td>

Install with `npm install @octokit/core @octokit/plugin-rest-endpoint-methods`. Optionally replace `@octokit/core` with a compatible module

```js
import { Octokit } from "@octokit/core";
import { restEndpointMethods } from "@octokit/plugin-rest-endpoint-methods";
```

</td></tr>
</tbody>
</table>

```js
const MyOctokit = Octokit.plugin(restEndpointMethods);
const octokit = new MyOctokit({ auth: "secret123" });

// https://developer.github.com/v3/users/#get-the-authenticated-user
octokit.rest.users.getAuthenticated();
```

There is one method for each REST API endpoint documented at [https://developer.github.com/v3](https://developer.github.com/v3). All endpoint methods are documented in the [docs/](docs/) folder, e.g. [docs/users/getAuthenticated.md](docs/users/getAuthenticated.md)

## TypeScript

> [!IMPORTANT]
> As we use [conditional exports](https://nodejs.org/api/packages.html#conditional-exports), you will need to adapt your `tsconfig.json` by setting `"moduleResolution": "node16", "module": "node16"`.
>
> See the TypeScript docs on [package.json "exports"](https://www.typescriptlang.org/docs/handbook/modules/reference.html#packagejson-exports).<br>
> See this [helpful guide on transitioning to ESM](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c) from [@sindresorhus](https://github.com/sindresorhus)

Parameter and response types for all endpoint methods exported as `{ RestEndpointMethodTypes }`.

Example

```ts
import { RestEndpointMethodTypes } from "@octokit/plugin-rest-endpoint-methods";

type UpdateLabelParameters =
  RestEndpointMethodTypes["issues"]["updateLabel"]["parameters"];
type UpdateLabelResponse =
  RestEndpointMethodTypes["issues"]["updateLabel"]["response"];
```

In order to get types beyond parameters and responses, check out [`@octokit/openapi-types`](https://github.com/octokit/openapi-types.ts/#readme), which is a direct transpilation from GitHub's official OpenAPI specification.

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md)

## License

[MIT](LICENSE)

---
_Source: https://npm.io/package/@octokit/plugin-rest-endpoint-methods · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._