Gbif Tools#

Configuration File: gbif_tools.json Tool Type: Local Tools Count: 2

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

Available Tools#

GBIF_search_occurrences (Type: GBIFOccurrenceTool)#

Retrieve GBIF occurrence records with exact total and offset continuation. Continue with metadata…

GBIF_search_occurrences tool specification

Tool Information:

  • Name: GBIF_search_occurrences

  • Type: GBIFOccurrenceTool

  • Description: Retrieve GBIF occurrence records with exact total and offset continuation. Continue with metadata.next_offset. Search results expose at most the first 100,001 records; refine filters or use GBIF’s download API when metadata.upstream_truncated is true.

Parameters:

  • taxonKey (integer) (optional) GBIF taxon key to filter occurrences by a specific taxon (from species search).

  • country (string) (optional) ISO 3166-1 alpha-2 country code filter (e.g., ‘US’, ‘CN’).

  • hasCoordinate (boolean) (optional) Only return records with valid latitude/longitude coordinates when true.

  • limit (integer) (optional) Maximum number of results to return (1–300).

  • offset (integer) (optional) Zero-based offset. The wrapper enforces GBIF’s current offset + limit <= 100001 window.

Example Usage:

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

GBIF_search_species (Type: GBIFTool)#

Find taxa by scientific/common-name keyword in GBIF with exact total and offset continuation. Con…

GBIF_search_species tool specification

Tool Information:

  • Name: GBIF_search_species

  • Type: GBIFTool

  • Description: Find taxa by scientific/common-name keyword in GBIF with exact total and offset continuation. Continue with metadata.next_offset. GBIF species search exposes at most the first 100,000 ranked matches; refine broad queries when metadata.upstream_truncated is true.

Parameters:

  • query (string) (required) Search string for species/taxa (supports scientific/common names), e.g., ‘Homo’, ‘Atlantic cod’.

  • limit (integer) (optional) Maximum number of results to return (1–1000). GBIF silently clamps larger values to 1000.

  • offset (integer) (optional) Result offset for pagination. The wrapper enforces offset + limit <= 100000.

Example Usage:

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