Using the REST API

Learn how to use the GitHub REST API, follow best practices, and troubleshoot problems.

Links

• Getting started with the REST API

  Learn how to use the GitHub REST API.

• Rate limits for the REST API

  Learn about REST API rate limits, how to avoid exceeding them, and what to do if you do exceed them.

• Using pagination in the REST API

  Learn how to navigate through paginated responses from the REST API.

• Libraries for the REST API

  You can use the official Octokit libraries and other third-party libraries to extend and simplify how you use the GitHub API.

• Best practices for using the REST API

  Follow these best practices when using GitHub's API.

• Troubleshooting the REST API

  Learn how to diagnose and resolve common problems for the REST API.

• Timezones and the REST API

  Some REST API endpoints allow you to specify timezone information with your request.

• Using CORS and JSONP to make cross-origin requests

  You can make API requests across domains using cross-origin resource sharing (CORS) and JSONP callbacks.

• Issue event types

  For the REST APIs for issue events and timeline events, learn about each event type, the triggering action on GitHub, and each event's unique properties.

• GitHub event types

  For the GitHub Events API, learn about each event type, the triggering action on GitHub, and each event's unique properties.