Skills › Scientific Agent Skills › database-lookup › biogrid.md

biogrid.md

111 lines · skills/database-lookup/references/biogrid.md at 5f2bc03

Open on GitHub

1# BioGRID API Reference

BioGRID API Reference

Raw lines 1 to 2

3## Base URL

4```

5https://webservice.thebiogrid.org/interactions

6```

Base URL

https://webservice.thebiogrid.org/interactions

Raw lines 3 to 7

8## Authentication

9**API key REQUIRED.** Register free at https://webservice.thebiogrid.org/ to obtain an access key.

10- Pass as query parameter: `?accesskey=YOUR_ACCESS_KEY`

Authentication

API key REQUIRED. Register free at https://webservice.thebiogrid.org/ to obtain an access key.

Pass as query parameter: ?accesskey=YOUR_ACCESS_KEY

Raw lines 8 to 11

12## Rate Limits

13Not formally published. Reasonable usage expected.

Rate Limits

Not formally published. Reasonable usage expected.

Raw lines 12 to 14

15## Response Format

16JSON (with `&format=json`), tab-delimited (`&format=tab2`), or XML. Default is tab2.

Response Format

JSON (with &format=json), tab-delimited (&format=tab2), or XML. Default is tab2.

Raw lines 15 to 17

18## Key Endpoints

Key Endpoints

Raw lines 18 to 19

20### 1. Search Interactions by Gene

21```

22GET https://webservice.thebiogrid.org/interactions?accesskey={key}&format=json&searchNames=true&geneList={gene_symbol}&taxId={taxon_id}

23```

24Example — get TP53 interactions in human:

25```

26GET https://webservice.thebiogrid.org/interactions?accesskey=YOUR_KEY&format=json&searchNames=true&geneList=TP53&taxId=9606&max=50

27```

1. Search Interactions by Gene

GET https://webservice.thebiogrid.org/interactions?accesskey={key}&format=json&searchNames=true&geneList={gene_symbol}&taxId={taxon_id}

Example — get TP53 interactions in human:

GET https://webservice.thebiogrid.org/interactions?accesskey=YOUR_KEY&format=json&searchNames=true&geneList=TP53&taxId=9606&max=50

Raw lines 20 to 28

29### 2. Multiple Genes

30```

31GET https://webservice.thebiogrid.org/interactions?accesskey={key}&format=json&searchNames=true&geneList=BRCA1|BRCA2&taxId=9606&max=100

32```

33Separate gene names with `|` (pipe).

2. Multiple Genes

GET https://webservice.thebiogrid.org/interactions?accesskey={key}&format=json&searchNames=true&geneList=BRCA1|BRCA2&taxId=9606&max=100

Separate gene names with | (pipe).

Raw lines 29 to 34

35### 3. Filter by experimental evidence

36```

37GET https://webservice.thebiogrid.org/interactions?accesskey={key}&format=json&searchNames=true&geneList=TP53&taxId=9606&evidenceList=Two-hybrid&includeEvidence=true&max=50

38```

39`evidenceList` is a pipe-separated list of experimental systems, not the words

40`physical` or `genetic`. Without `includeEvidence=true`, listed systems are

41**excluded**. Discover names through `/evidence?accesskey={key}&format=json`.

42To select the broad physical/genetic class, filter returned

43`EXPERIMENTAL_SYSTEM_TYPE` locally. There is no documented

44`experimentalSystemList` query parameter.

3. Filter by experimental evidence

GET https://webservice.thebiogrid.org/interactions?accesskey={key}&format=json&searchNames=true&geneList=TP53&taxId=9606&evidenceList=Two-hybrid&includeEvidence=true&max=50

evidenceList is a pipe-separated list of experimental systems, not the words physical or genetic. Without includeEvidence=true, listed systems are excluded. Discover names through /evidence?accesskey={key}&format=json. To select the broad physical/genetic class, filter returned EXPERIMENTAL_SYSTEM_TYPE locally. There is no documented experimentalSystemList query parameter.

Raw lines 35 to 45

46### 5. Search by BioGRID Interaction ID

47```

48GET https://webservice.thebiogrid.org/interactions/{interaction_id}?accesskey={key}&format=json

49```

5. Search by BioGRID Interaction ID

GET https://webservice.thebiogrid.org/interactions/{interaction_id}?accesskey={key}&format=json

Raw lines 46 to 50

51### 6. Search by PubMed ID

52```

53GET https://webservice.thebiogrid.org/interactions?accesskey={key}&format=json&pubmedList=12345678

54```

6. Search by PubMed ID

GET https://webservice.thebiogrid.org/interactions?accesskey={key}&format=json&pubmedList=12345678

Raw lines 51 to 55

56### 7. Inter-species Interactions

