Module github




This GitHub connector client module provides capability to perform operations on major resource types such as Repositories, Issues, Pull Requests, Projects etc.

This module supports GitHub API v4 version and only allows to perform functions behalf of the user who is currently logged in.


Before using this connector in your Ballerina application, complete the following:

  • Create account

  • Obtain token - To obtain a personal access token via which the connector can access the API, follow these steps

  • Configure the connector with obtained token


To use the GitHub connector in your Ballerina application, update the .bal file as follows:

Step 1: Import connector

First, import the ballerinax/github module into the Ballerina project as follows.

import ballerinax/github;

Step 2: Create a new connector instance

Create a github:ConnectionConfig using your GitHub personal access token and and initialize the connector with it.

ithub:ConnectionConfig config = {
   auth: {
       token: "authToken"

ithub:Client githubClient = new (config);

Step 3: Invoke connector operation

  • Get All Open Pull Requests In A Repository
stream<github:PullRequest,github:Error?> response = check githubClient->getPullRequests(<GitHub_Username>, <GitHub_Repository_Name>, github:PULL_REQUEST_OPEN);
  • Use bal run command to compile and run the Ballerina program.

Other versions

See more...