NCncats
Virus

Get a download summary of a virus genome data package

Changed on

Get a download summary of a virus genome data package, including counts and file sizes, in JSON format.

post/virus/genome

Request

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

Request body

accessionsstring[]
taxonstring
taxonsstring[]
refseq_onlyboolean
annotated_onlyboolean
released_sincestring date-time
updated_sincestring date-time
hoststring
pangolin_classificationstring
geo_locationstring
usa_statestring
complete_onlyboolean
table_fieldsV2VirusTableField[]
include_sequenceV2ViralSequenceType[]
aux_reportV2VirusDatasetReportType[]
format'tsv' | 'csv' | 'jsonl'
use_psgboolean

Response

A successful response

record_countinteger
assembly_countinteger
resource_updated_onstring date-time

Changes

  • e5d4400c8e5dRevision changes
    • breaking

      removed the enum value BIOSAMPLE of the request property /

    • 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 request property default value DATASET_REPORT was added

    • info

      the request property default value GENOME was added

    • info

      the request property default value unspecified was added

    • info

      the request property default value tsv was added

    • 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