57```

58GET https://webservice.thebiogrid.org/interactions?accesskey={key}&format=json&searchNames=true&geneList=TP53&taxId=9606&interSpeciesExcluded=false

59```

7. Inter-species Interactions

GET https://webservice.thebiogrid.org/interactions?accesskey={key}&format=json&searchNames=true&geneList=TP53&taxId=9606&interSpeciesExcluded=false

Raw lines 56 to 60

61### 8. Include Interactor Annotations

62```

63GET https://webservice.thebiogrid.org/interactions?accesskey={key}&format=json&searchNames=true&geneList=TP53&taxId=9606&includeInteractors=true&max=50

64```

8. Include Interactor Annotations

GET https://webservice.thebiogrid.org/interactions?accesskey={key}&format=json&searchNames=true&geneList=TP53&taxId=9606&includeInteractors=true&max=50

Raw lines 61 to 65

66## Common Query Parameters

67| Parameter | Description |

68|-----------|-------------|

69| `geneList` | Gene symbol(s), pipe-separated |

70| `taxId` | NCBI taxonomy ID (9606=human, 10090=mouse, 559292=yeast) |

71| `max` | Max results to return (default 10000) |

72| `start` | Offset for pagination |

73| `format` | `json`, `tab2`, `extendedTab2`, `count` |

74| `searchNames` | `true` to match official symbols |

75| `selfInteractionsExcluded` | `true` to exclude self-interactions |

76| `evidenceList` | Experimental-system names; set `includeEvidence=true` to include |

77| `throughputTag` | `low` or `high` |

Common Query Parameters

Parameter	Description
`geneList`	Gene symbol(s), pipe-separated
`taxId`	NCBI taxonomy ID (9606=human, 10090=mouse, 559292=yeast)
`max`	Max results to return (default 10000)
`start`	Offset for pagination
`format`	`json`, `tab2`, `extendedTab2`, `count`
`searchNames`	`true` to match official symbols
`selfInteractionsExcluded`	`true` to exclude self-interactions
`evidenceList`	Experimental-system names; set `includeEvidence=true` to include
`throughputTag`	`low` or `high`

Raw lines 66 to 78

79## JSON Response Structure

80```json

81{

82 "12345": {

83 "BIOGRID_INTERACTION_ID": 12345,

84 "ENTREZ_GENE_A": "7157",

85 "ENTREZ_GENE_B": "672",

86 "OFFICIAL_SYMBOL_A": "TP53",

87 "OFFICIAL_SYMBOL_B": "BRCA1",

88 "EXPERIMENTAL_SYSTEM": "Two-hybrid",

89 "EXPERIMENTAL_SYSTEM_TYPE": "physical",

90 "PUBMED_ID": "9482880",

91 "ORGANISM_A": 9606,

92 "ORGANISM_B": 9606,

93 "THROUGHPUT": "Low Throughput",

94 "SCORE": "-"

95 }

96}

97```

JSON Response Structure

{
  "12345": {
    "BIOGRID_INTERACTION_ID": 12345,
    "ENTREZ_GENE_A": "7157",
    "ENTREZ_GENE_B": "672",
    "OFFICIAL_SYMBOL_A": "TP53",
    "OFFICIAL_SYMBOL_B": "BRCA1",
    "EXPERIMENTAL_SYSTEM": "Two-hybrid",
    "EXPERIMENTAL_SYSTEM_TYPE": "physical",
    "PUBMED_ID": "9482880",
    "ORGANISM_A": 9606,
    "ORGANISM_B": 9606,
    "THROUGHPUT": "Low Throughput",
    "SCORE": "-"
  }
}

Raw lines 79 to 98

99## Count-Only Query

100```

101GET https://webservice.thebiogrid.org/interactions?accesskey={key}&format=count&searchNames=true&geneList=TP53&taxId=9606

102```

103Returns just the integer count.

104

Count-Only Query

GET https://webservice.thebiogrid.org/interactions?accesskey={key}&format=count&searchNames=true&geneList=TP53&taxId=9606

Returns just the integer count.

Raw lines 99 to 104

105## Notes

106- BioGRID aggregates curated interaction data from literature.

107- Covers physical (protein-protein) and genetic interactions.

108- For bulk data, use BioGRID downloads (tab-delimited files) at https://downloads.thebiogrid.org/.

109- Cross-reference with STRING for combined interaction evidence.

110

111Official contract: https://wiki.thebiogrid.org/doku.php/biogridrest

Notes

BioGRID aggregates curated interaction data from literature.
Covers physical (protein-protein) and genetic interactions.
For bulk data, use BioGRID downloads (tab-delimited files) at https://downloads.thebiogrid.org/.
Cross-reference with STRING for combined interaction evidence.

Official contract: https://wiki.thebiogrid.org/doku.php/biogridrest

Raw lines 105 to 111