Package Health Score

50 / 100

security
Security review needed
popularity
Limited
maintenance
Inactive
community
Limited

Explore Similar Packages

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
0.27.0	\|	04/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.26.0	\|	03/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.25.0	\|	02/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.24.0	\|	10/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.23.0	\|	10/2020		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (28)

GitHub Stars: 150
Forks: 20
Contributors: 2

Direct Usage Popularity

The npm package pixiv-api-client receives a total of 28 downloads a week. As such, we scored pixiv-api-client popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package pixiv-api-client, we found that it has been starred 150 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 2
Funding: Yes

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like pixiv-api-client is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 0
Open PR: 13
Last Release: 7 months ago
Last Commit: 7 months ago

Further analysis of the maintenance status of pixiv-api-client based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

We found that pixiv-api-client demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: >=4

Age: 8 years
Dependencies: 4 Direct
Versions: 32
Install Size: 41.6 kB
Dist-tags: 1
# of Files: 4
Maintainers: 1
TS Typings: No

pixiv-api-client has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Pixiv API Client

Promise based Pixiv API client for node.js and react native

Note

Since 8th Feb 2021, login api no longer working, pixiv now require authenticate with oauth 2.0. You will need to either use tool like wireshark/charles to sniff refresh token and auth with refreshAccessToken or follow oauth 2.0 flow which will only work on authorized url or app.

Install

$ npm install pixiv-api-client --save

Usage

const PixivApi = require('pixiv-api-client');
const pixiv = new PixivApi();

const word = 'ラブライブ';
pixiv.tokenRequest('code', 'codeVerfier').then(() => {
  return pixiv.searchIllust(word).then(json => {
	console.log(json);
	return pixiv.requestUrl(json.next_url);
  }).then(json => {
	console.log(json); //next results
  });
});

API

PixivApi(options)

options - object (optional)
- headers: custom headers for request

pixiv.tokenRequest(code, codeVerifier)

code - Authorization code return by pixiv auth server through PKCE flow
codeVerifier - Code verifier generated from PKCE challenge

[Deprecated] pixiv.login(username, password, rememberPassword)

Api client will try once to relogin again on error if rememberPassword is set to true

username - Pixiv username
password - Pixiv password
rememberPassword - Boolean (default: true)

pixiv.logout()

pixiv.refreshAccessToken(refreshToken)

Refresh access token with refreshToken

refreshToken - string (if not provided, will use refresh token that stored with api client after login)

[Deprecated] pixiv.createProvisionalAccount(nickName)

nickName - string

pixiv.userState()

require auth

pixiv.editUserAccount(fields)

require auth

fields - object
- pixivId
- email
- currentPassword
- newPassword

pixiv.sendAccountVerificationEmail()

require auth

pixiv.searchIllust(word, options)

require auth

word - word to search (required)
options - object (optional)
- search_target: partial_match_for_tags | exact_match_for_tags | title_and_caption (default: partial_match_for_tags)
- sort: date_desc | date_asc | popular_desc (popular_desc only available for pixiv premium member) (default: date_desc)
- start_date: Date
- end_date: Date

pixiv.searchIllustPopularPreview(word, options)

require auth

word - word to search (required)
options - object (optional)
- search_target: partial_match_for_tags | exact_match_for_tags | title_and_caption (default: partial_match_for_tags)
- sort: date_desc | date_asc (default: date_desc)
- start_date: Date
- end_date: Date

pixiv.searchIllustBookmarkRanges(word, options)

require auth

word - word to search (required)
options - object (optional)
- search_target: partial_match_for_tags | exact_match_for_tags | title_and_caption (default: partial_match_for_tags)
- start_date: Date
- end_date: Date

pixiv.searchUser(word)

require auth

word - word to search (required)

[Depcreated] pixiv.searchAutoComplete(word)

require auth

word - word to search (required)

pixiv.searchAutoCompleteV2(word)

require auth

word - word to search (required)

pixiv.userDetail(userId, options)

userId - Pixiv user id (required)
options - object (optional)

pixiv.userIllusts(id, options)

require auth

id - Pixiv user id (required)
options - object (optional)
- type - one of illust | manga

pixiv.userBookmarksIllust(id, options)

