UserController#

class pyinaturalist.controllers.UserController(client)#

Bases: BaseController

Controller for User requests

Methods

__call__(user_id, **kwargs)#

Get a single user by ID

Example

>>> user = client.users(1)
Parameters:

user_id (Union[int, str]) – A single user ID

Return type:

Optional[User]

__init__(client)#
autocomplete(q=None, project_id=None, **params)#

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

Notes

Example

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

  • q (Optional[str]) – Search query

  • project_id (Optional[int]) – Only show users who are members of this project

Return type:

Paginator[User]

from_ids(user_ids, **params)#

Get users by 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 (Union[int, Iterable[int], str, Iterable[str]]) – One or more user IDs

Return type:

Paginator[User]

me(**params)#

Get your own user profile

Notes

Example

>>> client.users.me()
Return type:

User