HGVA is powered by the Open Computational Genomic Analysis (OpenCGA) project. OpenCGA implements an extensive API that enables numerous operations over metadata, samples and genomic data. The whole API specification can be accessed at:
A description on the API and URLs design can be found at the OpenCGA RESTful Web Services documentation.
The tutorial Using RESTful Web Services shows practical examples on how to directly query the RESTful API. It focuses on those end points of the API which are of more interest for HGVA users, giving examples of their use and pin pointing certain peculiarities of the parameters for HGVA. Data is hierarchically organised in Projects and Studies. Please, have a look at Datasets and Studies in order to understand how data is organized: Projects,Studies and Cohorts . For details on the query parameters, please refer to the Swagger documentation linked above.
Clients
Likewise, a number of client libraries are provided which make intensive use of the OpenCGA RESTful API. They provide fast programmatic access for genome-scale data analysis, therefore discouraging massive downloads of data to local computers. Currently supported languages include Java, Python, JavaScript and R. Again, all of them provide an exhaustive API for accessing the whole OpenCGA API. Please, find below details on how to download, install and configure the libraries. Also, find practical examples on how to use the methods which are of particular interest for HGVA users within the corresponding Tutorials.
