Sign in

v1

latestOpenAPI 3.0.12026-08-063340143.9 KB
Searching names

Name autocomplete service

A quick and simple autocomplete service that returns up to 20 name usages by doing prefix matching against the scientific name.

Results are ordered by relevance.

get/v1/species/suggest

Query parameters

datasetKeystring uuid

A UUID of a checklist dataset.

constituentKeystring uuid

The (sub)dataset constituent key as a UUID. Useful to query larger assembled datasets such as the GBIF Backbone or the Catalogue of Life

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].

Filters by any of the higher Linnean rank keys. Note this is within the respective checklist and not searching NUB keys across all checklists.

status'ACCEPTED' | 'DOUBTFUL' | 'SYNONYM' | 'HETEROTYPIC_SYNONYM' | 'HOMOTYPIC_SYNONYM' | 'PROPARTE_SYNONYM' | 'MISAPPLIED'

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

isExtinctboolean

Filters by extinction status.

habitat'MARINE' | 'FRESHWATER' | 'TERRESTRIAL'

Filters by the habitat. Currently only 3 major biomes are accepted in our https://api.gbif.org/v1/enumeration/basic/Habitat[Habitat enum].

threat'EXTINCT' | 'EXTINCT_IN_THE_WILD' | 'REGIONALLY_EXTINCT' | 'CRITICALLY_ENDANGERED' | 'ENDANGERED' | 'VULNERABLE' | 'NEAR_THREATENED' | 'LEAST_CONCERN' | 'DATA_DEFICIENT' | 'NOT_APPLICABLE' | 'NOT_EVALUATED'

Filters by the taxonomic threat status as given in our https://api.gbif.org/v1/enumeration/basic/ThreatStatus[ThreatStatus enum].

nameType'SCIENTIFIC' | 'VIRUS' | 'HYBRID' | 'INFORMAL' | 'CULTIVAR' | 'CANDIDATUS' | 'OTU' | 'DOUBTFUL' | 'PLACEHOLDER' | 'NO_NAME' | 'BLACKLISTED'

Filters by the name type as given in our https://api.gbif.org/v1/enumeration/basic/NameType[NameType enum].

nomenclaturalStatus'LEGITIMATE' | 'VALIDLY_PUBLISHED' | 'NEW_COMBINATION' | 'REPLACEMENT' | 'CONSERVED' | 'PROTECTED' | 'CORRECTED' | 'ORIGINAL_COMBINATION' | 'NEW_SPECIES' | 'NEW_GENUS' | 'ALTERNATIVE' | 'OBSCURE' | 'CONSERVED_PROPOSED' | 'PROVISIONAL' | 'SUBNUDUM' | 'REJECTED_PROPOSED' | 'REJECTED_OUTRIGHT_PROPOSED' | 'DOUBTFUL' | 'AMBIGUOUS' | 'CONFUSED' | 'FORGOTTEN' | 'ABORTED' | 'ORTHOGRAPHIC_VARIANT' | 'SUPERFLUOUS' | 'NUDUM' | 'NULL_NAME' | 'SUPPRESSED' | 'REJECTED_OUTRIGHT' | 'REJECTED' | 'ILLEGITIMATE' | 'INVALID' | 'DENIED'

Filters by the nomenclatural status as given in our https://api.gbif.org/v1/enumeration/basic/NomenclaturalStatus[Nomenclatural Status enum].

origin'SOURCE' | 'DENORMED_CLASSIFICATION' | 'VERBATIM_PARENT' | 'VERBATIM_ACCEPTED' | 'VERBATIM_BASIONYM' | 'PROPARTE' | 'AUTONYM' | 'IMPLICIT_NAME' | 'MISSING_ACCEPTED' | 'BASIONYM_PLACEHOLDER' | 'EX_AUTHOR_SYNONYM' | 'OTHER'

Filters for name usages with a specific origin.

issue'PARENT_NAME_USAGE_ID_INVALID' | 'ACCEPTED_NAME_USAGE_ID_INVALID' | 'ORIGINAL_NAME_USAGE_ID_INVALID' | 'ACCEPTED_NAME_MISSING' | 'RANK_INVALID' | 'NOMENCLATURAL_STATUS_INVALID' | 'TAXONOMIC_STATUS_INVALID' | 'SCIENTIFIC_NAME_ASSEMBLED' | 'CHAINED_SYNOYM' | 'BASIONYM_AUTHOR_MISMATCH' | 'TAXONOMIC_STATUS_MISMATCH' | 'PARENT_CYCLE' | 'CLASSIFICATION_RANK_ORDER_INVALID' | 'CLASSIFICATION_NOT_APPLIED' | 'VERNACULAR_NAME_INVALID' | 'DESCRIPTION_INVALID' | 'DISTRIBUTION_INVALID' | 'SPECIES_PROFILE_INVALID' | 'MULTIMEDIA_INVALID' | 'BIB_REFERENCE_INVALID' | 'ALT_IDENTIFIER_INVALID' | 'BACKBONE_MATCH_NONE' | 'BACKBONE_MATCH_FUZZY' | 'BACKBONE_MATCH_AGGREGATE' | 'ACCEPTED_NAME_NOT_UNIQUE' | 'PARENT_NAME_NOT_UNIQUE' | 'ORIGINAL_NAME_NOT_UNIQUE' | 'RELATIONSHIP_MISSING' | 'ORIGINAL_NAME_DERIVED' | 'CONFLICTING_BASIONYM_COMBINATION' | 'NO_SPECIES' | 'NAME_PARENT_MISMATCH' | 'ORTHOGRAPHIC_VARIANT' | 'HOMONYM' | 'PUBLISHED_BEFORE_GENUS' | 'UNPARSABLE' | 'PARTIALLY_PARSABLE'

A specific indexing issue as defined in our https://api.gbif.org/v1/enumeration/basic/NameUsageIssue[NameUsageIssue enum].

qstring

Simple full text search parameter. The value for this parameter can be a simple word or a phrase. Wildcards are not supported

Response

Name usage suggestions found

keyinteger
nameKeyinteger
kingdomstring
phylumstring
orderstring
familystring
genusstring
subgenusstring
speciesstring
kingdomKeyinteger
phylumKeyinteger
classKeyinteger
orderKeyinteger
familyKeyinteger
genusKeyinteger
subgenusKeyinteger
speciesKeyinteger
parentstring
parentKeyinteger
nubKeyinteger
scientificNamestring
canonicalNamestring
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'
status'ACCEPTED' | 'DOUBTFUL' | 'SYNONYM' | 'HETEROTYPIC_SYNONYM' | 'HOMOTYPIC_SYNONYM' | 'PROPARTE_SYNONYM' | 'MISAPPLIED'
higherClassificationMapobject required
synonymboolean
classstring