Sign in

v1

latestOpenAPI 3.0.12026-08-063340143.9 KB
Searching names

Legacy fuzzy name match service (Version 1 - flat format)

Version 1 - Warning: this method will be removed and users are advised to migrate to the version 2 API v2/species/match.

Fuzzy matches scientific names against the GBIF Backbone Taxonomy with the optional classification provided. If a classification is provided and strict is not set to true, the default matching will also try to match against these if no direct match is found for the name parameter alone.

Additionally, a lookup may be performed by providing the usageKey which will short-circuit the name-based matching and ONLY use the given key, either finding the concept or returning no match.

get/v1/species/match

Query parameters

usageKeystring

The usage key to look up. When provided, all other fields are ignored.

namestring

The scientific name to fuzzy match against. May include the authorship and year

authorshipstring

The scientific name authorship to fuzzy match against.

rank'DOMAIN' | 'SUPERKINGDOM' | 'KINGDOM' | 'SUBKINGDOM' | 'INFRAKINGDOM' | 'SUPERPHYLUM' | 'PHYLUM' | 'SUBPHYLUM' | 'INFRAPHYLUM' | 'SUPERCLASS' | 'CLASS' | 'SUBCLASS' | 'INFRACLASS' | 'PARVCLASS' | 'SUPERLEGION' | 'LEGION' | 'SUBLEGION' | 'INFRALEGION' | 'SUPERCOHORT' | 'COHORT' | 'SUBCOHORT' | 'INFRACOHORT' | 'MAGNORDER' | 'SUPERORDER' | 'GRANDORDER' | 'ORDER' | 'SUBORDER' | 'INFRAORDER' | 'PARVORDER' | 'SUPERFAMILY' | 'FAMILY' | 'SUBFAMILY' | 'INFRAFAMILY' | 'SUPERTRIBE' | 'TRIBE' | 'SUBTRIBE' | 'INFRATRIBE' | 'SUPRAGENERIC_NAME' | 'GENUS' | 'SUBGENUS' | 'INFRAGENUS' | 'SECTION' | 'SUBSECTION' | 'SERIES' | 'SUBSERIES' | 'INFRAGENERIC_NAME' | 'SPECIES_AGGREGATE' | 'SPECIES' | 'INFRASPECIFIC_NAME' | 'GREX' | 'SUBSPECIES' | 'CULTIVAR_GROUP' | 'CONVARIETY' | 'INFRASUBSPECIFIC_NAME' | 'PROLES' | 'RACE' | 'NATIO' | 'ABERRATION' | 'MORPH' | 'VARIETY' | 'SUBVARIETY' | 'FORM' | 'SUBFORM' | 'PATHOVAR' | 'BIOVAR' | 'CHEMOVAR' | 'MORPHOVAR' | 'PHAGOVAR' | 'SEROVAR' | 'CHEMOFORM' | 'FORMA_SPECIALIS' | 'CULTIVAR' | 'STRAIN' | 'OTHER' | 'UNRANKED'

Filters by taxonomic rank as given in our https://api.gbif.org/v1/enumeration/basic/Rank[Rank enum].

genericNamestring

Generic part of the name to match when given as atomised parts instead of the full name parameter.

specificEpithetstring

Specific epithet to match.

infraspecificEpithetstring

Infraspecific epithet to match.

excludeinteger[]
strictboolean

If true it fuzzy matches only the given name, but never a taxon in the upper classification.

verboseboolean

If true it shows alternative matches which were considered but then rejected.

kingdomstring

Kingdom to match.

phylumstring

Phylum to match.

orderstring

Order to match.

classstring

Class to match.

familystring

Family to match.

genusstring

Genus to match.

Response

Name usage suggestions found

object required