Download
GitHub REST API client for JavaScript. Import the Octokit constructor based on your platform. Instantiate your octokit API. All options are optional, but authentication is strongly encouraged. API Previews can be enabled globally by setting the previews option. They can be set per-request as well. A default time zone can be enabled by setting the timeZone option. In order to use Octokit with GitHub Enterprise, set the baseUrl option. Most of GitHub’s REST API endpoints have matching methods. All endpoint methods are asynchronous, in order to use await in the code examples, we wrap them into an anonymous async function. Authentication is optional for some REST API endpoints accessing public data, but is required for GraphQL queries. Using authentication also increases your API rate limit.
Features
- You can set auth to a personal access token string
- Setting a user agent is required
- A default time zone can be enabled by setting the timeZone option
- Some API endpoints support alternative response formats
- You can also register custom endpoint methods
- Some endpoints return a list which has to be paginated in order to retrieve the complete data set
Project Samples
