PixivPy

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 or OAuth with Selenium/ChromeDriver

Pixiv API for Python (with Auth supported)

• [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:

pip install pixivpy --upgrade

Requirements: requests

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

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

@Mikubill: 简单进行了一下并发测试。（撞了N次Rate Limit...)

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

Projects base on pixivpy

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

Example:

from pixivpy3 import *

api = AppPixivAPI()
# api.login("username", "password")   # Not required

# get origin url
json_result = api.illust_detail(59580629)
illust = json_result.illust
print(">>> origin url: %s" % 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(" p1 [%s] %s" % (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(" p2 [%s] %s" % (illust.title, illust.image_urls.medium))

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:

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

print(">>> new ranking_all(mode='daily', page=1, per_page=50)")
#rank_list = api.sapi.ranking("all", 'day', 1)
rank_list = api.ranking_all('daily', 1, 50)
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("[%s/%s(id=%s)] %s" % (img.work.user.name, img.work.title, 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)

class AppPixivAPI(BasePixivAPI):

    # 返回翻页用参数
    def parse_qs(self, next_url):

    # 用户详情 
    def user_detail(self, user_id):

    # 用户作品列表 
    def user_illusts(self, user_id, type='illust'):

    # 用户收藏作品列表 
    def user_bookmarks_illust(self, user_id, restrict='public'):

    # 关注用户的新作
    # restrict: [public, private]
    def illust_follow(self, restrict='public'):

    # 作品详情 (无需登录，同PAPI.works)
    def illust_detail(self, illust_id):

    # 相关作品列表 
    def illust_related(self, illust_id):

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

    # 作品排行
    # mode: [day, week, month, day_male, day_female, week_original, week_rookie, day_manga]
    # date: '2016-08-01'
    # mode(r18榜单需登录): [day_r18, day_male_r18, day_female_r18, week_r18, week_r18g]
    def illust_ranking(self, mode='day', date=None, offset=None):

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

    # 搜索 (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, search_target='partial_match_for_tags', sort='date_desc', duration=None):

    # 搜索小说 (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 (最长1年)
    def search_novel(self, word, search_target='partial_match_for_tags', sort='date_desc', start_date=None, end_date=None):

    # 用户搜索
    def search_user(self, word, sort='date_desc', duration=None):

    # 作品收藏详情 
    def illust_bookmark_detail(self, illust_id):

    # 新增收藏
    def illust_bookmark_add(self, illust_id, restrict='public', tags=None):

    # 删除收藏
    def illust_bookmark_delete(self, illust_id):

    # 关注用户
    def user_follow_add(self, user_id, restrict='public'):

    # 取消关注用户
    def user_follow_delete(self, user_id):

    # 用户收藏标签列表
    def user_bookmark_tags_illust(self, restrict='public', offset=None):

    # Following用户列表 
    def user_following(self, user_id, restrict='public', offset=None):

    # Followers用户列表 
    def user_follower(self, user_id, filter='for_ios', offset=None):

    # 好P友 
    def user_mypixiv(self, user_id, offset=None):

    # 黑名单用户 
    def user_list(self, user_id, filter='for_ios', offset=None):

    # 获取ugoira信息
    def ugoira_metadata(self, illust_id):

    # 用户小说列表
    def user_novels(self, user_id, filter='for_ios', offset=None):

    # 小说系列详情
    def novel_series(self, series_id, filter='for_ios', last_order=None):

    # 小说详情
    def novel_detail(self, novel_id):

    # 小说正文
    def novel_text(self, novel_id):

    # 大家的新作 [illust, manga]
    def illust_new(self, content_type="illust", filter='for_ios', max_illust_id=None):

Usage:

aapi = AppPixivAPI()

# 作品推荐
json_result = aapi.illust_recommended()
print(json_result)
illust = json_result.illusts[0]
print(">>> %s, origin url: %s" % (illust.title, illust.image_urls['large']))

# 作品相关推荐
json_result = aapi.illust_related(57065990)
print(json_result)
illust = json_result.illusts[0]
print(">>> %s, origin url: %s" % (illust.title, illust.image_urls['large']))

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

# 用户详情
json_result = aapi.user_detail(660788)
print(json_result)
user = json_result.user
print("%s(@%s) region=%s" % (user.name, user.account, json_result.profile.region))

# 用户作品列表
json_result = aapi.user_illusts(660788)
print(json_result)
illust = json_result.illusts[0]
print(">>> %s, origin url: %s" % (illust.title, illust.image_urls['large']))

# 用户收藏列表
json_result = aapi.user_bookmarks_illust(2088434)
print(json_result)
illust = json_result.illusts[0]
print(">>> %s, origin url: %s" % (illust.title, illust.image_urls['large']))

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

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

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

# 用户 "gomzi" 搜索
json_result = aapi.search_user("gomzi")
print(json_result)
illust = json_result.user_previews[0].illusts[0]
print(">>> %s, origin url: %s" % (illust.title, illust.image_urls['large']))

Make a release

Bump version in pixivpy3/__init__.py, rebuild dist/*

python3 setup.py sdist bdist_wheel
python2 setup.py bdist_wheel
twine upload dist/*

License

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