NCncats
Taxonomy

Get child nodes, and optionally parent nodes, for a given taxon by Taxonomy ID

Changed on

Get child nodes, and optionally parent nodes, in JSON format.

get/taxonomy/taxon/{tax_id}/related_ids

Request

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

Path parameters

tax_idinteger required

Query parameters

include_lineageboolean

If true, include parent nodes

ranksV2reportsRankType[]

Limit to taxonomic nodes from the given ranks.

page_sizeinteger

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

tax_idsinteger[]
next_page_tokenstring

Changes

  • e5d4400c8e5dRevision changes
    • warning

      deleted the query request parameter include_subtree

  • f08be9b66e16Revision changes
    • info

      added the enum value ACELLULAR_ROOT to the property items/ of the query request parameter ranks

    • info

      added the enum value CELLULAR_ROOT to the property items/ of the query request parameter ranks

    • info

      added the enum value DOMAIN to the property items/ of the query request parameter ranks

    • info

      added the enum value REALM to the property items/ of the query request parameter ranks