HTTP/2 302 server: nginx date: Sat, 16 Aug 2025 03:50:28 GMT content-type: text/plain; charset=utf-8 content-length: 0 x-archive-redirect-reason: found capture at 20081119104303 location: https://web.archive.org/web/20081119104303/https://github.com/guides/the-github-api server-timing: captures_list;dur=0.645656, exclusion.robots;dur=0.017814, exclusion.robots.policy;dur=0.007258, esindex;dur=0.009406, cdx.remote;dur=118.347479, LoadShardBlock;dur=153.613481, PetaboxLoader3.datanode;dur=139.423455 x-app-server: wwwb-app239 x-ts: 302 x-tr: 351 server-timing: TR;dur=0,Tw;dur=0,Tc;dur=1 set-cookie: wb-p-SERVER=wwwb-app239; path=/ x-location: All x-rl: 0 x-na: 0 x-page-cache: MISS server-timing: MISS x-nid: DigitalOcean referrer-policy: no-referrer-when-downgrade permissions-policy: interest-cohort=() HTTP/2 200 server: nginx date: Sat, 16 Aug 2025 03:50:30 GMT content-type: text/html; charset=utf-8 x-archive-orig-server: nginx/0.6.26 x-archive-orig-date: Wed, 19 Nov 2008 10:43:03 GMT x-archive-orig-connection: close x-archive-orig-status: 200 OK x-archive-orig-x-runtime: 74ms x-archive-orig-etag: "a3844113d92e3acf979faac59c7b9b0f" x-archive-orig-cache-control: private, max-age=0, must-revalidate x-archive-orig-content-length: 9285 x-archive-guessed-content-type: text/html x-archive-guessed-charset: utf-8 memento-datetime: Wed, 19 Nov 2008 10:43:03 GMT link: ; rel="original", ; rel="timemap"; type="application/link-format", ; rel="timegate", ; rel="first memento"; datetime="Sun, 16 Mar 2008 05:32:32 GMT", ; rel="prev memento"; datetime="Sat, 17 May 2008 17:05:24 GMT", ; rel="memento"; datetime="Wed, 19 Nov 2008 10:43:03 GMT", ; rel="next memento"; datetime="Wed, 17 Dec 2008 14:15:44 GMT", ; rel="last memento"; datetime="Fri, 07 Mar 2025 18:44:03 GMT" content-security-policy: default-src 'self' 'unsafe-eval' 'unsafe-inline' data: blob: archive.org web.archive.org web-static.archive.org wayback-api.archive.org athena.archive.org analytics.archive.org pragma.archivelab.org wwwb-events.archive.org x-archive-src: BNF-CRAWL-004-20081119100551-11134-crawling100-c/BNF-CRAWL-004-20081119104007-09636-crawling108.us.archive.org.arc.gz server-timing: captures_list;dur=0.490882, exclusion.robots;dur=0.029429, exclusion.robots.policy;dur=0.005660, esindex;dur=0.008189, cdx.remote;dur=6.898988, LoadShardBlock;dur=1163.008409, PetaboxLoader3.datanode;dur=98.476957, PetaboxLoader3.resolve;dur=1320.546839, load_resource;dur=281.736428 x-app-server: wwwb-app239 x-ts: 200 x-tr: 1505 server-timing: TR;dur=0,Tw;dur=0,Tc;dur=0 x-location: All x-rl: 0 x-na: 0 x-page-cache: MISS server-timing: MISS x-nid: DigitalOcean referrer-policy: no-referrer-when-downgrade permissions-policy: interest-cohort=() content-encoding: gzip

Home Pricing and Signup Repositories Blog Login

Home | Edit | New

Guides: The GitHub API

We’re adding an API bit by bit. This page will serve as the documentation.

The basic url template:

https://github.com/api/version/format/username/repository/type/object

• Current version: v1
• Acceptable formats: json, xml, yaml
• Acceptable types: commits, commit

Grabbing all recent commits:

$ curl -i https://github.com/api/v1/xml/caged/gitnub/commits/master | less

Grabbing a single commit:

$ curl -i https://github.com/api/v1/json/defunkt/github-gem/commit/c26d4ce9807ecf57d3f9eefe19ae64e75bcaaa8b | less

Repository search:

$ curl -i https://github.com/api/v1/xml/search/merb | less

You can also grab a user’s info, including a list of his repositories:

$ curl -i https://github.com/api/v1/json/defunkt | less

With JSON requests, you can have the result passed to a callback method of your choice:

$ curl -i https://github.com/api/v1/json/defunkt?callback=myCallbackMethod | less

Projects using API

• GitHub Badge (see also initial blog post)
• Badjo
• YAGHB – Yet another github badge
• textmate gem—Command-line package manager for textmate
• github commit badge – GitHub commit badge, showing the most recent commits of chosen repos
• ‘gadgets’ project and ‘demo generator’ (see also initial blog post)

Additional resources

• Token Authentication
• Making sense of the participation graph data ( explanation of the participation data )

Last edited by andyatkinson, 3 days ago

Versions: CurrentVersion 24 by tekkubVersion 23 by tekkubVersion 22 by heipeiVersion 21 by zmackVersion 20 by zmackVersion 19 by subtleGradientVersion 18 by defunktVersion 17 by schleyfoxVersion 16 by zmackVersion 15 by drnicVersion 14 by drnicVersion 13 by defunktVersion 12 by defunktVersion 11 by defunktVersion 10 by mojomboVersion 9 by mojomboVersion 8 by mojomboVersion 7 by mojomboVersion 6 by defunktVersion 5 by defunktVersion 4 by defunktVersion 3 by defunktVersion 2 by defunktVersion 1 by defunkt

T-Shirts | Blog | Google Group | Bugs & Features | Git Training | Contact | Status

GitHub is Logical Awesome | ©2008 | Terms of Service | Privacy Policy

Hosting provided by 

This feature is coming soon. Sit tight!