You are here: Help and Support Resources » BioGRID REST Service

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

- Both sides previous revision Previous revision
Next revision
- biogridrest [2015/04/26 17:19] biogridadmin [List of Parameters]
+ Previous revision
+ biogridrest [2020/09/13 17:02] (current) biogridadmin [BioGRID REST Service]
@@ Line -1,74 +1,46 @@ removed created
 ====== 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 HTTPHTTPS, programmatically or in a browser, at 
 **httphttps://​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 **[[httphttps://​webservice.thebiogrid.org|here]]**. This key must be included in all queries to the webservice in the form of accesskey=[ACCESSKEY].
 
 === = Fetching Single Interactions =Code Examples ​=== 
 The URL **http://​webservice.thebiogrid.org/​interactions/?​accesskey=[ACCESSKEY]** will retrieve ​For example code (written in Python) demonstrating basic usage of the first 10REST Service, 000 interactions in BioGRID, ordered by the BioGRID Interaction Id as found in **please visit our [[biogrid_tab_version_2.0|.tab2]]** files. Single interactions can be retrieved by appending this URL with a Biogrid Interaction ID (e.g. **httphttps://webservicegithub.thebiogrid.orgcom/interactionsBioGRID/103?​accesskey=[ACCESSKEYBIOGRID-REST-EXAMPLES|github repository]]**).
 
 ====Fetching Supported Organisms List == Access Points ======= 
 The URL **http://​webservice.thebiogrid.org/​organisms/?​accesskey=[ACCESSKEY]** will retrieve the list A formal description ​of organism IDs and names supported by the REST taxId option. This call only supports the accessKey and format parameters ​service, in Web Application Description Language ​(WADL), ​can be tab2 or json)(e.g. ​found at **httphttps://​webservice.thebiogrid.org/​organisms/?​accesskey=[ACCESSKEY]&​format=jsonapplication.wadl**). 
 
 === = /​interactions/<​INT ID> - Fetching ​Supported Additional Identifier Types =Single Interactions  ​=== 
 The URL **http://​webservice.thebiogrid.org/​identifiers/?​accesskey=[ACCESSKEY]** will retrieve the list of identifier type names supported by the REST additionalIdentifierTypes option. This call only supports the accessKey and format parameters (Single interactions ​can be tab2 or json)retrieved by appending this URL with a Biogrid Interaction ID (e.g. **httphttps://​webservice.thebiogrid.org/​identifiersinteractions/103?​accesskey=[ACCESSKEY]&​format=json**). 
 
 === = Filtering Results =/​interactions/​ - Fetching Multiple Interactions ​=== 
 The results list returned can be filtered by appending ​URL **https://​webservice.thebiogrid.org/​interactions/​?parameter1=value1&​parameter2accesskey=value2 etc. to [ACCESSKEY]** will retrieve ​the URL. A full description of possible parameters is given first 10,000 interactions ​in BioGRID, ordered by the BioGRID Interaction Id as found in **[[biogrid_tab_version_2.0|.tab2]]** files. Results can be modified and filtered using the options in our REST **[[#​list_of_parameters|table belowlist of parameters]]**.
 
 A formal description ​=== /organisms/ - Fetching Supported Organisms List === 
 The URL **https://​webservice.thebiogrid.org/​organisms/?​accesskey=[ACCESSKEY]** will retrieve the list of organism IDs and names supported by the REST service, in Web Application Description Language ​taxId option. This call only supports the accessKey and format parameters ​(WADL), ​can be found at tab2 or json)(e.g. ​**httphttps://​webservice.thebiogrid.org/​application.wadlorganisms/?​accesskey=[ACCESSKEY]&​format=json**).
 
 === = Updates and Version =/​identifiers/​ - Fetching Supported Additional Identifier Types === 
 The BioGRID REST service is updated to URL **https://​webservice.thebiogrid.org/​identifiers/?​accesskey=[ACCESSKEY]** will retrieve ​the latest release ​list of BioGRID on identifier type names supported by the 4th of each month and REST additionalIdentifierTypes option. This call only supports ​the BioGRID database version being accessed ​accessKey and format parameters (can be determined with the URL: 
 tab2 or json)(e.g. ​**httphttps://​webservice.thebiogrid.org/​versionidentifiers/​?​accesskey=[ACCESSKEY]&​format=json**).
 
 === /evidence/ - Fetching Supported Experimental Evidence ​==Examples  ​===== 
  
 === Interactions for human MDM2 gene: === 
  
 The URL **httphttps://​webservice.thebiogrid.org/​interactionsevidence/?searchNames=true&​geneList=MDM2&​includeInteractors=true&​includeInteractorInteractions=false&​taxId=9606&​accesskey=[ACCESSKEY]** ​ 
  
 === Interactions for human MDM2 gene will retrieve the list of evidence names supported by the REST evidenceList option. This call only supports the accessKey ​and interactions between all interactors of MDM2format parameters (can be tab2 or json)(e.g. **https://​webservice.thebiogrid.org/​evidence/?​accesskey=[ACCESSKEY]&​format==json**).
 
 **http://​webservice.thebiogrid.org/​interactions/?​searchNames=true&​geneList=MDM2&​taxId= 9606&​includeInteractors=true&​includeInteractorInteractions=true&​accesskey=[ACCESSKEY]** 
  
 === First 10 interactions for human MDM2 gene: === 
  
 **http:/version/ webservice.thebiogrid.org/​interactions/?​searchNames- Fetching REST Version Number ​=true&​geneList=MDM2&​includeInteractors=true&​taxId=9606&​start=0&​max=10&​accesskey=[ACCESSKEY]** 
  
 === Interactions between S. cerevisiae CDC27, APC1 The BioGRID REST service is updated to the latest release of BioGRID on the 4th of each month and APC2the BioGRID database version being accessed can be determined with the URL:=== 
  
 **[[httphttps://​webservice.thebiogrid.org/​interactions/​version?searchNames=true&​geneList=cdc27%7Capc1%7Capc2&​taxId=559292&​accesskey=[ACCESSKEY]|http://​webservice.thebiogrid.org/​interactions/?​searchNames=true&​geneList=cdc27|apc1|apc2&​taxId=559292&​accesskey=[ACCESSKEY]]]** 
  
 === Interactions from pubmed IDs 18316726 and 17662948: === 
  
 **[[http://​webservice. thebiogrid.org/​interactions/?​pubmedList=18316726%7C17662948&​accesskey=[ACCESSKEY]|http://​webservice.thebiogrid.org/​interactions/?​pubmedList=18316726|17662948&​accesskey=[ACCESSKEY]]]** 
  
 === Interactions between CDC27, APC1 and APC2 excluding ‘Affinity Capture-MS’ and ‘Two-hybrid’ data: === 
  
 **[[http://​webservice.thebiogrid.org/​interactions/?​searchNames=true&​geneList=cdc27%7Capc1%7Capc2&​evidenceList=Affinity Capture-MS%7CTwo-hybrid&​accesskey=[ACCESSKEY]|http://​webservice.thebiogrid.org/​interactions/?​searchNames=true&​geneList=cdc27|apc1|apc2&​evidenceList=Affinity Capture-MS|Two-hybrid&​accesskey=[ACCESSKEY]]]** 
  
 === Interactions between genes with GENBANK_DNA_GI 82502895 (TP53) or 158261704 (MDM2), in jsonExtended format === 
  
 **[[http://​webservice.thebiogrid.org/​interactions/?​additionalIdentifierTypes=GENBANK_DNA_GI&​geneList=82502895%7C158261704&​format=jsonExtended&​accesskey=[ACCESSKEY]|http://​webservice.thebiogrid.org/​interactions/?​additionalIdentifierTypes=GENBANK_DNA_GI&​geneList=82502895|158261704&​format=jsonExtended&​accesskey=[ACCESSKEY]]]** 
  
 === Interactions involving Entrez Gene IDs 6783 (SULT1E1), 6820 (SULT2B1), and 55791 (LRIF1) === 
  
 **[[http://​webservice.thebiogrid.org/​interactions/?​geneList=6783%7C6820%7C55791&​searchids=true&​includeInteractors=true&​accessKey=[ACCESSKEY]|http://​webservice.thebiogrid.org/​interactions/?​geneList=6783|6820|55791&​searchids=true&​includeInteractors=true&​accessKey=[ACCESSKEY]]]** 
  
 === Interactions involving SGD IDs S000004354 (STE11) and S000003664 (PBS2) === 
  
 **[[http://​webservice.thebiogrid.org/​interactions/?​additionalIdentifierTypes=SGD&​geneList=S000004354%7CS000003664&​includeInteractors=true&​accesskey=[ACCESSKEY]|http://​webservice.thebiogrid.org/​interactions/?​additionalIdentifierTypes=SGD&​geneList=S000004354|S000003664&​includeInteractors=true&​accesskey=[ACCESSKEY]]]**
 
 ====== List of Parameters ​ ======
 
 === 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 **[[#​list_of_parameters|table below]]**. You can also utilize our full list of **[[#​examples|example queries]]** to give you an idea of how to get started.
 
 ^Parameter^Type^Default^Valid Values^Description^
 |accessKey|string|NONE|Only 32 character Alphanumeric strings|All rest access must supply a valid accessKey to prevent spamming of the service. Access Keys are free and openly **[[httphttps://​webservice.thebiogrid.org/​|available here]]**. |
 |start|int|0|0-2147483647|Query 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.|
 |max|int|10000|1-10000|Number 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.|
 |interSpeciesExcluded|boolean|FALSE|true,​ false|If ‘true’, interactions with interactors from different species will be excluded.|
 |selfInteractionsExcluded|boolean|FALSE|true,​ false|If ‘true’, interactions with one interactor will be excluded.|
 |evidenceList|string|empty|Pipe-separated list of evidence codes from **[[http://​wiki.thebiogrid.org/​doku.php/​experimental_systems#​evidence_-_fetching_supported_experimental_evidence|here]]**|Any interaction evidence with its Experimental System in the list will be excluded from the results unless includeEvidence is set to true.|
 |includeEvidence|boolean|FALSE|true,​ false|If set to true, any interaction evidence with its Experimental System in the evidenceList will be included in the result|
 |geneList|string|empty|Pipe-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.|
@@ Line -77,5 +49,5 @@ removed created
 |searchSynonyms|boolean|FALSE|true,​ false|If ‘true’, the interactor SYNONYM will be examined for a match with the geneList.|
 |searchBiogridIds|boolean|FALSE|true,​ false|If ‘true’, the entries in '​GENELIST'​ will be compared to BIOGRID internal IDS which are provided in all Tab2 formatted files.|
 |additionalIdentifierTypes|string|empty|Pipe-separated list of identifier types from **[[#fetching_supported_additional_identifier_typesidentifiers_-_fetching_supported_additional_identifier_types|here]]**|Identifier types on this list are examined for a match with the geneList. Some identifier types search multiple types simultaneously. UNIPROT or UNIPROTKB will search SWISS-PROT/​TREMBL/​UNIPROT-ACCESSION/​UNIPROT-ISOFORM. REFSEQ will search REFSEQ-RNA-GI,​ REFSEQ-RNA-ACCESSION,​ REFSEQ-PROTEIN-GI,​ REFSEQ-PROTEIN-ACCESSION-VERSIONED,​ REFSEQ-PROTEIN-ACCESSION,​ REFSEQ-LEGACY. WORMBASE will search WORMBASE and WORMBASE-OLD. ENSEMBL will search ENSEMBL, ENSEMBL GENE, ENSEMBL PROTEIN, ENSEMBL RNA.|
 |excludeGenes|boolean|FALSE|true,​ false|If ‘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.|
 |includeInteractors|boolean|TRUE|true,​ false|If ‘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|
@@ Line -85,7 +57,7 @@ removed created
 |htpThreshold|int|2147483647 (maximum 32-bit integer)|0-2147483647|Interactions whose Pubmed ID has more than this number of interactions will be excluded from the results. Ignored if excludePubmeds is ‘false’.|
 |throughputTag|string|"​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.|
 |taxId|string|“All”|Pipe-separated list of NCBI taxonomy identifiers or "​All"​. Get full list of supported ids **[[#fetching_supported_organisms_listorganisms_-_fetching_supported_organisms_list|here]]**|Only genes from these organisms will be searched with reference to gene identifiers or names. |
 |includeHeader|boolean|FALSE|true,​ false|If ‘true’, the first line of the result will be a BioGRID column header, appropriate for the format parameter (‘count’ format has no header).|
 |format|string|“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 **[[httphttps://​wiki.thebiogrid.org/​doku.php/​downloads|file format listing]]**.|
 |translate|boolean|FALSE|true,​false|If '​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. |
 
@@ Line -95,2 +67,40 @@ removed created
   - **MESSAGES** - A list of one or more messages detailing the error and possible corrective measures.
   - **TYPE** - A simple reiteration of the HTML error type in the header for the overall page.
 
 ====== Examples ​ ======
 
 === Interactions for human MDM2 gene: ===
 
 **https://​webservice.thebiogrid.org/​interactions?​searchNames=true&​geneList=MDM2&​includeInteractors=true&​includeInteractorInteractions=false&​taxId=9606&​accesskey=[ACCESSKEY]**
 
 === Interactions for human MDM2 gene and interactions between all interactors of MDM2: ===
 
 **https://​webservice.thebiogrid.org/​interactions/?​searchNames=true&​geneList=MDM2&​taxId=9606&​includeInteractors=true&​includeInteractorInteractions=true&​accesskey=[ACCESSKEY]**
 
 === First 10 interactions for human MDM2 gene: ===
 
 **https://​webservice.thebiogrid.org/​interactions/?​searchNames=true&​geneList=MDM2&​includeInteractors=true&​taxId=9606&​start=0&​max=10&​accesskey=[ACCESSKEY]**
 
 === Interactions between S. cerevisiae CDC27, APC1 and APC2: ===
 
 **[[https://​webservice.thebiogrid.org/​interactions/?​searchNames=true&​geneList=cdc27%7Capc1%7Capc2&​taxId=559292&​accesskey=[ACCESSKEY]|https://​webservice.thebiogrid.org/​interactions/?​searchNames=true&​geneList=cdc27|apc1|apc2&​taxId=559292&​accesskey=[ACCESSKEY]]]**
 
 === Interactions from pubmed IDs 18316726 and 17662948: ===
 
 **[[https://​webservice.thebiogrid.org/​interactions/?​pubmedList=18316726%7C17662948&​accesskey=[ACCESSKEY]|https://​webservice.thebiogrid.org/​interactions/?​pubmedList=18316726|17662948&​accesskey=[ACCESSKEY]]]**
 
 === Interactions between CDC27, APC1 and APC2 excluding ‘Affinity Capture-MS’ and ‘Two-hybrid’ data: ===
 
 **[[https://​webservice.thebiogrid.org/​interactions/?​searchNames=true&​geneList=cdc27%7Capc1%7Capc2&​evidenceList=Affinity Capture-MS%7CTwo-hybrid&​accesskey=[ACCESSKEY]|https://​webservice.thebiogrid.org/​interactions/?​searchNames=true&​geneList=cdc27|apc1|apc2&​evidenceList=Affinity Capture-MS|Two-hybrid&​accesskey=[ACCESSKEY]]]**
 
 === Interactions between genes with REFSEQ IDs NP_001119587 (TP53) or NP_002383 (MDM2), in jsonExtended format ===
 
 **[[https://​webservice.thebiogrid.org/​interactions/?​additionalIdentifierTypes=REFSEQ&​geneList=NP_001119587%7CNP_002383&​format=jsonExtended&​accesskey=[ACCESSKEY]|https://​webservice.thebiogrid.org/​interactions/?​additionalIdentifierTypes=REFSEQ&​geneList=NP_001119587|NP_002383&​format=jsonExtended&​accesskey=[ACCESSKEY]]]**
 
 === Interactions involving Entrez Gene IDs 6783 (SULT1E1), 6820 (SULT2B1), and 55791 (LRIF1) ===
 
 **[[https://​webservice.thebiogrid.org/​interactions/?​geneList=6783%7C6820%7C55791&​searchids=true&​includeInteractors=true&​accessKey=[ACCESSKEY]|https://​webservice.thebiogrid.org/​interactions/?​geneList=6783|6820|55791&​searchids=true&​includeInteractors=true&​accessKey=[ACCESSKEY]]]**
 
 === Interactions involving SGD IDs S000004354 (STE11) and S000003664 (PBS2) ===
 
 **[[https://​webservice.thebiogrid.org/​interactions/?​additionalIdentifierTypes=SGD&​geneList=S000004354%7CS000003664&​includeInteractors=true&​accesskey=[ACCESSKEY]|https://​webservice.thebiogrid.org/​interactions/?​additionalIdentifierTypes=SGD&​geneList=S000004354|S000003664&​includeInteractors=true&​accesskey=[ACCESSKEY]]]**
 
biogridrest.1430083148.txt.gz · Last modified: 2017/08/08 12:52 (external edit)