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

Project Activity

See All Activity >

License

MIT License

Follow rest.js

rest.js Web Site

Other Useful Business Software
$300 Free Credits for Your Google Cloud Projects Icon
$300 Free Credits for Your Google Cloud Projects

Start building on Google Cloud with $300 in free credits. No commitment, no credit card required until you're ready to scale.

Launch your next project with $300 in free Google Cloud credits—no strings attached. Test, build, and deploy without risk. Use your credits across the entire Google Cloud platform to find what works best for your needs. After your credits are used, continue with always-free tier services. Only pay when you're ready to scale. Sign up in minutes and start exploring.
Start Free Trial
Rate This Project
Login To Rate This Project

User Reviews

Be the first to post a review of rest.js!

Additional Project Details

Programming Language

JavaScript

Related Categories

JavaScript Source Code Analysis Tool, JavaScript API Clients

Registered

2021-11-24