Ohloh API Documentation
The Ohloh API is a free, REST-based programming interface to the Black Duck Open Hub open source directory. You can use the Ohloh API to create your own applications and web services based on Open Hub data.
This page contains important summary information to help you get started. In-depth online documentation is available, linked by the table of contents below.
Send bug reports to email@example.com.
Table of Contents
- Lookup By Email
- Using OAuth with the Ohloh API
- Ohloh API Reference
- API Use Agreement
- Apply for an API Key
- API Key Status
We ask that you cite Open Hub in publications that use our data. Please include a link to https://www.openhub.net on your web pages.
We recommend linking to our home page. The following html will link the small badge to our home page:
<a href ="https://www.openhub.net"><img src="https://www.openhub.net/images/badges/mini.gif" width="80" height="15" /></a>
Before you can access the Ohloh API, you must register your application and obtain an API key. Bandwidth will initially be limited to 1,000 requests per API key per day.
An API Key should be unique to each application that accesses the Ohloh API. You can register up to five applications.
It is important not to share API keys. In order to access or modify account data, your application must be granted permission by an individual Open Hub account holder. This permission is granted on a per-key basis.
If you have special requirements for additional keys, or if you are interested in building a large-scale application, please contact us at firstname.lastname@example.org.
The standard Ohloh API allows read-only access to Open Hub data.
Using OAuth, you can impersonate an Open Hub account while accessing the Ohloh API. This enables you to write to the Open Hub database, and also to access or modify private account information. You must first be granted permission to do this by an Open Hub account holder.
You can read more at Using OAuth with the Ohloh API.
Forming a Request
The Ohloh API returns XML-formatted data in response to HTTP GET requests.
The design concept is that for each web page on Open Hub, there may be an equivalent XML-formatted version of the page. Most pages on the Black Duck Open Hub have an XML representation.
You must do three things to receive an XML-formatted response:
- Append a
.xmlextension to the basic URL. For example, instead of
https://www.openhub.net/projects/1, which returns an HTML page, you would request
- Provide your API Key as an HTTP parameter. Your request will be forbidden without a valid
For example, to view the project with ID=1 as XML, using an example API key, the complete URL would be:
For the sake of brevity, the
api_key parameter will be omitted from the examples in this documentation. Remember to always include it in your actual queries.
Note that the Ohloh API previously required the use of a version parameter
v. This is no longer required, and will be ignored.
XML Response Format
A sample response to a project request might be:
<?xml version="1.0" encoding="UTF-8"?> <response> <status>success</status> <result> <project> <id>1</id> <name>Subversion</name> <created_at>2006-10-10T15:51:31Z</created_at> <updated_at>2007-08-22T17:31:17Z</updated_at> <description>Subversion has rapidly become the version control standard....</description> <homepage_url>http://subversion.tigris.org/</homepage_url> <download_url>http://subversion.tigris.org/project_packages.html</download_url> <irc_url></irc_url> <stack_count>1096</stack_count> <analysis_id>51898</analysis_id> <analysis> <id>51898</id> <project_id>1</project_id> <updated_at>2007-07-12T12:21:11Z</updated_at> <logged_at>2007-07-12T12:18:54Z</logged_at> <min_month>2001-08-01T00:00:00Z</min_month> <max_month>2007-07-01T00:00:00Z</max_month> <twelve_month_contributor_count>55</twelve_month_contributor_count> <total_code_lines>319283</total_code_lines> <main_language_id>7</main_language_id> <main_language_name>C/C++</main_language_name> </analysis> </project> </result> </response>
All XML returned from the Ohloh API will be contained within a root element called
<response>, which will always contain a
<status> element will contain either
<status> value is
success, the HTTP response code will be
200, and the
<result> element contains the data you requested.
failed, then the HTTP response code will be set appropriately (usually Bad Request or Not Found), and an
<error> element will be present containing human-readable help text. For example:
<?xml version="1.0" encoding="UTF-8"?> <response> <status>failed</status> <error>A valid api_key is required to access this URL.</error> </response>
Details about this project response can be found in the Ohloh API Reference project page.
Collection Request Parameters
- query - Results will be filtered by the provided string. Only items that contain the query string in their names or descriptions will be returned. Filtering is case insenstive. Only alphanumeric characters are accepted. All non-alphanumeric characters will be replaced by spaces. Filtering is not available on all API methods, and the searched text depends on the type of object requested. Check the reference documentation for specifics.
- sort - Controls the sort order of the returned results. Typical supported values are name, created_at, and updated_at. The specific sort options available depend on the type of object requested, so check to the reference documentation for specifics. API does not support reverse sorting.
- page - In most cases, the Ohloh API returns at most 25 items per request. Pass this parameter to request subsequent items beyond the first page. This parameter is one-based, with a default value of 1. If you pass a value outside the range of available pages, you will receive the first page.
For example, to get the second page of projects containing “java” or “Java” in their titles, descriptions, or tags, you would request:
Collection Response XML Format
Some results will contain a collection of values. When this happens, the
<response> element will contain some additional elements:
- items_returned - The number of items returned in this response.
- items_available - The total number of database items matching the query, including those already returned.
- first_item_position - The zero-based index of the first item returned
For example, the response to
https://www.openhub.net/projects.xml might begin:
<response> <status>success</status> <items_returned>25</items_returned> <items_available>7056</items_available> <first_item_position>0</first_item_position> <result> <project> <id>9</id> <name>Mozilla Firefox</name> ....
Copyright 2014 Black Duck Software, Inc. Unless otherwise marked, this work is licensed under a Creative Commons Attribution 3.0 Unported License.