https://github.com/riyavsinha/ensembl-node-api
Unofficial NodeJS API client for Ensembl's REST API
https://github.com/riyavsinha/ensembl-node-api
api ensembl genomics nodejs
Last synced: 2 months ago
JSON representation
Unofficial NodeJS API client for Ensembl's REST API
- Host: GitHub
- URL: https://github.com/riyavsinha/ensembl-node-api
- Owner: riyavsinha
- License: mit
- Created: 2023-08-28T02:59:26.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-23T09:44:19.000Z (almost 3 years ago)
- Last Synced: 2025-01-04T17:32:40.518Z (over 1 year ago)
- Topics: api, ensembl, genomics, nodejs
- Language: TypeScript
- Homepage:
- Size: 25.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ensembl-node-api
Unofficial NodeJS API client for Ensembl's REST API
It is extremely limited in scope currently. Help is welcome to incrementally expand it. See [Supported Endpoints](#supported-endpoints) for a list of endpoints that are currently supported.
This client supports automatic rate-limiting per the [Ensembl REST API documentation](https://github.com/Ensembl/ensembl-rest/wiki/Rate-Limits).
## Usage
### Installation
```
npm install ensembl-node-api
```
### Example
```
import { EnsemblClient } from 'ensembl-node-api';
const client = new EnsemblClient();
console.log(await client.xref.externalSymbol({
species: 'human',
symbol: 'BRCA2'
}))
```
## Supported Endpoints
- [ ] Archive
- [ ] Comparative Genomics
- [x] Cross References
- [x] ID
- [x] Name
- [x] Symbol
- [ ] Information
- [x] Linkage Disequilibrium
- [x] For variant
- [x] For region
- [x] Pairwise
- [ ] Lookup
- [x] Id
- [ ] Ids
- [ ] Symbol
- [ ] Symbols
- [ ] Mapping
- [ ] Ontologies and Taxonomy
- [ ] Phenotype Annotations
- [ ] Overlap
- [ ] Regulation
- [ ] Sequence
- [ ] Transcript Haplotypes
- [ ] VEP
- [ ] Variation
- [ ] Variation GA4GH