---
title: "Name autocomplete service"
method: GET
path: "/v1/species/suggest"
tags: ["Searching names"]
---

# Name autocomplete service

`GET /v1/species/suggest`

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.

## Query parameters

- `datasetKey` string, uuid
- `constituentKey` string, uuid
- `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'
- `isExtinct` boolean
- `habitat` 'MARINE' | 'FRESHWATER' | 'TERRESTRIAL'
- `threat` 'EXTINCT' | 'EXTINCT_IN_THE_WILD' | 'REGIONALLY_EXTINCT' | 'CRITICALLY_ENDANGERED' | 'ENDANGERED' | 'VULNERABLE' | 'NEAR_THREATENED' | 'LEAST_CONCERN' | 'DATA_DEFICIENT' | 'NOT_APPLICABLE' | 'NOT_EVALUATED'
- `nameType` 'SCIENTIFIC' | 'VIRUS' | 'HYBRID' | 'INFORMAL' | 'CULTIVAR' | 'CANDIDATUS' | 'OTU' | 'DOUBTFUL' | 'PLACEHOLDER' | 'NO_NAME' | 'BLACKLISTED'
- `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'
- `origin` 'SOURCE' | 'DENORMED_CLASSIFICATION' | 'VERBATIM_PARENT' | 'VERBATIM_ACCEPTED' | 'VERBATIM_BASIONYM' | 'PROPARTE' | 'AUTONYM' | 'IMPLICIT_NAME' | 'MISSING_ACCEPTED' | 'BASIONYM_PLACEHOLDER' | 'EX_AUTHOR_SYNONYM' | 'OTHER'
- `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'
- `q` string

## Response `200`

Name usage suggestions found

- NameUsageSuggestResult[]
  - `key` integer
  - `nameKey` integer
  - `kingdom` string
  - `phylum` string
  - `order` string
  - `family` string
  - `genus` string
  - `subgenus` string
  - `species` string
  - `kingdomKey` integer
  - `phylumKey` integer
  - `classKey` integer
  - `orderKey` integer
  - `familyKey` integer
  - `genusKey` integer
  - `subgenusKey` integer
  - `speciesKey` integer
  - `parent` string
  - `parentKey` integer
  - `nubKey` integer
  - `scientificName` string
  - `canonicalName` string
  - `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'
  - `higherClassificationMap` object, required
  - `synonym` boolean
  - `class` string

## Other responses

- `400` — Invalid query
- `404` — Name usage not found

---

[API](https://skmtc.net/gbif/apis/species-api.md) · [All operations](https://skmtc.net/gbif/apis/species-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gbif/species-api/revisions/156fd5bac927/schema)