require auth

id - Pixiv user id (required)
options - object (optional)
- restrict - one of public | private (default: public)

pixiv.userBookmarkIllustTags(options)

require auth

options - object (optional)
- restrict - one of public | private (default: public)

pixiv.userNovels(id, options)

require auth

id - Pixiv user id (required)
options - object (optional)

pixiv.userBookmarksNovel(id, options)

require auth

id - Pixiv user id
options - object (optional)
- restrict - one of public | private (default: public)

pixiv.userBookmarkNovelTags(options)

require auth

options - object (optional)
- restrict - one of public | private (default: public)

pixiv.illustBookmarkDetail(id, options)

require auth

id - Pixiv illust id (required)
options - object (optional)

pixiv.novelBookmarkDetail(id, options)

require auth

id - Pixiv novel id (required)
options - object (optional)

[Deprecated] pixiv.illustComments(id, options)

require auth

id - Pixiv illust id (required)
options - object (optional)

[Deprecated] pixiv.illustCommentsV2(id, options)

require auth

id - Pixiv illust id (required)
options - object (optional)

pixiv.illustCommentsV3(id, options)

require auth

id - Pixiv illust id (required)
options - object (optional)

pixiv.illustCommentReplies(id, options)

require auth

id - Pixiv illust comment id (required)
options - object (optional)

pixiv.illustCommentRepliesV2(id, options)

require auth

id - Pixiv illust comment id (required)
options - object (optional)

pixiv.novelComments(id, options)

require auth

id - Pixiv novel id (required)
options - object (optional)

pixiv.novelCommentsV2(id, options)

require auth

id - Pixiv novel id (required)
options - object (optional)

pixiv.novelCommentsV3(id, options)

require auth

id - Pixiv novel id (required)
options - object (optional)

pixiv.novelCommentReplies(id, options)

require auth

id - Pixiv novel comment id (required)
options - object (optional)

pixiv.novelCommentRepliesV2(id, options)

require auth

id - Pixiv novel comment id (required)
options - object (optional)

pixiv.illustRelated(id, options)

require auth

id - Pixiv illust id (required)
options - object (optional)

pixiv.illustDetail(id, options)

require auth

id - Pixiv illust id (required)
options - object (optional)

pixiv.novelDetail(id, options)

require auth

id - Pixiv novel id (required)
options - object (optional)

[Deprecated] pixiv.novelText(id, options)

require auth

id - Pixiv novel id (required)
options - object (optional)

pixiv.novelWebview(id, raw)

require auth

id - Pixiv novel id (required)
raw - boolean (optional, default is false) Set to true to return return raw response string or false to return novel object

pixiv.novelSeries(id, options)

require auth

id - Pixiv novel series id (required)
options - object (optional)

pixiv.illustNew(options)

require auth

options - object (optional)

pixiv.illustFollow(options)

require auth

options - object (optional)
- restrict - one of all | public | private (default: all)

pixiv.novelFollow(options)

require auth

options - object (optional)
- restrict - one of all | public | private (default: all)

pixiv.illustRecommended(options)

require auth

options - object (optional)

pixiv.illustRanking(options)

require auth

options - object
- date: Date
- mode: day | week | month | day_male | day_female | week_original | week_rookie | day_r18 | day_male_r18 | day_female_r18 | week_r18 | week_r18g| day_manga | week_manga | month_manga | week_rookie_manga | day_r18_manga | week_r18_manga | week_r18g_manga (default: day)

pixiv.novelRanking(options)

require auth

options - object
- date: Date
- mode: day | week | month | day_male | day_female | week_original | week_rookie | day_r18 | day_male_r18 | day_female_r18 | week_r18 | week_r18g| day_manga | week_manga | month_manga | week_rookie_manga | day_r18_manga | week_r18_manga | week_r18g_manga (default: day)

pixiv.illustMyPixiv()

require auth

pixiv.novelMyPixiv()

require auth

pixiv.illustAddComment(id, comment, parentCommentId)

require auth

