Gbif Taxonomy Tools#

Configuration File: gbif_taxonomy_tools.json Tool Type: Local Tools Count: 5

This page contains all tools defined in the gbif_taxonomy_tools.json configuration file.

Available Tools#

GBIF_get_taxon_children (Type: GBIFTaxonomyTool)#

List direct child taxa of a GBIF Backbone taxon. Results use GBIF offset pagination; when metadat…

GBIF_get_taxon_children tool specification

Tool Information:

  • Name: GBIF_get_taxon_children

  • Type: GBIFTaxonomyTool

  • Description: List direct child taxa of a GBIF Backbone taxon. Results use GBIF offset pagination; when metadata.has_more is true pass metadata.next_offset as offset with the same taxon_key and limit.

Parameters:

  • taxon_key (integer) (required) GBIF Backbone usageKey of the parent taxon, e.g. 2435194 (genus Panthera). Obtain from GBIF_match_name or GBIF_search_species.

  • limit ([‘integer’, ‘null’]) (optional) Maximum number of child taxa to return (1-100, default 20).

  • offset (integer) (optional) Zero-based GBIF result offset. Continue with metadata.next_offset.

Example Usage:

query = {
    "name": "GBIF_get_taxon_children",
    "arguments": {
        "taxon_key": 10
    }
}
result = tu.run(query)

GBIF_get_taxon_parents (Type: GBIFTaxonomyTool)#

Get the full ranked ancestor lineage of a GBIF Backbone taxon. Given a taxonKey, returns the orde…

GBIF_get_taxon_parents tool specification

Tool Information:

  • Name: GBIF_get_taxon_parents

  • Type: GBIFTaxonomyTool

  • Description: Get the full ranked ancestor lineage of a GBIF Backbone taxon. Given a taxonKey, returns the ordered list of higher taxa from KINGDOM down to the immediate parent (kingdom, phylum, class, order, family, genus…), each with key, rank and scientificName. Use to walk UP the taxonomic tree / build a classification path. Returns a root-first array. Get a taxonKey from GBIF_match_name or GBIF_search_species. Example: taxon_key=5219404 (Panthera leo) -> Animalia, Chordata, Mammalia, Carnivora, Felidae, Panthera. No API key required.

Parameters:

  • taxon_key (integer) (required) GBIF Backbone usageKey of the taxon, e.g. 5219404 (Panthera leo). Obtain from GBIF_match_name or GBIF_search_species.

Example Usage:

query = {
    "name": "GBIF_get_taxon_parents",
    "arguments": {
        "taxon_key": 10
    }
}
result = tu.run(query)

GBIF_get_taxon_synonyms (Type: GBIFTaxonomyTool)#

List taxonomic synonyms of a GBIF Backbone taxon. Results use GBIF offset pagination; when metada…

GBIF_get_taxon_synonyms tool specification

Tool Information:

  • Name: GBIF_get_taxon_synonyms

  • Type: GBIFTaxonomyTool

  • Description: List taxonomic synonyms of a GBIF Backbone taxon. Results use GBIF offset pagination; when metadata.has_more is true pass metadata.next_offset as offset with the same inputs.

Parameters:

  • taxon_key (integer) (required) GBIF Backbone usageKey of the accepted taxon, e.g. 5219404 (Panthera leo). Obtain from GBIF_match_name or GBIF_search_species.

  • limit ([‘integer’, ‘null’]) (optional) Maximum number of synonyms to return (1-100, default 20).

  • offset (integer) (optional) Zero-based GBIF result offset. Continue with metadata.next_offset.

Example Usage:

query = {
    "name": "GBIF_get_taxon_synonyms",
    "arguments": {
        "taxon_key": 10
    }
}
result = tu.run(query)

GBIF_get_vernacular_names (Type: GBIFTaxonomyTool)#

Get de-duplicated vernacular names of a GBIF Backbone taxon, optionally filtered by language. GBI…

GBIF_get_vernacular_names tool specification

Tool Information:

  • Name: GBIF_get_vernacular_names

  • Type: GBIFTaxonomyTool

  • Description: Get de-duplicated vernacular names of a GBIF Backbone taxon, optionally filtered by language. GBIF does not server-filter this endpoint by language, so filtering is applied to each raw page; continue through metadata.next_offset while metadata.has_more is true to avoid missing later names in the requested language.

Parameters:

  • taxon_key (integer) (required) GBIF Backbone usageKey of the taxon, e.g. 5219404 (Panthera leo). Obtain from GBIF_match_name or GBIF_search_species.

  • language ([‘string’, ‘null’]) (optional) Optional ISO 639-3 language code to filter by, e.g. ‘eng’ (English), ‘spa’ (Spanish), ‘fra’ (French). If omitted, returns names in all languages.

  • limit (integer) (optional) Number of raw GBIF vernacular-name records to inspect per page.

  • offset (integer) (optional) Zero-based raw GBIF result offset. Continue with metadata.next_offset even when a language-filtered page returns no names.

Example Usage:

query = {
    "name": "GBIF_get_vernacular_names",
    "arguments": {
        "taxon_key": 10
    }
}
result = tu.run(query)

GBIF_parse_name (Type: GBIFTaxonomyTool)#

Parse one or more scientific name strings into structured components using the GBIF name parser. …

GBIF_parse_name tool specification

Tool Information:

  • Name: GBIF_parse_name

  • Type: GBIFTaxonomyTool

  • Description: Parse one or more scientific name strings into structured components using the GBIF name parser. Returns the canonical name (no authorship), genus, specific/infraspecific epithet, authorship, bracket (basionym) authorship, year and rank marker for each input. Useful for normalizing messy or authored names before matching. No taxonKey needed; this is pure string parsing. No API key required. Example: name=’Panthera leo (Linnaeus, 1758)’ -> canonicalName ‘Panthera leo’, genusOrAbove ‘Panthera’, specificEpithet ‘leo’, bracketAuthorship ‘Linnaeus’.

Parameters:

  • name ([‘string’, ‘null’]) (optional) A single scientific name string to parse, e.g. ‘Panthera leo (Linnaeus, 1758)’. Provide either ‘name’ or ‘names’.

  • names ([‘array’, ‘string’, ‘null’]) (optional) A list of scientific name strings to parse in one call, e.g. [‘Homo sapiens Linnaeus, 1758’, ‘Quercus robur L.’]. Provide either ‘name’ or ‘names’.

Example Usage:

query = {
    "name": "GBIF_parse_name",
    "arguments": {
    }
}
result = tu.run(query)