PixivPy3

Due to #158 reason, password login no longer exist. Please use api.auth(refresh_token=REFRESH_TOKEN) instead.

To get refresh_token, see @ZipFile Pixiv OAuth Flow / gppt: get-pixivpy-token (Easy to use 👍 base on selenium) / OAuth with Selenium/ChromeDriver

Pixiv API for Python (with Auth supported)

• [2025/02/09] Add pydantic models for App-API (thanks @Danipulok)
• [2024/03/03] v3.7.5 Fix novel_text() BUG, add webview_novel(), see #337 (thanks @xiyihan)
• [2023/09/18] v3.7.3 Add novel_follow(), fix ByPassSniApi() host BUG, see #279 (thanks @Solomon, @rhyryy)
• [2023/09/17] Move to new PEP 517 standard with poetry, and upgrade deps, see #270 (thanks @Nachtalb)
• [2022/02/04] Remove Public-API support as it's deprecated by Pixiv, see #201
• [2021/11/23] Add illust_new for get latest works, see #189
• [2021/03/02] Add user follow/unfollow, add novel API, see #161 (thanks @y-young, @invobzvr)
• [2020/10/17] Use cloudscraper to bypass Cloudflare, fixed issue #140 (thanks @lllusion3469)
• [2020/07/19] Add date specification for search_illust() (thanks Xdynix)
• [2020/06/06] Add AppPixivAPI().search_novel() for novel search
• [2019/09/23] 增加大陆地区 AppAPI 的免翻墙访问支持, release v3.5 (See example_bypass_sni.py, thanks @Notsfsssf)
• [2019/09/03] Support new auth() check X-Client-Time/X-Client-Hash (thanks DaRealFreak, #83)
• [2019/04/27] Support hosts proxy for AppAPI, which can use behind the Great Wall (See example_api_proxy.py)
• [2017/04/18] Fix encoder BUG for illust_bookmark_add()/illust_bookmark_delete() params (thanks naplings)
• [2017/01/05] Add PixivAPI().works() liked API illust_detail() for App-API (thanks Mapaler), release v3.3
• [2016/12/17] Fixed encoding BUG for Public-API, see #26 (thanks Xdynix)
• [2016/07/27] Now AppPixivAPI() can call without auth (thanks zzycami), check demo.py
• [2016/07/20] New App-API (Experimental) for PixivIOSApp/6.0.9
• [2016/07/11] Add new iOS 6.x API reference to Wiki
• [2015/12/02] Add write API for favorite an user / illust, release v3.1
• [2015/08/11] Remove SPAI and release v3.0 (pixivpy3) (Public-API with Search API)
• [2015/05/16] As Pixiv deprecated SAPI in recent days, push new Public-API ranking_all
• [2014/10/07] New framework, SAPI / Public-API supported (requests needed)

Use pip for installing:

# for Python3
pip install pixivpy3 --upgrade

# for Python2
pip install pixivpy --upgrade

Requirements: requests

Mikubill/PixivPy-Async: Async Pixiv API for Python 3

性能对比（需要高性能访问场景,可以参 考这个脚本）

Warning: The rate limit was hit multiple times during the test, so the result may not be informative. Script: https://github.com/Mikubill/pixivpy-async/blob/master/Perf.py

sg -> Singapore, jp -> Japan, unit -> second

Projects base on pixivpy

1. Mikubill/PixivPy-Async: Async Pixiv API for Python 3

Example:

from pixivpy3 import AppPixivAPI

access_token = "..."
refresh_token = "..."

api = AppPixivAPI()
api.set_auth(access_token, refresh_token)

# get origin url
json_result = api.illust_detail(59580629)
illust = json_result.illust
print(f">>> origin url: {illust.image_urls.large}")

# get ranking: 1-30
# mode: [day, week, month, day_male, day_female, week_original, week_rookie, day_manga]
json_result = api.illust_ranking('day')
for illust in json_result.illusts:
    print(f" p1 [{illust.title}] {illust.image_urls.medium}")

# next page: 31-60
next_qs = api.parse_qs(json_result.next_url)
json_result = api.illust_ranking(**next_qs)
for illust in json_result.illusts:
    print(f" p2 [{illust.title}] {illust.image_urls.medium}")

# get all page:
next_qs = {"mode": "day"}
while next_qs:
    json_result = api.illust_ranking(**next_qs)
    for illust in json_result.illusts:
        print(f"[{illust.title}] {illust.image_urls.medium}")
    next_qs = api.parse_qs(json_result.next_url)

Sniffer - App API

Sniffer - Public API (deprecated)

Using API proxy behind the Great Wall See detail in Issue#73

1. Upgrade pixivpy >= v3.2.0: pip install pixivpy --upgrade
2. Call api.download() like the below:

from pixivpy3 import AppPixivAPI
aapi = AppPixivAPI()
json_result = aapi.illust_ranking()
for illust in json_result.illusts[:3]:
    aapi.download(illust.image_urls.large)

Migrate pixivpy2 to pixivpy3

1. Replace api.papi.* to api.*
2. Change deprecated SPAI call to Public-API call

from pixivpy3 import AppPixivAPI
api = AppPixivAPI()
rank_list = api.illust_ranking('day')
print(rank_list)

# more fields about response: https://github.com/upbit/pixivpy/wiki/sniffer
ranking = rank_list.response[0]
for img in ranking.works:
    # print(img.work)
    print(f"[{img.work.user.name}/{img.work.title}(id={img.work.id})] {img.work.image_urls.px_480mw}")

About

1. Blog: Pixiv Public-API (OAuth)分析

If you have any questions, please feel free to contact me: rmusique@gmail.com

Find Pixiv API in Objective-C? You might also like PixivAPI_iOS

API functions

App-API (6.0 - app-api.pixiv.net)

from __future__ import annotations
from typing import Any
from pixivpy3.utils import ParsedJson

from pixivpy3.api import BasePixivAPI


class AppPixivAPI(BasePixivAPI):

    # 返回翻页用参数
    def parse_qs(cls, next_url: str | None) -> dict[str, Any] | None: ...

    # 用户详情
    def user_detail(self, user_id: int | str) -> ParsedJson: ...

    # 用户作品列表
    ## type: [illust, manga]
    def user_illusts(self, user_id: int | str, type="illust") -> ParsedJson: ...

    # 用户收藏作品列表
    # tag: 从 user_bookmark_tags_illust 获取的收藏标签
    def user_bookmarks_illust(self, user_id: int | str, restrict="public") -> ParsedJson: ...

    # 用户收藏作品列表中的小说
    def user_bookmarks_novel(self, user_id: int | str, restrict="public") -> ParsedJson: ...

    def user_related(self, seed_user_id: int | str) -> ParsedJson: ...

    # 关注用户的新作
    # restrict: [public, private]
    def illust_follow(self, restrict="public") -> ParsedJson: ...

    # 作品详情 (类似PAPI.works(),iOS中未使用)
    def illust_detail(self, illust_id: int | str) -> ParsedJson: ...

    # 作品评论
    def illust_comments(self, illust_id: int | str, include_total_comments=None) -> ParsedJson: ...

    # 相关作品列表
    def illust_related(self, illust_id: int | str) -> ParsedJson: ...

    # 插画推荐 (Home - Main)
    # content_type: [illust, manga]
    def illust_recommended(self, content_type="illust") -> ParsedJson: ...

    # 小说推荐
    def novel_recommended(self) -> ParsedJson: ...

    # 作品排行
    # mode: [day, week, month, day_male, day_female, week_original, week_rookie, day_manga]
    # date: '2016-08-01'
    # mode (Past): [day, week, month, day_male, day_female, week_original, week_rookie,
    #               day_r18, day_male_r18, day_female_r18, week_r18, week_r18g]
    def illust_ranking(self, mode="day", date=None) -> ParsedJson: ...

    # 趋势标签 (Search - tags)
    def trending_tags_illust(self) -> ParsedJson: ...

    # 搜索 (Search)
    # search_target - 搜索类型
    #   partial_match_for_tags  - 标签部分一致
    #   exact_match_for_tags    - 标签完全一致
    #   title_and_caption       - 标题说明文
    # sort: [date_desc, date_asc, popular_desc] - popular_desc为会员的热门排序
    # duration: [within_last_day, within_last_week, within_last_month]
    # start_date, end_date: '2020-07-01'
    def search_illust(
            self,
            word: str,
            search_target="partial_match_for_tags",
            sort="date_desc",
            duration=None,
            start_date=None,
            end_date=None,
    ) -> ParsedJson: ...

    # 搜索小说 (Search Novel)
    # search_target - 搜索类型
    #   partial_match_for_tags  - 标签部分一致
    #   exact_match_for_tags    - 标签完全一致
    #   text                    - 正文
    #   keyword                 - 关键词
    # sort: [date_desc, date_asc]
    # start_date/end_date: 2020-06-01
    def search_novel(
            self,
            word: str,
            search_target="partial_match_for_tags",
            sort="date_desc",
            start_date=None,
            end_date=None,
    ) -> ParsedJson: ...

    def search_user(self, word: str, sort='date_desc', duration=None) -> ParsedJson: ...

    # 作品收藏详情
    def illust_bookmark_detail(self, illust_id: int | str) -> ParsedJson: ...

    # 新增收藏
    def illust_bookmark_add(self, illust_id: int | str, restrict="public", tags=None) -> ParsedJson: ...

    # 删除收藏
    def illust_bookmark_delete(self, illust_id: int | str) -> ParsedJson: ...

    # 关注用户
    def user_follow_add(self, user_id: int | str, restrict="public") -> ParsedJson: ...

    # 取消关注用户
    def user_follow_delete(self, user_id: int | str) -> ParsedJson: ...

    # 用户收藏标签列表
    def user_bookmark_tags_illust(self, restrict="public") -> ParsedJson: ...

    # Following用户列表
    def user_following(self, user_id: int | str, restrict="public") -> ParsedJson: ...

    # Followers用户列表
    def user_follower(self, user_id: int | str) -> ParsedJson: ...

    # 好P友
    def user_mypixiv(self, user_id: int | str) -> ParsedJson: ...

    # 黑名单用户
    def user_list(self, user_id: int | str) -> ParsedJson: ...

    # 获取ugoira信息
    def ugoira_metadata(self, illust_id: int | str) -> ParsedJson: ...

    # 用户小说列表
    def user_novels(self, user_id: int | str) -> ParsedJson: ...

    # 小说系列详情
    def novel_series(self, series_id: int | str, last_order=None) -> ParsedJson: ...

    # 小说详情
    def novel_detail(self, novel_id: int | str) -> ParsedJson: ...

    # 小说 (包含正文)
    def webview_novel(self, novel_id: int | str) -> ParsedJson: ...

    # 小说评论
    def novel_comments(self, novel_id: int | str) -> ParsedJson: ...

    # 大家的新作
    # content_type: [illust, manga]
    def illust_new(self, content_type="illust", max_illust_id=None) -> ParsedJson: ...

    def novel_new(self, max_novel_id=None) -> ParsedJson: ...

    # 特辑详情 (无需登录,调用Web API)
    def showcase_article(self, showcase_id) -> ParsedJson: ...

Usage:

from pixivpy3 import AppPixivAPI
api = AppPixivAPI()

# 作品推荐
json_result = api.illust_recommended()
print(json_result)
illust = json_result.illusts[0]
print(f">>> {illust.title}, origin url: {illust.image_urls.large}")

# 作品相关推荐
json_result = api.illust_related(57065990)
print(json_result)
illust = json_result.illusts[0]
print(f">>> {illust.title}, origin url: {illust.image_urls.large}")

# 作品相关推荐-下一页 (.parse_qs(next_url) 用法)
next_qs = api.parse_qs(json_result.next_url)
json_result = api.illust_related(**next_qs)
print(json_result)
illust = json_result.illusts[0]
print(f">>> {illust.title}, origin url: {illust.image_urls.large}")

# 用户详情
json_result = api.user_detail(660788)
print(json_result)
user = json_result.user
print(f"{user.name}(@{user.account}) region={json_result.profile.region}")

# 用户作品列表
json_result = api.user_illusts(660788)
print(json_result)
illust = json_result.illusts[0]
print(f">>> {illust.title}, origin url: {illust.image_urls.large}")

# 用户收藏列表
json_result = api.user_bookmarks_illust(2088434)
print(json_result)
illust = json_result.illusts[0]
print(f">>> {illust.title}, origin url: {illust.image_urls.large}")

# 用户收藏列表中的小说
json_result = api.user_bookmarks_novel(42862448)
print(json_result)
novel = json_result.novels[0]
print(f">>> {novel.title}, text_length: {novel.text_length}, series: {novel.series}")

# 2016-07-15 日的过去一周排行
json_result = api.illust_ranking('week', date='2016-07-15')
print(json_result)
illust = json_result.illusts[0]
print(f">>> {illust.title}, origin url: {illust.image_urls.large}")

# 关注用户的新作 (需要login)
json_result = api.illust_follow(req_auth=True)
print(json_result)
illust = json_result.illusts[0]
print(f">>> {illust.title}, origin url: {illust.image_urls.large}")

# 标签 "水着" 搜索
json_result = api.search_illust('水着', search_target='partial_match_for_tags')
print(json_result)
illust = json_result.illusts[0]
print(f">>> {illust.title}, origin url: {illust.image_urls.large}")

# 用户 "gomzi" 搜索
json_result = api.search_user("gomzi")
print(json_result)
illust = json_result.user_previews[0].illusts[0]
print(f">>> {illust.title}, origin url: {illust.image_urls.large}")

# 展示小说评论区
json_result = api.novel_comments(16509454, include_total_comments=True)
print(f"Total comments = {json_result.total_comments}")
for comment in json_result.comments:
    if comment.parent_comment:
        print(f"{comment.user.name} replied to {comment.parent_comment.user.name} at {comment.date} : {comment.comment}")
    else:
        print(f"{comment.user.name} at {comment.date} : {comment.comment}")

Develop Instructions

# Updating dependencies
$ poetry update --with=dev,test

Fork this project and create a new branch for your changes. Push your changes to your fork and create a pull request.

poetry run pytest

Package Publishing Instructions

Follow these simple steps to publish your Poetry package. We recommend publishing to the test.pypi.org instance first, to verify everything is working as expected.

This step only has to be done once:

# Configure test.pypi.org
poetry config repositories.testpypi https://test.pypi.org/legacy/
# Configure API Keys for both PyPI and TestPyPY
poetry config pypi-token.testpypi <testpypi_api_key>
poetry config pypi-token.pypi <pypi_api_key>

Now publish the new version:

# Adjust the package version at the top of the "pyproject.toml" file
vim pyproject.toml
# Build python packages to dist/ folder
poetry build
# Publish package to TestPyPi
poetry publish -r testpypi
# Checkout published package in a different environment
pip install --index-url https://test.pypi.org/simple/ <your_package_name>
# Once confirmed that everything works, publish to the real PyPi
poetry publish

License

Feel free to use, reuse and abuse the code in this project.