How can I get a list of all pull requests for a repo through the github API?

Question

I want to obtain a list of all pull requests on a repo through the github API.

I've followed the instructions at http://developer.github.com/v3/pulls/ but when I query /repos/:owner/:repo/pulls it's consistently returning fewer pull requests than displayed on the website.

For example, when I query the torvalds/linux repo I get 9 open pull requests (there are 14 on the website). If I add ?state=closed I get a different set of 11 closed pull requests (the website shows around 20).

Does anyone know where this discrepancy arises, and if there's any way to get a complete list of pull requests for a repo through the API?

Answer 1

You can get all pull requests (closed, opened, merged) through the variable state.

Just set state=all in the GET query, like this->

https://api.github.com/repos/:owner/:repo/pulls?state=all 

For more info: check the Parameters table at https://developer.github.com/v3/pulls/#list-pull-requests

Edit: As per Tomáš Votruba's comment:

the default value for, "per_page=30". The maximum is per_page=100. To get more than 100 results, you need to call it multiple itmes: "&page=1", "&page=2"...

Answer 2

PyGithub (https://github.com/PyGithub/PyGithub), a Python library to access the GitHub API v3, enables you to get paginated resources.

For example,

g = Github(login_or_token=$YOUR_TOKEN, per_page=100) r = g.get_repo($REPO_NUMBER)  for pull in r.get_pulls('all'):     # You can access pulls 

See the documentation (http://pygithub.readthedocs.io/en/latest/index.html).

Answer 3

With Github's new official CLI (command line interface):

gh pr list --repo OWNER/REPO

which would produce something like:

Showing 2 of 2 pull requests in OWNER/REPO

#62  Doing something    that-weird-branch-name
#58  My PR title        wasnt-inspired-branch

See additional details and options and installation instructions.