latestOpenAPI 3.0.02026-08-10135177718.4 KB

f739db716aaf

Taxa

Suggest taxa for identifications given conditions

Retrieve automated identification suggestions for an observation or a set of filters like taxon and place

get/taxa/suggest

Query parameters

featured_observation_idstring uuid

When source is observations, ignore this observation

{"stackTrail":"paths:/taxa/suggest:get:parameters:2:schema","oasType":"schema","type":"unknown"}
image_urlstring uri

URL for image to use when source is visual

boolean
OR
string
limitnumber float

Number of results to return

latnumber float

Coordinate used when fetching nearby results source is visual or *observations

lngnumber float

Coordinate used when fetching nearby results source is visual or *observations

localestring
monthsstring
observation_idstring uuid

Automatically set place and taxon filters based on this observation; this will override the values of place_id and taxon_id if these values can be derived from the observation

observed_onstring

Date the subject was observed (YYYY-MM-DD), used to refine suggestions to those observed at a similar time of year

order_by'taxonomy' | 'default' | 'sciname'

How the suggestions will be ordered. The default is to order by whatever default a source uses, e.g. the score when source is visual, or the number of observations (frequency) when the source is *observations. Ordering by taxonomy will group the results by their closeness in the taxonomic tree, but continue to use default ordering for siblings (e.g. species in the same genus).

place_idinteger

Only retrieve suggestions from this place when source is checklist or *observations

place_latnumber float

Coordinate used to set a place filter when source is *observations by choosing the place whose boundary contains the coordinate. Only chooses from places curated by staff (aka "standard" places) and only sets the place when lat, lng, and place_id are blank

place_lngnumber float

See place_lat

source'captive_observations' | 'checklist' | 'misidentifications' | 'observations' | 'rg_observations' | 'visual' nullable

Source of the suggestions. Note that different sources support different search parameters. See each parameter for details

taxon_idinteger

Only retrieve suggestions in this taxon. If taxon is below genus level it will be replaced with the genus that contains it. When source is misidentifications, suggestions will be species commonly misidentified as this taxon

Headers

X-HTTP-Method-Overridestring

Response

An array of suggestions