Enterobase-API API

by warwick.ac.uk

HTTP BasicHTTPSOpen Data

Overview

API for EnteroBase (https://enterobase.warwick.ac.uk) EnteroBase is a user-friendly online resource, where users can upload their own sequencing data for de novo assembly by a stream-lined pipeline. The assemblies are used for calling MLST and wgMLST patterns, allowing users to compare their strains to publically available genotyping data from other EnteroBase users, GenBank and classical MLST databases. Click here to find how to get and use an API token: http://bit.ly/1TKlaOU

Enterobase-API is an open data API from warwick.ac.uk. Requests are authenticated with HTTP Basic auth. It is served over HTTPS. Its OpenAPI description documents 26 endpoints.

At a glance

Authentication: HTTP Basic
HTTPS: Yes
CORS: Unknown
Category: Open Data
Version: v2.0
Endpoints: 26
OpenAPI: Specification ↗
Spec updated: 2023-03-06

Endpoints

Method	Path	What it does
GET	`/api/v2.0`	Top level information about EnteroBase databases
GET	`/api/v2.0/login`	Login endpoint, refresh your API token
GET	`/api/v2.0/lookup`	Generic endpoint for lookup list of barcodes
GET	`/api/v2.0/lookup/{barcode}`	Generic endpoint for lookup of barcodes
POST	`/api/v2.0/lookup/{barcode}`	Generic endpoint for lookup of barcodes
GET	`/api/v2.0/{database}/assemblies`	Genome assemblies
GET	`/api/v2.0/{database}/assemblies/{barcode}`	Genome assemblies
POST	`/api/v2.0/{database}/assemblies/{barcode}`	Genome assemblies
PUT	`/api/v2.0/{database}/assemblies/{barcode}`	Genome assemblies
GET	`/api/v2.0/{database}/schemes`	Genotyping schemes
GET	`/api/v2.0/{database}/schemes/{barcode}`	Genotyping schemes
POST	`/api/v2.0/{database}/schemes/{barcode}`	Genotyping schemes
PUT	`/api/v2.0/{database}/schemes/{barcode}`	Genotyping schemes
GET	`/api/v2.0/{database}/straindata`	Strain data
GET	`/api/v2.0/{database}/strains`	Strain metadata
GET	`/api/v2.0/{database}/strains/{barcode}`	Strain metadata
POST	`/api/v2.0/{database}/strains/{barcode}`	Strain metadata
PUT	`/api/v2.0/{database}/strains/{barcode}`	Strain metadata
GET	`/api/v2.0/{database}/strainsversion`	Strain previous metadata
GET	`/api/v2.0/{database}/traces`	Traces (sequence-reads) metadata
GET	`/api/v2.0/{database}/traces/{barcode}`	Traces (sequence-reads) metadata
POST	`/api/v2.0/{database}/traces/{barcode}`	Traces (sequence-reads) metadata
PUT	`/api/v2.0/{database}/traces/{barcode}`	Traces (sequence-reads) metadata
GET	`/api/v2.0/{database}/{scheme}/alleles`	Alleles data
GET	`/api/v2.0/{database}/{scheme}/loci`	Loci
GET	`/api/v2.0/{database}/{scheme}/sts`	ST profile data