NCncats
Gene

Get a download summary of a gene data package by GeneID

Changed on

Get a download summary of a gene data package, including counts and estimated package size, in JSON format.

get/gene/id/{gene_ids}/download_summary

Request

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

Path parameters

gene_idsinteger[] required

One or more NCBI GeneIDs

Query parameters

include_annotation_typeV2Fasta[]

Specify which sequence files to include in the data package.

returned_content'COMPLETE' | 'IDS_ONLY'

Return complete gene reports, or abbreviated reports with either GeneIDs only or GeneIDs, transcript and protein counts.

fasta_filterstring[]

Limit the FASTA sequences in the datasets package to these transcript and protein accessions (deprecated)

accession_filterstring[]

Limit the contents of the sequence files and tabular product report to the specified RNA and protein accessions

aux_reportV2GeneDatasetRequestGeneDatasetReportType[]

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

tabular_reportsV2GeneDatasetRequestGeneDatasetReportType[]

Specify which tabular report files to include in the data package.

Response

A successful response

record_countinteger
assembly_countinteger
resource_updated_onstring date-time

Changes

  • e5d4400c8e5dRevision changes
    • warning

      deleted the query request parameter table_fields

    • warning

      deleted the query request parameter table_report_type

    • info

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

    • info

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

  • 6b24249801ecRevision changes
    • breaking

      for the query request parameter returned_content, default value COMPLETE was added

    • breaking

      for the query request parameter table_report_type, default value DATASET_REPORT 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