Skill Tracer
Skills › Scientific Agent Skills › database-lookup › gwas-catalog.md

gwas-catalog.md

48 lines · skills/database-lookup/references/gwas-catalog.md at 5f2bc03

Open on GitHub
1# GWAS Catalog (EBI)
2

GWAS Catalog (EBI)

Raw lines 1 to 2
3## Base URL
4```
5https://www.ebi.ac.uk/gwas/rest/api
6```
7

Base URL

https://www.ebi.ac.uk/gwas/rest/api
Raw lines 3 to 7
8## Auth
9No API key required.

Auth

No API key required.

Raw lines 8 to 10
11## Note: Responses use HAL+JSON format with `_links` and `_embedded` keys.

Note: Responses use HAL+JSON format with _links and _embedded keys.

Raw lines 11 to 12
13## Key Endpoints
15| Endpoint | Description |
16|----------|-------------|
17| `/studies/{accession}` | Single study (e.g. GCST001633) |
18| `/studies/search/findByPublicationIdPubmedId?pubmedId={id}` | Studies by PubMed ID |
19| `/singleNucleotidePolymorphisms/{rsId}` | SNP details |
20| `/singleNucleotidePolymorphisms/{rsId}/associations` | Associations for a SNP |
21| `/singleNucleotidePolymorphisms/search/findByRsId?rsId={rsId}` | Search by rsID |
22| `/associations` | List associations |
23| `/associations/{id}` | Single association |
24| `/efoTraits` | List EFO traits |
25| `/efoTraits/search/findByEfoTrait?trait={name}` | Search traits |

Key Endpoints

EndpointDescription
/studies/{accession}Single study (e.g. GCST001633)
/studies/search/findByPublicationIdPubmedId?pubmedId={id}Studies by PubMed ID
/singleNucleotidePolymorphisms/{rsId}SNP details
/singleNucleotidePolymorphisms/{rsId}/associationsAssociations for a SNP
/singleNucleotidePolymorphisms/search/findByRsId?rsId={rsId}Search by rsID
/associationsList associations
/associations/{id}Single association
/efoTraitsList EFO traits
/efoTraits/search/findByEfoTrait?trait={name}Search traits
Raw lines 13 to 26
27## Pagination
28`?page=0&size=20` (zero-indexed, max ~500)

Pagination

?page=0&size=20 (zero-indexed, max ~500)

Raw lines 27 to 29
30## Example Calls
31```
32# Get a study
33https://www.ebi.ac.uk/gwas/rest/api/studies/GCST001633
35# Associations for a SNP
36https://www.ebi.ac.uk/gwas/rest/api/singleNucleotidePolymorphisms/rs7329174/associations
38# Search traits
39https://www.ebi.ac.uk/gwas/rest/api/efoTraits/search/findByEfoTrait?trait=diabetes&page=0&size=5
40```

Example Calls

# Get a study
https://www.ebi.ac.uk/gwas/rest/api/studies/GCST001633

# Associations for a SNP
https://www.ebi.ac.uk/gwas/rest/api/singleNucleotidePolymorphisms/rs7329174/associations

# Search traits
https://www.ebi.ac.uk/gwas/rest/api/efoTraits/search/findByEfoTrait?trait=diabetes&page=0&size=5
Raw lines 30 to 41
42## Response Format
43HAL+JSON. Results in `_embedded.studies[]` or `_embedded.associations[]`. Key fields: `pvalue`, `riskFrequency`, `orPerCopyNum`, `betaNum`.

Response Format

HAL+JSON. Results in _embedded.studies[] or _embedded.associations[]. Key fields: pvalue, riskFrequency, orPerCopyNum, betaNum.

Raw lines 42 to 44
45## Rate Limits
46No published limit. Bulk data via FTP at ftp.ebi.ac.uk/pub/databases/gwas/
48Follow HAL `_links.next.href` until absent and inspect `_links.search` for exact finder names/parameters. The official endpoint catalogue is https://www.ebi.ac.uk/gwas/rest/documents/api.html.

Rate Limits

No published limit. Bulk data via FTP at ftp.ebi.ac.uk/pub/databases/gwas/

Follow HAL _links.next.href until absent and inspect _links.search for exact finder names/parameters. The official endpoint catalogue is https://www.ebi.ac.uk/gwas/rest/documents/api.html.

Raw lines 45 to 48