UserController

class pyinaturalist.controllers.UserController(client)

Bases: BaseController

Controller for User requests

Methods

__call__(user_id, **kwargs) → User | None

Get a single user by ID

Example

>>> user = client.users(1)

Parameters:

user_id (int | str) – A single user ID

Return type:

User | None

__init__(client)

autocomplete(q, project_id, **params) → Paginator[User]

Given a query string, return users with names or logins starting with the search term

Notes

• Paginated endpoint

• API reference: GET /users/autocomplete

Example

>>> client.users.autocomplete(q='my_userna')

Parameters:

• q (str | None) – Search query

• project_id (int | None) – Only show users who are members of this project

Return type:

Paginator[User]

from_ids(user_ids, **params) → Paginator[User]

Get users by ID

Notes

• Paginated endpoint

• API reference: GET /users/{id}

Example

Get a user by ID:

>>> user = client.users.from_id(1).one()

Get multiple users by ID:

>>> users = client.users.from_id([1,2]).all()

Parameters:

user_ids (int | Iterable[int] | str | Iterable[str]) – One or more user IDs

Return type:

Paginator[User]

me(**params) → User

Get your own user profile

Return type:

User

Notes

• Requires authentication

• API reference: GET /users/me

Example

>>> client.users.me()