NCncats
Taxonomy

Get a list of taxonomy names and IDs by partial taxonomic name

Changed on

Get a list of taxonomy names and IDs in JSON format.

get/taxonomy/taxon_suggest/{taxon_query}

Request

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

Path parameters

taxon_querystring required

Taxonomy ID or name (common or scientific) at any taxonomic rank

Query parameters

tax_rank_filter'species' | 'higher_taxon'

Optionally return results for taxonomic ranks above species using higher_taxon

taxon_resource_filter'TAXON_RESOURCE_FILTER_ALL' | 'TAXON_RESOURCE_FILTER_GENOME' | 'TAXON_RESOURCE_FILTER_GENE' | 'TAXON_RESOURCE_FILTER_ORGANELLE'

Limit to taxonomy nodes with gene, genome or organelle data

exact_matchboolean

If true, only return results that exactly match the provided taxonomic name

Response

A successful response

Changes

  • 6b24249801ecRevision changes
    • breaking

      for the query request parameter tax_rank_filter, default value species was added

    • breaking

      for the query request parameter taxon_resource_filter, default value TAXON_RESOURCE_FILTER_ALL was added

    • info

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

  • f08be9b66e16Revision changes
    • breaking

      for the query request parameter tax_rank_filter, default value species was removed

    • breaking

      for the query request parameter taxon_resource_filter, default value TAXON_RESOURCE_FILTER_ALL was removed

    • warning

      added the new ACELLULAR_ROOT enum value to the // response property for the response status

    • warning

      added the new CELLULAR_ROOT enum value to the // response property for the response status

    • warning

      added the new DOMAIN enum value to the // response property for the response status

    • warning

      added the new REALM enum value to the // response property for the response status

    • info

      the response's property default value NO_RANK was removed for the status