id - Pixiv illust id (required)
comment - string (required)
parentCommentId - Pixiv comment id (optional, to reply to comment`

pixiv.novelAddComment(id, comment, parentCommentId)

require auth

id - Pixiv novel id (required)
comment - string (required)
parentCommentId - Pixiv comment id (optional, to reply to comment`

pixiv.ugoiraMetaData(id)

require auth

id - Pixiv illust(ugoira) id (required)

pixiv.trendingTagsIllust(options)

require auth

options - object (optional)

pixiv.trendingTagsNovel(options)

require auth

options - object (optional)

pixiv.bookmarkIllust(id, restrict, tags)

require auth

id - Pixiv illust id (required)
restrict - one of public | private (default: public)
tags - array of string (optional)

pixiv.unbookmarkIllust(id)

require auth

id - Pixiv illust id (required)

pixiv.bookmarkNovel(id, restrict, tags)

require auth

id - Pixiv novel id (required)
restrict - one of public | private (default: public)
tags - array of string (optional)

pixiv.unbookmarkNovel(id)

require auth

id - Pixiv novel id (required)

pixiv.mangaRecommended(options)

require auth

options - object (optional)

pixiv.mangaNew(options)

require auth

options - object (optional)

pixiv.searchNovel(word, options)

require auth

word - word to search (required)
options - object (optional)
- search_target: partial_match_for_tags | text | keyword (default: partial_match_for_tags)
- sort: date_desc | date_asc | popular_desc (popular_desc only available for pixiv premium member) (default: date_desc)
- start_date: Date
- end_date: Date

pixiv.searchNovelPopularPreview(word, options)

require auth

word - word to search (required)
options - object (optional)
- search_target: partial_match_for_tags | text | keyword (default: partial_match_for_tags)
- sort: date_desc | date_asc | popular_desc (popular_desc only available for pixiv premium member) (default: date_desc)
- start_date: Date
- end_date: Date

pixiv.searchNovelBookmarkRanges(word, options)

require auth

word - word to search (required)
options - object (optional)
- search_target: partial_match_for_tags | text | keyword (default: partial_match_for_tags)
- start_date: Date
- end_date: Date

pixiv.novelRecommended(options)

require auth

options - object (optional)

pixiv.novelNew(options)

require auth

options - object (optional)

pixiv.novelRanking(options)

require auth

options - object
- date: Date
- mode: day | week | day_male | day_female | week_rookie | day_r18 | day_male_r18 | day_female_r18 | week_r18 | week_r18g (default: day)

pixiv.userRecommended(options)

require auth

options - object (optional)

pixiv.userFollowing(id, options)

require auth

id - Pixiv user id (required)
options - object (optional)
- restrict: public | private (default: public)

pixiv.userFollower(id, options)

require auth

id - Pixiv user id (required)
options - object (optional)

pixiv.userMyPixiv(id)

require auth

id - Pixiv user id (required)

pixiv.followUser(id, restrict)

require auth

id - Pixiv user id (required)
restrict - one of public | private (default: public)

pixiv.unfollowUser(id)

require auth

id - Pixiv user id (required)

pixiv.setLanguage(lang)

set HTTP header Accept-Language for pixiv api request

lang - HTTP header Accept-Language

pixiv.requestUrl(url, options)

can be use to request pixiv endpoint or use for traversing results by passing next_url from result of other api such as pixiv.searchIllust

options - object (optional)

Tests

Export pixiv username and password before running Tests.

$ export refresh_token=pixiv account refresh_token
$ npm test

Related projects

PxView - Android/iOS client for Pixiv built in react-native

License

MIT

pixiv-api-client dependencies

axios blueimp-md5 moment qs

pixiv-api-client development dependencies

ava dotenv eslint eslint-config-airbnb-base eslint-config-prettier eslint-plugin-import eslint-plugin-prettier lodash.isobject prettier prettier-eslint

FAQs

What is pixiv-api-client?

Promise based Pixiv API client for react native and node.js. Visit Snyk Advisor to see a full health score report for pixiv-api-client, including popularity, security, maintenance & community analysis.

Is pixiv-api-client popular?

The npm package pixiv-api-client receives a total of 28 weekly downloads. As such, pixiv-api-client popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is pixiv-api-client well maintained?

We found indications that pixiv-api-client is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is pixiv-api-client safe to use?

While scanning the latest version of pixiv-api-client, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 16 November-2024, at 09:05 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP