CARVIEW

MOTORHOMES

Select Language

HTTP/2 302 server: nginx date: Tue, 23 Dec 2025 23:21:37 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.964975, exclusion.robots;dur=0.051648, exclusion.robots.policy;dur=0.043495, esindex;dur=0.008650, cdx.remote;dur=11.544028, LoadShardBlock;dur=155.623578, PetaboxLoader3.datanode;dur=85.475583, PetaboxLoader3.resolve;dur=44.323542 x-app-server: wwwb-app242-dc8 x-ts: 302 x-tr: 190 server-timing: TR;dur=0,Tw;dur=0,Tc;dur=0 set-cookie: wb-p-SERVER=wwwb-app242; path=/ x-location: All x-as: 14061 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: Tue, 23 Dec 2025 23:21:37 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" 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.569799, exclusion.robots;dur=0.024954, exclusion.robots.policy;dur=0.015320, esindex;dur=0.008740, cdx.remote;dur=14.832730, LoadShardBlock;dur=141.875207, PetaboxLoader3.datanode;dur=111.236557, PetaboxLoader3.resolve;dur=123.283717, load_resource;dur=100.291463 x-app-server: wwwb-app242-dc8 x-ts: 200 x-tr: 300 server-timing: TR;dur=0,Tw;dur=0,Tc;dur=0 x-location: All x-as: 14061 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 The GitHub API - Guides - GitHub

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:

Original Source | Taken Source