BioGRID REST Service

Interaction data in BioGRID can be accessed via the BioGRID REST service. Interactions in various formats can be fetched from the BioGRID REST Service over HTTP, programmatically or in a browser, at http://webservice.thebiogrid.org/interactions/. You can access interactions using both POST and GET operations depending on your application requirements.

Get Your Access Key

To access the BioGRID REST webservice, you will need a unique access key for your application. You can get one by filling out the simple form located here. This key must be included in all queries to the webservice in the form of accesskey=[ACCESSKEY].

Fetching Single Interactions

The URL http://webservice.thebiogrid.org/interactions/?accesskey=[ACCESSKEY] will retrieve the first 10,000 interactions in BioGRID, ordered by the BioGRID Interaction Id as found in .tab2 files. Single interactions can be retrieved by appending this URL with a Biogrid Interaction ID (e.g. http://webservice.thebiogrid.org/interactions/103?accesskey=[ACCESSKEY]).

Fetching Supported Organisms List

The URL http://webservice.thebiogrid.org/organisms/?accesskey=[ACCESSKEY] will retrieve the list of organism IDs and names supported by the REST taxId option. This call only supports the accessKey and format parameters (can be tab2 or json)(e.g. http://webservice.thebiogrid.org/organisms/?accesskey=[ACCESSKEY]&format=json).

Filtering Results

The results list returned can be filtered by appending ?parameter1=value1&parameter2=value2 etc. to the URL. A full description of possible parameters is given in the table below.

A formal description of the REST service, in Web Application Description Language (WADL), can be found at http://webservice.thebiogrid.org/application.wadl.

Updates and Version

The BioGRID REST service is updated to the latest release of BioGRID on the 4th of each month and the BioGRID database version being accessed can be determined with the URL: http://webservice.thebiogrid.org/version?accesskey=[ACCESSKEY].

Examples

Interactions for human MDM2 gene:

Interactions for human MDM2 gene and interactions between all interactors of MDM2:

First 10 interactions for human MDM2 gene:

Interactions between S. cerevisiae CDC27, APC1 and APC2:

Interactions from pubmed IDs 18316726 and 17662948:

Interactions between CDC27, APC1 and APC2 excluding ‘Affinity Capture-MS’ and ‘Two-hybrid’ data:

Interactions between genes with GENBANK_DNA_GI 82502895 (TP53) or 158261704 (MDM2), in jsonExtended format

Interactions involving Entrez Gene IDs 6783 (SULT1E1), 6820 (SULT2B1), and 55791 (LRIF1)

Interactions involving SGD IDs S000004354 (STE11) and S000003664 (PBS2)

List of Parameters

