@octokit/rest NPM | npm.io

21.0.2 • Published 10 months ago

Install

Weekly downloads

3,286,840

License

MIT

Repository

Last release

10 months ago

rest.js

GitHub REST API client for JavaScript

Usage

<script type="module">
  import { Octokit } from "https://esm.sh/@octokit/rest";
</script>

Install with npm install @octokit/rest

import { Octokit } from "@octokit/rest";

!IMPORTANT As we use conditional exports, you will need to adapt your tsconfig.json by setting "moduleResolution": "node16", "module": "node16".
See the TypeScript docs on package.json "exports". See this helpful guide on transitioning to ESM from @sindresorhus

const octokit = new Octokit();

// Compare: https://docs.github.com/en/rest/reference/repos/#list-organization-repositories
octokit.rest.repos
  .listForOrg({
    org: "octokit",
    type: "public",
  })
  .then(({ data }) => {
    // handle data
  });

See https://octokit.github.io/rest.js for full documentation.

!IMPORTANT As we use conditional exports, you will need to adapt your tsconfig.json by setting "moduleResolution": "node16", "module": "node16".
See the TypeScript docs on package.json "exports". See this helpful guide on transitioning to ESM from @sindresorhus

Contributing

We would love you to contribute to @octokit/rest, pull requests are very welcome! Please see CONTRIBUTING.md for more information.

Credits

@octokit/rest was originally created as node-github in 2012 by Mike de Boer from Cloud9 IDE, Inc. The original commit is from 2010 which predates the npm registry.

It was adopted and renamed by GitHub in 2017. Learn more about its origin on GitHub's blog: From 48k lines of code to 10—the story of GitHub’s JavaScript SDK

LICENSE

octokit github rest api-client

@octokit/core @octokit/plugin-paginate-rest @octokit/plugin-request-log @octokit/plugin-rest-endpoint-methods

@lerna/github-client @lerna/create lerna @tonyyanga/mintlify_cli @tonyyanga/mintlify_previewing @june21x/semantic-release-github-no-comment @falloutstudios/rmm commit-cz-fix @atomist/sdm @atomist/automation-client @atomist/sdm-core @bejoistic/gitfeed gist-manage site-rocket github-followers-notifier @manstis/test @aptoma/amp-cli @zendeskgarden/tool-shed rd-vue rdvue2 @canvanauts/check-a-block rd-vue-cli dc-ginit platform-builder @ahmadnassri/github-bulk-clone airtable-github-json-export rdvue-cli @balena.io/repo-config plexi-support git-san alfredino auth0-deploy-extensions framer-tools @squeezer/travis-github @nodesoccoop/angular-ncr-srcs buggiest-files-cli @particle/device-os-flash create-tfl-app2 gitbuilder @lakshay35/ginit @google-cloud/code-suggester create-cli-hhh page-metrics-root resinci-deploy insomnia-plugin-stephen-strange @peerio/desktop-release-builder amazon-pacman @featureninjas/cli gitfeed depth-coverage copy-github-labels-reloaded az-depth-coverage semantic-github-pullrequest @joshpress/git-cms @jessitron/automation-client yuthi @mrjerz/plugin-scaffolder-backend ginit-xyz towify-cli newman-reporter-pullrequest-decorator newman-reporter-github-pullrequest @growlab/ginit @jaccomeijer/make @rbi-backstage/plugin-scaffolder-backend @code.gov/code-gov-integrations fjord_app @wheelroom/make @project-furnace/furnace-cli @githaxs/action-app-wrapper @githaxs/github-application-wrapper we-plugin-github @ahmadnassri/github-cli-auth web-compile @sdlc.vitechteam/pipe-helper @sdlc.vitechteam/sdlc-pipelines-helper @sdlc.vitechteam/sdlcpipe @wdcli/tools qmmicro-cli web-compress aka-cli-alpha mdb-git-services vite-plugin-certificate group-stats-event-schemas @wearerequired/wordpress-plugin-boilerplate ringcentral-add-in-framework extra-github gitssues quick-repository teasim-scripts @jamiemagee/ghsa-offline github-doc-server-lib fomantic-ui-semeia pushinit gnccr @runcitadel/dev-tools repodown-cli xycool react-github-contributors tif-cli teste-adolfo

10 months ago

11 months ago

12 months ago

12 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

4 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

5 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

6 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago

7 years ago