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 the direct child taxa of a GBIF Backbone taxon. Given a taxonKey (e.g. a genus), returns its…
GBIF_get_taxon_children tool specification
Tool Information:
Name:
GBIF_get_taxon_childrenType:
GBIFTaxonomyToolDescription: List the direct child taxa of a GBIF Backbone taxon. Given a taxonKey (e.g. a genus), returns its immediate children one rank down (e.g. the species in that genus), with key, scientificName, rank and taxonomicStatus for each. Use to walk DOWN the taxonomic tree. Get a taxonKey from GBIF_match_name or GBIF_search_species. Example: taxon_key=2435194 (genus Panthera) -> Panthera leo (5219404), Panthera onca (5219426), Panthera tigris, etc. No API key required.
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).
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_parentsType:
GBIFTaxonomyToolDescription: 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 the taxonomic synonyms (unaccepted names that point to an accepted taxon) of a GBIF Backbone…
GBIF_get_taxon_synonyms tool specification
Tool Information:
Name:
GBIF_get_taxon_synonymsType:
GBIFTaxonomyToolDescription: List the taxonomic synonyms (unaccepted names that point to an accepted taxon) of a GBIF Backbone taxon. Given the taxonKey of an accepted name, returns its synonym name-usages with key, scientificName and taxonomicStatus. Use to find alternative / historical scientific names for a species. Get a taxonKey from GBIF_match_name or GBIF_search_species. Example: taxon_key=5219404 (Panthera leo) -> Felis leo Linnaeus 1758, Felis imperialis Leidy 1873. No API key required.
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).
Example Usage:
query = {
"name": "GBIF_get_taxon_synonyms",
"arguments": {
"taxon_key": 10
}
}
result = tu.run(query)
GBIF_get_vernacular_names (Type: GBIFTaxonomyTool)¶
Get the vernacular (common) names of a GBIF Backbone taxon. Given a taxonKey, returns common name…
GBIF_get_vernacular_names tool specification
Tool Information:
Name:
GBIF_get_vernacular_namesType:
GBIFTaxonomyToolDescription: Get the vernacular (common) names of a GBIF Backbone taxon. Given a taxonKey, returns common names with their language code (ISO 639) and country, de-duplicated. Optionally filter by language. Use to find common names for a species across languages. Get a taxonKey from GBIF_match_name or GBIF_search_species. Example: taxon_key=5219404 (Panthera leo), language=eng -> ‘Lion’, ‘African Lion’. 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.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.
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_nameType:
GBIFTaxonomyToolDescription: 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’, ‘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)