Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

National Institutes of Health (NIH)

National Institutes of Health (NIH) Virus API

#### Options to download virus genome data, including the associated sequence and metadata.These virus services allow you to get virus genome metadata as a data report or download genome and protein sequence, and metadata, as a virus data package, for virus GenBank genomes.

Documentation Provider Profile APIs.io OpenAPI GitHub

National Institutes of Health (NIH) Virus API is one of 15 APIs that National Institutes of Health (NIH) publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Virus. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 19 operations across 19 paths, and defines 51 schemas. It is described by OpenAPI 3.0.3, at version 2.0.5.

Requests are made against a single base URL, https://clinicaltrials.gov/api/v2.

19 operations 19 paths 51 schemas 12 GET7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0.5
Base URL
https://eutils.ncbi.nlm.nih.gov/entrez/eutils/
Resource Areas
1

Paths & Operations 19

Across 19 paths, the API surfaces 19 operations — 12 GET, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Virus 19

Options to download virus genome data, including the associated sequence and metadata. These virus services allow you to get virus genome metadata as a data report or download gen…

GET
/virus/taxon/{taxon}/genome
Get a download summary of a virus genome data package by taxon
virus_genome_summary 13 params → default200
POST
/virus/genome
Get a download summary of a virus genome data package
virus_genome_summary_by_post body → default200
GET
/virus/taxon/sars2/protein/{proteins}
Get a download summary of a SARS-CoV-2 protein data package by protein name
sars2_protein_summary 12 params → default200
POST
/virus/taxon/sars2/protein
Get a download summary of a SARS-CoV-2 protein data package by protein name
sars2_protein_summary_by_post body → default200
GET
/virus/taxon/{taxon}/genome/tabledeprecated
Get virus genome metadata in a tabular format
virus_genome_table 15 params → default200
GET
/virus/taxon/sars2/protein/{proteins}/table
Get SARS-CoV-2 protein metadata in a tabular format by protein name
sars2_protein_table 12 params → default200
GET
/virus/taxon/{taxon}/dataset_report
Get a virus data report by taxon
virus_reports_by_taxon 14 params → default200
GET
/virus/accession/{accessions}/dataset_report
Get a virus data report by nucleotide accession
virus_reports_by_acessions 14 params → default200
POST
/virus
Get a virus data report
virus_reports_by_post body → default200
GET
/virus/taxon/{taxon}/annotation_report
Get a virus annotation report by taxon
virus_annotation_reports_by_taxon 13 params → default200
GET
/virus/accession/{accessions}/annotation_report
Get a virus annotation report by nucleotide accession
virus_annotation_reports_by_acessions 13 params → default200
POST
/virus/annotation_report
Get a virus annotation report
virus_annotation_reports_by_post body → default200
GET
/virus/accession/{accessions}/check
Check the validity of a virus genome nucleotide accession
virus_accession_availability 1 param → default200
POST
/virus/check
Check the validity of a virus genome nucleotide accession
virus_accession_availability_post body → default200
GET
/virus/taxon/{taxon}/genome/download
Get a virus genome data package by taxon
virus_genome_download 14 params → default200
GET
/virus/accession/{accessions}/genome/download
Get a virus genome data package by nucleotide accession
virus_genome_download_accession 15 params → default200
POST
/virus/genome/download
Get a virus genome data package
virus_genome_download_post 1 param body → default200
GET
/virus/taxon/sars2/protein/{proteins}/download
Get a SARS-CoV-2 protein data package by protein name
sars2_protein_download 13 params → default200
POST
/virus/taxon/sars2/protein/download
Get a SARS-CoV-2 protein data package
sars2_protein_download_post 1 param body → default200

Schemas 51

The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are v2reportsVirusAssembly (27 properties), v2VirusDatasetRequest (17 properties), v2Sars2ProteinDatasetRequest (14 properties), v2VirusAnnotationFilter (12 properties). Each schema is shown below with its type and property counts.

v2reportsWarning
object
5 properties
v2reportsErrorOrganelleErrorCode
string
v2reportsVirusAnnotationReportPage
object
3 properties
v2reportsVirusAssembly
object
27 properties
v2reportsErrorAssemblyErrorCode
string
v2reportsOrientation
string
v2DownloadSummaryAvailableFiles
object
9 properties
v2VirusAnnotationFilter
object
12 properties
v2reportsConservedDomain
object
3 properties
v2reportsRange
object
5 properties
v2reportsVirusDataReportPage
object
3 properties
v2reportsError
object
8 properties
v2reportsVirusPeptideUniProtId
object
2 properties
v2reportsPurposeOfSampling
string
v2reportsVirusAssemblyCollectionLocation
object
3 properties
v2reportsInfraspecificNames
object
6 properties
v2DownloadSummary
object
8 properties
v2Sars2ProteinDatasetRequest
object
14 properties
v2reportsWarningReplacedId
object
2 properties
v2reportsErrorVirusErrorCode
string
v2VirusDataReportRequest
object
6 properties
v2VirusDatasetFilter
object
12 properties
v2reportsVirusPeptide
object
10 properties
v2DownloadSummaryFileSummary
object
2 properties
v2DownloadSummaryDehydrated
object
4 properties
v2ViralSequenceType
string
v2reportsVirusGene
object
4 properties
v2TabularOutput
object
1 property
v2reportsVirusPeptideViralPeptideCompleteness
string
v2VirusAvailabilityRequest
object
1 property
v2VirusAnnotationReportRequest
object
5 properties
v2reportsSeqRangeSetFasta
object
5 properties
v2reportsLineageOrganism
object
2 properties
v2reportsErrorTaxonomyErrorCode
string
v2VirusAvailability
object
3 properties
v2DownloadSummaryHydrated
object
3 properties
v2TableFormat
string
protobufAny
object
2 properties
v2VirusTableField
string
v2reportsMessage
object
2 properties
v2reportsErrorGeneErrorCode
string
v2reportsIsolate
object
3 properties
v2reportsOrganism
object
8 properties
v2VirusDatasetReportType
string
v2VirusDataReportRequestContentType
string
v2reportsVirusAnnotationReport
object
3 properties
rpcStatus
object
3 properties
v2reportsWarningGeneWarningCode
string
v2reportsVirusAssemblyCompleteness
string
v2VirusDatasetRequest
object
17 properties
v2reportsVirusAssemblySubmitterInfo
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nih-virus-api-openapi.yml Raw ↑

Other APIs National Institutes of Health (NIH) publishes across the network.

NCBI E-utilities (Entrez Programming Utilities)
AE Profile APIs.io
PubChem Power User Gateway (PUG REST)
AE Profile APIs.io
NIH RePORTER API
AE Profile APIs.io
NCBI BLAST URL API
AE Profile APIs.io
PubMed Central (PMC) OA API
AE Profile APIs.io
National Institutes of Health (NIH) BioSample API
AE Profile APIs.io
National Institutes of Health (NIH) Gene API
AE Profile APIs.io
National Institutes of Health (NIH) Genome API
AE Profile APIs.io
National Institutes of Health (NIH) Organelle API
AE Profile APIs.io
National Institutes of Health (NIH) Prokaryote API
AE Profile APIs.io
National Institutes of Health (NIH) Stats API
AE Profile APIs.io
National Institutes of Health (NIH) Studies API
AE Profile APIs.io
#Virus
← Back to N APIs
API Details
ID
nih:nih-virus-api
Base URL
https://eutils.ncbi.nlm.nih.gov/entrez/eutils/
Docs
https://www.ncbi.nlm.nih.gov/home/develop/api/
Provider
National Institutes of Health (NIH)
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network