HTTP/2 302 server: nginx date: Thu, 17 Jul 2025 17:19:34 GMT content-type: text/plain; charset=utf-8 content-length: 0 x-archive-redirect-reason: found capture at 20090305124501 location: https://web.archive.org/web/20090305124501/https://github.com/guides/the-github-api server-timing: captures_list;dur=0.804111, exclusion.robots;dur=0.025239, exclusion.robots.policy;dur=0.011213, esindex;dur=0.014156, cdx.remote;dur=41.570917, LoadShardBlock;dur=176.975144, PetaboxLoader3.datanode;dur=58.702826, PetaboxLoader3.resolve;dur=57.591539 x-app-server: wwwb-app216 x-ts: 302 x-tr: 309 server-timing: TR;dur=0,Tw;dur=0,Tc;dur=0 set-cookie: SERVER=wwwb-app216; 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: Thu, 17 Jul 2025 17:19:39 GMT content-type: text/html; charset=utf-8 x-archive-orig-server: nginx/0.6.26 x-archive-orig-date: Thu, 05 Mar 2009 12:45:01 GMT x-archive-orig-connection: close x-archive-orig-status: 200 OK x-archive-orig-x-runtime: 159ms x-archive-orig-etag: "df9b128a6e86931ad5f77354edd69ec4" x-archive-orig-cache-control: private, max-age=0, must-revalidate x-archive-orig-content-length: 11114 x-archive-guessed-content-type: text/html x-archive-guessed-charset: utf-8 memento-datetime: Thu, 05 Mar 2009 12:45:01 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="Fri, 20 Feb 2009 02:25:45 GMT", ; rel="memento"; datetime="Thu, 05 Mar 2009 12:45:01 GMT", ; rel="next memento"; datetime="Thu, 19 Mar 2009 05:11:43 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: 51_8_20090305080337_crawl100-c/51_8_20090305124259_crawl101.arc.gz server-timing: captures_list;dur=0.715312, exclusion.robots;dur=0.028435, exclusion.robots.policy;dur=0.012739, esindex;dur=0.012407, cdx.remote;dur=14.092583, LoadShardBlock;dur=3277.011145, PetaboxLoader3.resolve;dur=1048.263861, PetaboxLoader3.datanode;dur=2967.214016, load_resource;dur=904.498866 x-app-server: wwwb-app216 x-ts: 200 x-tr: 4240 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

Browse | Guides | Advanced

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

(Using token authentication, described below, will enable listing of private repositories.)

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)
• GitHub Projects Wordpress Plug-in – Also at the official Wordpress plug-in directory
• github-repos – Tutorial and Example
• github-terminal , working example at Github Terminal
• git-trip – Visualize git repositories.

Additional resources

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

Last edited by rjbs, 17 days ago

Versions: CurrentVersion 31 by OshumaVersion 30 by prtksxnaVersion 29 by prtksxnaVersion 28 by johnbenderVersion 27 by johnbenderVersion 26 by tristandunnVersion 25 by webandyVersion 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

Shirts | Blog | Support | Training | Contact | Google Group | API | Status

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

Hosting provided by our
partners at Engine Yard

This feature is coming soon. Sit tight!