Warwick

Enterobase-API

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…

Data & analytics#openapi#open-data

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

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

Endpoints 26

Info

  • GETGET /api/v2.0/api/v2.0?prefix=string&name=string&description=stringTop level information about EnteroBase databases

Login

  • GETGET /api/v2.0/login/api/v2.0/login?username=string&password=stringLogin endpoint, refresh your API token

Lookup

  • GETGET /api/v2.0/lookup/api/v2.0/lookup?barcode=stringGeneric endpoint for lookup list of barcodes
  • GETGET /api/v2.0/lookup/{barcode}/api/v2.0/lookup/:barcodeGeneric endpoint for lookup of barcodes
  • POSTPOST /api/v2.0/lookup/{barcode}/api/v2.0/lookup/:barcodeGeneric endpoint for lookup of barcodes

Assemblies

  • GETGET /api/v2.0/{database}/assemblies/api/v2.0/:database/assemblies?orderby=barcode&only_fields=string&barcode=string&n50=0&top_species=string&uberstrain=string&version=0&limit=50&reldate=0&offset=0&assembly_status=string&sortorder=ascGenome assemblies
  • GETGET /api/v2.0/{database}/assemblies/{barcode}/api/v2.0/:database/assemblies/:barcodeGenome assemblies
  • PUTPUT /api/v2.0/{database}/assemblies/{barcode}/api/v2.0/:database/assemblies/:barcodeGenome assemblies
  • POSTPOST /api/v2.0/{database}/assemblies/{barcode}/api/v2.0/:database/assemblies/:barcodeGenome assemblies

Schemes

  • GETGET /api/v2.0/{database}/schemes/api/v2.0/:database/schemes?orderby=barcode&scheme_name=string&created=2024-01-01T00:00:00Z&lastmodified=2024-01-01T00:00:00Z&barcode=string&label=string&only_fields=string&version=0&limit=50&sortorder=asc&offset=0Genotyping schemes
  • GETGET /api/v2.0/{database}/schemes/{barcode}/api/v2.0/:database/schemes/:barcodeGenotyping schemes
  • PUTPUT /api/v2.0/{database}/schemes/{barcode}/api/v2.0/:database/schemes/:barcodeGenotyping schemes
  • POSTPOST /api/v2.0/{database}/schemes/{barcode}/api/v2.0/:database/schemes/:barcodeGenotyping schemes

Straindata

  • GETGET /api/v2.0/{database}/straindata/api/v2.0/:database/straindata?comment=string&secondary_sample_accession=string&my_strains=true&offset=0&serotype=string&n50=0&county=string&only_fields=string&postcode=string&lab_contact=string&substrains=true&custom_fields=string&city=string&strain_name=string&collection_date=0&collection_month=0&reldate=0&continent=string&source_details=string&version=0&latitude=0.0&email=string&source_niche=string&barcode=string&uberstrain=string&sortorder=asc&collection_year=0&orderby=string&assembly_status=string&source_type=string&country=string&region=string&longitude=0.0&sample_accession=string&limit=50&top_species=string&collection_time=stringStrain data

Strains

  • GETGET /api/v2.0/{database}/strains/api/v2.0/:database/strains?comment=string&secondary_sample_accession=string&antigenic_formulas=string&my_strains=true&serotype=string&county=string&only_fields=string&postcode=string&lab_contact=string&substrains=true&city=string&strain_name=string&collection_date=0&collection_month=0&reldate=0&continent=string&source_details=string&version=0&latitude=0.0&assembly_barcode=string&source_niche=string&barcode=string&uberstrain=string&sortorder=asc&offset=0&collection_year=0&orderby=barcode&return_all=true&source_type=string&country=string&region=string&longitude=0.0&sample_accession=string&limit=50&collection_time=stringStrain metadata
  • GETGET /api/v2.0/{database}/strains/{barcode}/api/v2.0/:database/strains/:barcodeStrain metadata
  • PUTPUT /api/v2.0/{database}/strains/{barcode}/api/v2.0/:database/strains/:barcodeStrain metadata
  • POSTPOST /api/v2.0/{database}/strains/{barcode}/api/v2.0/:database/strains/:barcodeStrain metadata

Strainsversion

  • GETGET /api/v2.0/{database}/strainsversion/api/v2.0/:database/strainsversion?comment=string&secondary_sample_accession=string&antigenic_formulas=string&my_strains=true&serotype=string&county=string&only_fields=string&postcode=string&lab_contact=string&substrains=true&city=string&strain_name=string&collection_date=0&collection_month=0&reldate=0&continent=string&source_details=string&version=0&latitude=0.0&assembly_barcode=string&source_niche=string&barcode=string&uberstrain=string&sortorder=asc&offset=0&collection_year=0&orderby=barcode&return_all=true&source_type=string&country=string&region=string&longitude=0.0&sample_accession=string&limit=50&collection_time=stringStrain previous metadata

Traces

  • GETGET /api/v2.0/{database}/traces/api/v2.0/:database/traces?orderby=barcode&barcode=string&only_fields=string&limit=50&sortorder=asc&offset=0Traces (sequence-reads) metadata
  • GETGET /api/v2.0/{database}/traces/{barcode}/api/v2.0/:database/traces/:barcodeTraces (sequence-reads) metadata
  • PUTPUT /api/v2.0/{database}/traces/{barcode}/api/v2.0/:database/traces/:barcodeTraces (sequence-reads) metadata
  • POSTPOST /api/v2.0/{database}/traces/{barcode}/api/v2.0/:database/traces/:barcodeTraces (sequence-reads) metadata

Alleles

  • GETGET /api/v2.0/{database}/{scheme}/alleles/api/v2.0/:database/:scheme/alleles?allele_id=string&seq=string&barcode=string&reldate=0&locus=string&only_fields=string&limit=50&offset=0Alleles data

Loci

  • GETGET /api/v2.0/{database}/{scheme}/loci/api/v2.0/:database/:scheme/loci?barcode=string&locus=string&only_fields=string&create_time=2024-01-01T00:00:00Z&limit=50&offset=0&scheme=stringLoci

Sts

  • GETGET /api/v2.0/{database}/{scheme}/sts/api/v2.0/:database/:scheme/sts?st_id=string&scheme=string&show_alleles=true&barcode=string&only_fields=string&limit=50&reldate=0&offset=0ST profile data

API details

Authentication
HTTP Basic authentication (username and password)
Operations
26 operations on 17 pathsGET 17POST 5PUT 4
Main resources
Assemblies 4Schemes 4Strains 4Traces 4Lookup 3Alleles 1Info 1Loci 1Login 1Straindata 1
Description format
OpenAPI 3.0.0, API version v2.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Enterobase-API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Enterobase-API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “GET /api/v2.0” (GET /api/v2.0?prefix=string&name=string&description=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Enterobase-API?

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… It is listed under Data & analytics and has 26 endpoints.

Who publishes the Enterobase-API?

It is listed from Warwick's public API description (an OpenAPI document), not published by Warwick on Swastik Codes. Anyone who controls warwick.ac.uk can claim the profile by adding a DNS TXT record.

How do I authenticate with the Enterobase-API?

With HTTP Basic authentication (username and password).

How many endpoints does the Enterobase-API have?

26 operations on 17 paths (17 GET, 5 POST, 4 PUT). The largest groups are Assemblies, Schemes, Strains, Traces.

Is forking the Enterobase-API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.