NCncats
Taxonomy

Get a taxonomy names report by taxon

Changed on

Get a taxonomy names report, including common names and other synonyms, in JSON format.

post/taxonomy/name_report

Request

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

Request body

taxonsstring[]
returned_content'COMPLETE' | 'TAXIDS' | 'METADATA'
page_sizeinteger
include_tabular_header'INCLUDE_TABULAR_HEADER_FIRST_PAGE_ONLY' | 'INCLUDE_TABULAR_HEADER_ALWAYS' | 'INCLUDE_TABULAR_HEADER_NEVER'
page_tokenstring
table_format'SUMMARY'
childrenboolean
ranksV2reportsRankType[]

Response

A successful response

total_countinteger
next_page_tokenstring

Changes

  • b24db4bc7ca5Revision changes
    • info

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

  • 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