ParameterTypeDefaultValid ValuesDescription
accessKeystringNONEOnly 32 character Alphanumeric stringsAll rest access must supply a valid accessKey to prevent spamming of the service. Access Keys are free and openly available here.
startint00-2147483647Query results are numbered from 0. Results fetched will start at this value e.g. start = 50 will skip the the first 50 results. Ignored if using “count” in the format parameter.
maxint100001-10000Number of results to fetch; this will be ignored if greater than 10,000, i.e. pagination using several requests is required to retrieve more than 10,000 interactions. Ignored if using “count” in the format parameter.
interSpeciesExcludedbooleanFALSEtrue, falseIf ‘true’, interactions with interactors from different species will be excluded.
selfInteractionsExcludedbooleanFALSEtrue, falseIf ‘true’, interactions with one interactor will be excluded.
evidenceListstringemptyPipe-separated list of evidence codes from hereAny interaction evidence with its Experimental System in the list will be excluded from the results unless includeEvidence is set to true.
includeEvidencebooleanFALSEtrue, falseIf set to true, any interaction evidence with its Experimental System in the evidenceList will be included in the result
geneListstringemptyPipe-separated list of gene names or identifiers.Interactions between genes in this list will be fetched. This parameter is ignored if one of searchIds, searchNames, searchSynonyms is not ‘true’ and additionalIdentifierTypes is empty.
searchIdsbooleanFALSEtrue, falseIf ‘true’, the interactor ENTREZ_GENE and SYSTEMATIC_NAME (orf) will be examined for a match with the geneList .
searchNamesbooleanFALSEtrue, falseIf ‘true’, the interactor OFFICIAL_SYMBOL will be examined for a match with the geneList.
searchSynonymsbooleanFALSEtrue, falseIf ‘true’, the interactor SYNONYM will be examined for a match with the geneList.
searchBiogridIdsbooleanFALSEtrue, falseIf ‘true’, the entries in 'GENELIST' will be compared to BIOGRID internal IDS which are provided in all Tab2 formatted files.
additionalIdentifierTypesstringemptyPipe-separated list of identifier types from hereIdentifier types on this list are examined for a match with the geneList.
excludeGenesbooleanFALSEtrue, falseIf ‘true’, interactions containing genes in the geneList will be excluded from the results. Ignored if one of searchIds, searchNames, searchSynonyms is not ‘true’ and additionalIdentifierTypes is empty.
includeInteractorsbooleanTRUEtrue, falseIf ‘true’, in addition to interactions between genes on the geneList, interactions will also be fetched which have only one interactor on the geneList i.e. the geneList’s first order interactors will be included
includeInteractorInteractionsbooleanFALSEtrue, falseIf ‘true’ interactions between the geneList’s first order interactors will be included. Ignored if includeInteractors is ‘false’ or if excludeGenes is set to ‘true’.
pubmedListstringempty stringPipe-separated list of pubmed IDsInteractions will be fetched whose Pubmed Id is/ is not in this list, depending on the value of excludePubmeds.
excludePubmedsbooleanFALSEtrue, falseIf ‘false’, interactions with Pubmed ID in pubmedList will be included in the results; if ‘true’ they will be excluded.
htpThresholdint2147483647 (maximum 32-bit integer)0-2147483647Interactions whose Pubmed ID has more than this number of interactions will be excluded from the results. Ignored if excludePubmeds is ‘false’.
throughputTagstring“any”“any”,”low”,”high”If set to 'low or 'high', only interactions with 'Low throughput' or 'High throughput' in the 'throughput' field will be returned. Interactions with both 'Low throughput' and 'High throughput' will be returned by either value.
taxIdstring“All”Any NCBI taxonomy identifier or “All”Only genes from this organism will be searched with reference to gene identifiers or names.
includeHeaderbooleanFALSEtrue, falseIf ‘true’, the first line of the result will be a BioGRID column header, appropriate for the format parameter (‘count’ format has no header).
formatstring“tab2”“tab1”,”tab2,”extendedTab2”,”count”, “json”, “jsonExtended”‘tab1’ and ‘tab2’ will return data in .tab or .tab2 format respectively. 'json' will return data in json a json formatted object. ‘extendedTab2’ and 'jsonExtended' will return data in .tab2 and json file formats respectively with extra fields for “Source Database Identifiers”, “Number of Interactions per Publication” and “Additional Identifiers”. For more information on file formats, visit our file format listing.
translatebooleanFALSEtrue,falseIf 'true', the rest service will show a small snippet above your results detailing how your input parameters were translated for use in returning your data. This is helpful in troubleshooting why you may or may not be getting back the results expected. For example, if you enter a typo for a field such as “searchNamez”, no result will be translated, and thus this parameter will be ignored.

Error Handling

If you make a mistake in accessing the REST service, you will be redirected to a standardized HTML error page such as a 401 or 400 page, depending on the problem. In addition, all errors from the BioGRID REST service are accompanied by output in JSON format with the following structure.

  1. STATUS - This will be either Error or Warning depending on the severity of the problem.
  2. MESSAGES - A list of one or more messages detailing the error and possible corrective measures.
  3. TYPE - A simple reiteration of the HTML error type in the header for the overall page.
 
biogridrest.txt · Last modified: 2014/03/27 16:02 by biogridadmin