Place

class pyinaturalist.models.Place(id, uuid, admin_level, ancestor_place_ids, bbox_area, bounding_box_geojson, ...) → None

Bases: BaseModel

A curated or community-contributed place. Handles data from the following endpoints:

• GET /places/{id}

• GET /places/nearby

• GET /taxa (establishment_means.place)

Attributes

Methods

__init__(id, uuid, admin_level, ancestor_place_ids, bbox_area, bounding_box_geojson, ...) → None

Method generated by attrs for class Place.

classmethod copy(obj) → BaseModel

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:

BaseModel

classmethod from_json(value, category, **kwargs) → Place

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:

Place

classmethod from_json_file(value) → list[T]

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, **kwargs) → list[Place]

Optionally use results from /places/nearby to set Place.category

Return type:

list[Place]

to_dict(keys, recurse) → dict[str, Any]

Convert this object back to dict format

Parameters:

• keys (list[str] | None) – Only keep the specified keys (attribute names)

• recurse (bool) – Recurse into nested model objects

Return type:

dict[str, Any]