Ion Torrent™ SDK documentation

The Torrent Suite™ Software Development Kit (SDK) provides a convenient and powerful web services Application Programming Interface (API) for accessing the Torrent Server database and working with analysis results files and plugins. The API implements a well-defined interface based on Representational State Transfer (REST) principles for remote access to resources with programming language independence.


The API specifies endpoints with callable methods for each resource and managed entity, such as a plugin or file. To perform an action using the API, you send a request to the endpoint, using a REST method and specifying parameters, data and the data format. The parameters, requests, responses, and error codes for each method are listed in the API reference tables.

See the API reference tables for a listing of all API resources:

See the API Cookbook for a tutorial on how to programatically access the API:

The API Quick Reference provides a summary listing of select APIs:


Analysis, report and configuration data are stored in a PostgreSQL database. Database items include:

  • Values computed during analysis pipeline processing.
  • Configuration parameters accessible using the Torrent Browser UI.

See the schema tables for a listing of all Torrent Suite™ Software database tables:

PostgreSQL is an open-source object-relational Database Management System (DBMS) that supports almost all SQL constructs. PostgreSQL APIs are available for the most popular programming languages to build applications using the database for backend data store. The main user interface to PostgreSQL is the psql command line program. The psql program permits you to enter database queries directly from a terminal or to execute a query sequence from a file. Database queries demonstrated in this guide use psql.

About these documents

See this page for descriptions of the left panel table of contents, the breadcrumbs at the top of each page, and the previous and next navigation links: