Client

Summary

Classes

iNatClient([creds, default_params, dry_run, ...])

API client class that provides an object-oriented interface to the iNaturalist API.

Functions

Module Contents

class pyinaturalist.client.iNatClient(creds=None, default_params=None, dry_run=False, loop=None, session=None, **kwargs)

Bases: object

API client class that provides an object-oriented interface to the iNaturalist API.

WIP/Experimental

See:

• Usage guide: API Client Class

• Query functions: Controller classes

Controllers:

• annotations

• observations

• places

• projects

• search

• taxa

• users

Parameters:

• creds (Optional[Dict[str, str]]) – Optional arguments for get_access_token(), used to get and refresh access tokens as needed. Using a keyring instead is recommended, though.

• default_params (Optional[Dict[str, Any]]) – Default request parameters to pass to any applicable API requests

• dry_run (bool) – Just log all requests instead of sending real requests

• loop (Optional[AbstractEventLoop]) – An event loop to run any executors used for async iteration

• session (Optional[ClientSession]) – Session object to use instead of creating a new one

• kwargs – Keyword arguments for ClientSession

add_defaults(request_function, kwargs=None, auth=False)

Add any applicable client settings to request parameters before sending a request. Explicit keyword arguments will override any client settings.

Return type:

Dict[str, Any]

annotations

Interface for annotation requests

observations

Interface for observation requests

paginate(request_function, model, auth=False, cls=<class 'pyinaturalist.paginator.Paginator'>, **kwargs)

Create a paginator for a request, with client settings applied

Parameters:

• request_function (Callable) – The API request function to call

• model (Type[TypeVar(T, bound= BaseModel)]) – Model class used for the response

• auth (bool) – Indicates that the request requires authentication

• cls (Type[Paginator]) – Alternative Paginator class to use

• params – Original request parameters

Return type:

Paginator[TypeVar(T, bound= BaseModel)]

places

Interface for place requests

projects

Interface for project requests

request(request_function, *args, auth=False, **kwargs)

Send a request, with client settings applied.

Parameters:

• request_function (Callable) – The API request function to call

• auth (bool) – Indicates that the request requires authentication

• params – Original request parameters

Returns:

Results of request_function()

search

Unified text search

taxa

Interface for taxon requests

users

Interface for user requests