NCncats
Gene

Get a gene data report for a gene ortholog set by GeneID

Changed on

Get a gene data report for a gene ortholog set by GeneID in JSON format.

get/gene/id/{gene_id}/orthologs

Request

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

Path parameters

gene_idinteger required

A single NCBI GeneID

Query parameters

returned_content'COMPLETE' | 'IDS_ONLY'

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

taxon_filterstring[]

Limit to genes from the specified NCBI Taxonomy ID or name (common or scientific) at any taxonomic rank.

page_sizeinteger

The maximum number of gene 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

Changes

  • e5d4400c8e5dRevision changes
    • info

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

    • info

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

    • info

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

    • 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

    • 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_GENE_WARNING_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 none was added for the status

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

      the response's property default value SELECT_UNKNOWN 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 was added for the status

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

      the response's property default value UNKNOWN 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