Models

Data models that represent iNaturalist API response objects. See Models section for usage details.

Annotation

An annotation, meaning a controlled term value applied by a user to an observation.

Comment

An observation comment, based on the schema of comments from GET /observations.

ConservationStatus

The conservation status of a taxon in a given location, based on the schema of:

ControlledTerm

A controlled term, based on the schema of GET /controlled_terms.

ControlledTermValue

A controlled term value, based on the schema of GET /controlled_terms.

EstablishmentMeans

The establishment means for a taxon in a given location

ID

alias of pyinaturalist.models.identification.Identification

Identification

An observation identification, based on the schema of GET /identifications.

LifeList

A user's life list, based on the schema of GET /observations/taxonomy

LifeListTaxon

A single Taxon in a user's LifeList

ListedTaxon

A taxon with additional stats associated with a list (aka "original life list"), based on the schema of:

Message

A message from the user's inbox, based on the schema of GET /messages

OFD

alias of pyinaturalist.models.observation_field.ObservationField

OFV

alias of pyinaturalist.models.observation_field.ObservationFieldValue

Observation

An observation, based the schema of GET /observations

ObservationField

An observation field definition, based on the schema of GET /observation_fields.

ObservationFieldValue

An observation field value, based on the schema of Observation.ofvs from GET /observations.

Observations

A collection of observations

Photo

An observation photo, based on the schema of photos from:

Place

A curated or community-contributed place.

Project

An iNaturalist project, based on the schema of GET /projects.

ProjectObservation

Metadata about an observation that has been added to a project

ProjectObservationField

An ObservationField with additional project-specific information

ProjectUser

A User with additional project-specific information

SearchResult

A search result of any type, based on the schema of GET /search.

Taxon

An iNaturalist taxon, based on the schema of GET /taxa.

TaxonCount

A Taxon with an associated count, used in a TaxonCounts collection

TaxonCounts

A collection of taxa with an associated counts.

TaxonSummary

Information about an observation's taxon, within the context of the observation's location.

User

An iNaturalist user, based on the schema of GET /users/{id}

UserCount

An iNaturalist user, with an associated count of filtered IDs or observations

UserCounts

A collection of users with an associated counts