Observation¶
- class pyinaturalist.models.Observation(**kwargs)¶
Bases:
BaseModel
An observation, based the schema of GET /observations
- __init__(**kwargs)¶
Method generated by attrs for class Observation.
Attributes
Name
Type
Description
id
Unique record ID
created_at
Date and time the observation was created
captive
Indicates if the organism is non-wild (captive or cultivated)
community_taxon_id
The current community identification taxon
context_geoprivacy
context_taxon_geoprivacy
context_user_geoprivacy
description
Observation description
geoprivacy
Location privacy level
Options:
obscured
,obscured_private
,open
,private
identifications_count
Total number of identifications
identifications_most_agree
Indicates if most identifications agree with the community ID
identifications_most_disagree
Indicates if most identifications disagree with the community ID
identifications_some_agree
Indicates if some identifications agree with the community ID
license_code
Creative Commons license code
Options:
CC-BY
,CC-BY-NC
,CC-BY-ND
,CC-BY-SA
,CC-BY-NC-ND
,CC-BY-NC-SA
,CC0
,ALL RIGHTS RESERVED
location
Location in
(latitude, longitude)
decimal degreesmappable
Indicates if the observation can be shown on a map
num_identification_agreements
Total identifications that agree with the community ID
num_identification_disagreements
Total identifications that disagree with the community ID
oauth_application_id
ID of the OAuth application used to create the observation, if any
obscured
Indicates if coordinates are obscured (showing a broad approximate location on the map)
observed_on
Date and time the organism was observed
outlinks
Linked observation pages on other sites (e.g., GBIF)
out_of_range
Indicates if the taxon is observed outside of its known range
owners_identification_from_vision
Indicates if the owner’s ID was selected from computer vision results
place_guess
Place name determined from observation coordinates
place_ids
Place IDs associated with the observation coordinates
positional_accuracy
GPS accuracy in meters (real accuracy, if obscured)
preferences
Any user observation preferences (related to community IDs, coordinate access, etc.)
private_location
Private location in
(latitude, longitude)
decimal degreesprivate_place_ids
Place IDs associated with the private observation coordinates
private_place_guess
Place name determined from private observation coordinates
project_ids
All associated project IDs
project_ids_with_curator_id
Project IDs with a curator identification for this observation
project_ids_without_curator_id
Project IDs without curator identification for this observation
public_positional_accuracy
GPS accuracy in meters (not accurate if obscured)
quality_grade
Quality grade
Options:
casual
,needs_id
,research
reviewed_by
IDs of users who have reviewed the observation
site_id
Site ID for iNaturalist network members, or
1
for inaturalist.orgspecies_guess
Taxon name from observer’s initial identification
tags
Arbitrary user tags added to the observation
taxon_geoprivacy
updated_at
Date and time the observation was last updated
uri
Link to observation details page
uuid
Universally unique ID; generally preferred over
id
where possibleviewer_trusted_by_observer
Observer trusts the authenticated user with access to hidden coordinates
cumulative_ids (
property
)Calculate the cumulative community ID score (agreements/total), as shown on the observation UI
default_photo (
property
)Get the default observation photo if any; otherwise use taxon default photo or icon
ident_taxon_ids (
property
)Get all taxon IDs (including ancestors) from identifications
username (
property
)annotations (
LazyProperty
)Observation annotations
application (
LazyProperty
)Application that created the observation
comments (
LazyProperty
)Observation comments
faves (
LazyProperty
)Users who have favorited the observation
flags (
LazyProperty
)Observation flags
identifications (
LazyProperty
)Observation identifications
ofvs (
LazyProperty
)Observation field values
photos (
LazyProperty
)Observation photos
project_observations (
LazyProperty
)Details on any projects that the observation has been added to
quality_metrics (
LazyProperty
)Data quality assessment metrics
sounds (
LazyProperty
)Observation sound files
taxon (
LazyProperty
)Observation taxon
user (
LazyProperty
)Observer
votes (
LazyProperty
)Votes on data quality assessment metrics
Methods
- __init__(**kwargs)¶
Method generated by attrs for class Observation.
- classmethod copy(obj)¶
Copy a model object. This is defined as a classmethod to easily initialize a subclass from a parent class instance. For copying an instance to the same type,
copy.deepcopy()
can be used.- Return type:
- 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
- classmethod from_json_list(value, **kwargs)¶
Initialize a collection of model objects from an API response or response results