Client#
Summary#
Classes
|
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:
- Parameters:
creds (
Optional
[Dict
[str
,str
]]) – Optional arguments forget_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 requestsdry_run (
bool
) – Just log all requests instead of sending real requestsloop (
Optional
[AbstractEventLoop
]) – An event loop to run any executors used for async iterationsession (
Optional
[ClientSession
]) – Session object to use instead of creating a new onekwargs – 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.
- 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
- places#
Interface for
place requests
- projects#
Interface for
project requests
- request(request_function, *args, auth=False, **kwargs)#
Send a request, with client settings applied.
- search#
Unified
text search
- taxa#
Interface for
taxon requests
- users#
Interface for
user requests