API reference¶
-
class
pixiv.
Pixiv
(session=None)[source]¶ Bases:
pixiv.pixiv.Authed
Store session data
-
login
(username, password)[source]¶ Logs the user into Pixiv.
Parameters: - username (str) – login name
- password (str) – password for the login
-
search
(terms, period='all', order='asc')[source]¶ Search pixiv and return a list of
Work
objects.Parameters: - terms (str) – search terms
- period (str) – period to search over. This must be one of
'all'
,'day'
,'week'
or'month'
- order (str) – sort order to list results. This must be either
'asc'
or'desc'
-
-
class
pixiv.
User
(id, auth_token=None, session=None)[source]¶ Bases:
pixiv.pixiv.BaseUser
,pixiv.pixiv.Authed
A Pixiv user
Parameters: id (int) – the id of this user
-
class
pixiv.
Work
(id, auth_token=None, session=None)[source]¶ Bases:
pixiv.pixiv.Authed
A Pixiv artwork
Parameters: id (int) – the id of this work
Variables: - id (int) – ID of this work
- image (str) – URL of the large size image for this work
- width (int) – width of image
- height (int) – height of image
- tags – list of tags this image has been tagged with
-
classmethod
from_api_data
(api_data, auth_token=None, session=None)[source]¶ Return a new instance populated with data from the API
-
link
¶