NCncats
Virus

Get SARS-CoV-2 protein metadata in a tabular format by protein name

Changed on

Get SARS-CoV-2 protein metadata in a tabular format by protein name.

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

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.

table_fieldsV2VirusTableField[]

Specify which fields to include in the tabular report

format'tsv' | 'csv' | 'jsonl'

Specify output format

filenamestring

Output file name.

Response

A successful response

content_typestring
datastring byte

Changes

  • 3f573d3bf03fRevision changes
    • info

      added the new optional query request parameter filename

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • e5d4400c8e5dRevision changes
    • warning

      deleted the query request parameter aux_report

    • warning

      deleted the query request parameter include_sequence