NCncats
Virus

Get a download summary of a SARS-CoV-2 protein data package by protein name

Changed on

Get a download summary of a SARS-CoV-2 protein data package, including counts and file sizes, in JSON format.

get/virus/taxon/sars2/protein/{proteins}

Request

  • Base URL
    https://api.ncbi.nlm.nih.gov/datasets/v2
  • Auth
    API key in header api-key

Path parameters

proteinsstring[] required

One or more SARS-CoV-2 protein names

Query parameters

refseq_onlyboolean

If true, limit results to RefSeq genomes.

annotated_onlyboolean

If true, limit results to annotated genomes.

released_sincestring date-time
updated_sincestring date-time
hoststring

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

pangolin_classificationstring

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

geo_locationstring

Limit to genomes collected from the specififed geographic location.

usa_statestring

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

complete_onlyboolean

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

include_sequenceV2ViralSequenceType[]

Specify which sequence files to include in the data package.

aux_reportV2VirusDatasetReportType[]

Specify which report files to include in the data package. The virus data report is always included, and its inclusion is not affected by this parameter.

Response

A successful response

record_countinteger
assembly_countinteger
resource_updated_onstring date-time

Changes

  • e5d4400c8e5dRevision changes
    • breaking

      removed the enum value BIOSAMPLE from the property items/ of the query request parameter include_sequence

    • info

      added the optional property // to the response with the status

    • info

      added the optional property /// to the response with the status

  • 6b24249801ecRevision changes
    • info

      the response's property default value UNKNOWN_ASSEMBLY_ERROR_CODE was added for the status

    • info

      the response's property default value UNKNOWN_ASSEMBLY_ERROR_CODE was added for the status

    • info

      the response's property default value UNKNOWN_GENE_ERROR_CODE was added for the status

    • info

      the response's property default value UNKNOWN_GENE_ERROR_CODE was added for the status

    • info

      the response's property default value UNKNOWN_GENE_WARNING_CODE was added for the status

    • info

      the response's property default value UNKNOWN_ORGANELLE_ERROR_CODE was added for the status

    • info

      the response's property default value UNKNOWN_ORGANELLE_ERROR_CODE was added for the status

    • info

      the response's property default value UNKNOWN_TAXONOMY_ERROR_CODE was added for the status

    • info

      the response's property default value UNKNOWN_TAXONOMY_ERROR_CODE was added for the status

    • info

      the response's property default value UNKNOWN_VIRUS_ERROR_CODE was added for the status

    • info

      the response's property default value UNKNOWN_VIRUS_ERROR_CODE was added for the status