ControlledTermController

class pyinaturalist.controllers.ControlledTermController(*args, **kwargs)

Bases: BaseController

Controller for ControlledTerm and Annotation requests

Methods

__init__(*args, **kwargs)

all(**params)

List controlled terms and their possible values

Return type:

List[ControlledTerm]

Notes

• API reference: GET /controlled_terms

for_taxon(taxon_id, **params)

List controlled terms that are valid for the specified taxon.

Notes

• API reference: GET /controlled_terms/for_taxon

Parameters:

taxon_id (int) – ID of taxon to get controlled terms for

Return type:

List[ControlledTerm]

from_ids(*object_ids, **params)

Get records by ID

Return type:

Paginator

lookup(annotations)

Fill in missing information for the specified annotations. If only term and value IDs are present, this will look up, cache, and add complete controlled term details.

Parameters:

annotations (List[Annotation]) – Observation annotations

Return type:

List[Annotation]

Returns:

Annotation objects with controlled_attribute and controlled_value populated