See https://developer.github.com/v3/

Base URL: https://api.github.com

Contact: Michael Bryzek mbryzek@alum.mit.edu http://twitter.com/mbryzek

License: MIT

blob

Path: /repos/:owner/:repo/git/blobs

GET /repos/:owner/:repo/git/blobs/:sha
Parameters
NameTypeDescription
owner requiredstringPath
repo requiredstringPath
sha requiredstringPath
Responses
CodeTypeDescription
200blob
404unit
POST /repos/:owner/:repo/git/blobs
Body
Parameters
NameTypeDescription
owner requiredstringPath
repo requiredstringPath
Responses
CodeTypeDescription
201blob_created
404unit
422unprocessable_entity

commit

Path: /repos/:owner/:repo/git/commits

GET /repos/:owner/:repo/git/commits/:sha
Parameters
NameTypeDescription
owner requiredstringPath
repo requiredstringPath
sha requiredstringPath
Responses
CodeTypeDescription
200commit
404unit
422unprocessable_entity
POST /repos/:owner/:repo/git/commits
Parameters
NameTypeDescription
owner requiredstringPath
repo requiredstringPath
Responses
CodeTypeDescription
201commit_response
404unit
422unprocessable_entity

contents

Path: /repos/:owner/:repo

GET /repos/:owner/:repo/readme
Parameters
NameTypeDescription
owner requiredstringPath
repo requiredstringPath
ref requiredstringQuery default: main
Responses
CodeTypeDescription
200contents
401unit
404unit
GET /repos/:owner/:repo/contents/:path
Parameters
NameTypeDescription
owner requiredstringPath
repo requiredstringPath
path requiredstringPath
ref requiredstringQuery default: main
Responses
CodeTypeDescription
200contents
401unit
404unit

hook

Path: /repos/:owner/:repo/hooks

GET /repos/:owner/:repo/hooks
Parameters
NameTypeDescription
owner requiredstringPath
repo requiredstringPath
Responses
CodeTypeDescription
200[hook]
404unit
GET /repos/:owner/:repo/hooks/:id
Parameters
NameTypeDescription
owner requiredstringPath
repo requiredstringPath
id requiredlongPath
Responses
CodeTypeDescription
200hook
404unit
POST /repos/:owner/:repo/hooks
Body
Parameters
NameTypeDescription
owner requiredstringPath
repo requiredstringPath
Responses
CodeTypeDescription
201hook
404unit
422unprocessable_entity
DELETE /repos/:owner/:repo/hooks/:id
Parameters
NameTypeDescription
owner requiredstringPath
repo requiredstringPath
id requiredlongPath
Responses
CodeTypeDescription
204unit
404unit

pull_request

Path: /repos/:owner/:repo/pulls

POST /repos/:owner/:repo/pulls
Parameters
NameTypeDescription
owner requiredstringPath
repo requiredstringPath
Responses
CodeTypeDescription
201pull_request
404unit
422unprocessable_entity
GET /repos/:owner/:repo/pulls
Parameters
NameTypeDescription
owner requiredstringPath
repo requiredstringPath
page requiredlongQuery default: 1
Responses
CodeTypeDescription
200[pull_request]
404unit

ref

Path: /repos/:owner/:repo/git/refs

GET /repos/:owner/:repo/git/refs
Parameters
NameTypeDescription
owner requiredstringPath
repo requiredstringPath
Responses
CodeTypeDescription
200[ref]
404unit
GET /repos/:owner/:repo/git/refs/:ref
Parameters
NameTypeDescription
owner requiredstringPath
repo requiredstringPath
ref requiredstringPath
Responses
CodeTypeDescription
200ref
404unit
POST /repos/:owner/:repo/git/refs
Body
Parameters
NameTypeDescription
owner requiredstringPath
repo requiredstringPath
Responses
CodeTypeDescription
201ref
404unit
422unprocessable_entity
PUT /repos/:owner/:repo/git/refs/:ref
Parameters
NameTypeDescription
owner requiredstringPath
repo requiredstringPath
ref requiredstringPath
Responses
CodeTypeDescription
201ref
404unit
422unprocessable_entity

repository

GET /user/repos
Parameters
NameTypeDescription
page requiredlongQuery default: 1
visibility requiredvisibilityQuery default: all
affiliation stringQuery
type stringQuery
sort requiredstringQuery default: full_name
direction requiredstringQuery default: asc
Responses
CodeTypeDescription
200[repository]
401unit
GET /users/:username/repos

List public repositories for the specified user.

Parameters
NameTypeDescription
username requiredstringPath
page requiredlongQuery default: 1
type requiredstringQuery default: owner
sort requiredstringQuery default: full_name
direction requiredstringQuery default: asc
Responses
CodeTypeDescription
200[repository]
401unit
GET /orgs/:org/repos

List repositories for the specified org.

Parameters
NameTypeDescription
org requiredstringPath
page requiredlongQuery default: 1
type requiredstringQuery default: all
sort requiredstringQuery default: full_name
direction requiredstringQuery default: asc
Responses
CodeTypeDescription
200[repository]
401unit

tag

Path: /repos/:owner/:repo

GET /repos/:owner/:repo/tags
Parameters
NameTypeDescription
owner requiredstringPath
repo requiredstringPath
page requiredlongQuery default: 1
per_page requiredlongQuery default: 30
Responses
CodeTypeDescription
200[tag_summary]
404unit
GET /repos/:owner/:repo/tags/:sha
Parameters
NameTypeDescription
owner requiredstringPath
repo requiredstringPath
sha requiredstringPath
Responses
CodeTypeDescription
200tag
404unit
POST /repos/:owner/:repo/git/tags
Body
Parameters
NameTypeDescription
owner requiredstringPath
repo requiredstringPath
Responses
CodeTypeDescription
201tag
404unit
422unprocessable_entity

tree

Path: /repos/:owner/:repo/git/trees

POST /repos/:owner/:repo/git/trees
Parameters
NameTypeDescription
owner requiredstringPath
repo requiredstringPath
Responses
CodeTypeDescription
201create_tree_response
404unit
422unprocessable_entity

user

GET /user
Responses
CodeTypeDescription
200user
401unit
GET /user/orgs
Parameters
NameTypeDescription
page requiredlongQuery default: 1
per_page longQuery (max: 100)
Responses
CodeTypeDescription
200[user_org]
401unit

user_email

Path: /user/emails

GET /user/emails
Responses
CodeTypeDescription
200[user_email]
401unit