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 for a list of endpoints that are currently supported.

This client supports automatic rate-limiting per the Ensembl REST API documentation.

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
• Cross References
  • ID
  • Name
  • Symbol
• Information
• Linkage Disequilibrium
  • For variant
  • For region
  • Pairwise
• Lookup
  • Id
  • Ids
  • Symbol
  • Symbols
• Mapping
• Ontologies and Taxonomy
• Phenotype Annotations
• Overlap
• Regulation
• Sequence
• Transcript Haplotypes
• VEP
• Variation
• Variation GA4GH