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.

get/taxonomy/taxon/{taxons}/name_report

Request

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

Path parameters

taxonsstring[] required

Query parameters

page_sizeinteger

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

childrenboolean

If true, return results for child taxa.

ranksV2reportsRankType[]

Limit results to taxa of the specified ranks.

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
    • warning

      deleted the query request parameter include_tabular_header

    • warning

      deleted the query request parameter returned_content

    • warning

      deleted the query request parameter table_format

    • 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