ListedTaxon

class pyinaturalist.models.ListedTaxon(id=None, establishment_means=None, establishment_means_description=None, place=None, comments_count=0, created_at=None, description=None, first_observation_id=None, last_observation_id=None, list_id=None, list_title=None, manually_added=None, observations_count=0, occurrence_status_level=None, primary_listing=None, source_id=None, taxon_id=None, taxon_range_id=None, updated_at=None, updater=None, user=None)

Bases: pyinaturalist.models.taxon_meta.IdWrapperMixin, pyinaturalist.models.taxon_meta.EstablishmentMeans

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

• Taxon.listed_taxa from GET /taxa/{id}

• TaxonSummary.listed_taxon from GET /observations/{id}/taxon_summary

Attributes

Name	Type	Description
id	int	Unique record ID
establishment_means	str	Establishment means label Options: introduced, native, endemic
establishment_means_description	str	Establishment means description Options: introduced, native, endemic
comments_count	int	Number of comments for this listed taxon
created_at	datetime	Date and time the record was created
description	str	Listed taxon description
first_observation_id	int	Oldest recent observation ID in the list
last_observation_id	int	Most recent observation ID in the list
list_id	int	List ID
list_title	str	List title
manually_added	bool	Indicates if the taxon was manually added to the list
observations_count	int	Number of observations of this taxon in the list
occurrence_status_level	int
primary_listing	bool	Indicates if this is the primary listing for this taxon
source_id	int
taxon_id	int
taxon_range_id	int
updated_at	datetime	Date and time the record was last updated
updater	User	User that last updated the record
user	User	User that created the record
list (property)	Dict	Alias to handle differences between taxa and taxon_summary endpoints

Methods

__init__(id=None, establishment_means=None, establishment_means_description=None, place=None, comments_count=0, created_at=None, description=None, first_observation_id=None, last_observation_id=None, list_id=None, list_title=None, manually_added=None, observations_count=0, occurrence_status_level=None, primary_listing=None, source_id=None, taxon_id=None, taxon_range_id=None, updated_at=None, updater=None, user=None)

Method generated by attrs for class ListedTaxon.

classmethod from_json(value, **kwargs)

Initialize a single model object from an API response or response result.

Omits any invalid fields and None values, so default factories are used instead (e.g. for empty dicts and lists).

Return type

TypeVar(T, bound= BaseModel)

classmethod from_json_file(value)

Initialize a collection of model objects from a JSON string, file path, or file-like object

Return type

List[TypeVar(T, bound= BaseModel)]

classmethod from_json_list(value)

Initialize a collection of model objects from an API response or response results

Return type

List[TypeVar(T, bound= BaseModel)]

to_json()

Convert this object back to JSON (dict) format

Return type

Dict[str, Any]