v1

latestOpenAPI 3.0.12026-08-06107337528.9 KB

Virus

Get a virus annotation report by nucleotide accession

Get a virus annotation report by nucleotide accesion. By default, in paged JSON format, but also available in tabular (accept: text/tab-separated-values) or JSON Lines (accept: application/x-ndjson) formats.

get/virus/accession/{accessions}/annotation_report

Path parameters

accessionsstring[] required

One or more nucleotide sequence accessions

Query parameters

filter.refseq_onlyboolean

If true, limit to RefSeq genomes.

filter.annotated_onlyboolean

If true, limit to annotated genomes.

filter.released_sincestring date-time

filter.updated_sincestring date-time

filter.hoststring

Limit to genomes isolated from the specified host species (NCBI Taxonomy ID, common or scientific name).

filter.pangolin_classificationstring

Limit to SARS-CoV-2 genomes from the specified Pango lineage.

filter.geo_locationstring

Limit to genomes collected from the specififed geographic location.

filter.usa_statestring

Limit to genomes collected from the specified U.S. state (two-letter abbreviation).

filter.complete_onlyboolean

Limit to genomes designated as complete, as defined by the submitter.

table_fieldsstring[]

Specify which fields to include in the tabular report. Additional fields are described here: virus annotation report fields. Use of this parameter requires the HTTP header, accept: text/tab-separated-values.

page_sizeinteger

The maximum number of virus data reports to return. Default is 20 and maximum is 1000. If the number of results exceeds the page size, page_token can be used to retrieve the remaining results.

page_tokenstring

A page token is returned when the results count exceeds page size. Use this token along with previous request parameters to retrieve the next page of results. When page_token is empty, all results have been retrieved.

Response

A successful response

total_countinteger

next_page_tokenstring