{"id":14108987,"url":"https://github.com/alphasp/pixiv-api-client","last_synced_at":"2026-01-14T22:13:40.827Z","repository":{"id":11522950,"uuid":"69943951","full_name":"alphasp/pixiv-api-client","owner":"alphasp","description":"Promise based Pixiv API client for node.js and react native","archived":false,"fork":false,"pushed_at":"2024-08-18T09:56:26.000Z","size":541,"stargazers_count":151,"open_issues_count":13,"forks_count":20,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-08-19T15:40:26.600Z","etag":null,"topics":["api","api-client","javascript","nodejs","pixiv","react-native"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alphasp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-10-04T07:47:02.000Z","updated_at":"2025-05-05T03:01:50.000Z","dependencies_parsed_at":"2024-04-11T21:48:55.275Z","dependency_job_id":"822f99d6-e473-4f7f-9f60-72b388295aa0","html_url":"https://github.com/alphasp/pixiv-api-client","commit_stats":{"total_commits":91,"total_committers":2,"mean_commits":45.5,"dds":0.01098901098901095,"last_synced_commit":"dd09fe32916ccf22300b7ffd4f56f079935cee81"},"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"purl":"pkg:github/alphasp/pixiv-api-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alphasp%2Fpixiv-api-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alphasp%2Fpixiv-api-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alphasp%2Fpixiv-api-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alphasp%2Fpixiv-api-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alphasp","download_url":"https://codeload.github.com/alphasp/pixiv-api-client/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alphasp%2Fpixiv-api-client/sbom","scorecard":{"id":186698,"data":{"date":"2025-08-11","repo":{"name":"github.com/alphasp/pixiv-api-client","commit":"78d75aa69d892b23dd319d30bb8722baabce6a2c"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 0/18 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 17 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"60 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-6chw-6frg-f759","Warn: Project is vulnerable to: GHSA-v88g-cgmw-v5xw","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-cph5-m8f7-6c5x","Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx","Warn: Project is vulnerable to: GHSA-jr5f-v2jv-69x6","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-cwfw-4gq5-mrqx","Warn: Project is vulnerable to: GHSA-g95f-p29q-9xw4","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-c6rq-rjc2-86v2","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm","Warn: Project is vulnerable to: GHSA-4gmj-3p3h-gm8h","Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q","Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c","Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc","Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp","Warn: Project is vulnerable to: GHSA-8r6j-v8pm-fqw3","Warn: Project is vulnerable to: MAL-2023-462","Warn: Project is vulnerable to: GHSA-pfrx-2q88-qq97","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-qqgx-2p2h-9c37","Warn: Project is vulnerable to: GHSA-2pr6-76vf-7546","Warn: Project is vulnerable to: GHSA-8j8c-7jfh-h6hx","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-282f-qqgm-c34q","Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp","Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695","Warn: Project is vulnerable to: GHSA-p6mc-m468-83gw","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-h726-x36v-rx45","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-vh95-rmgr-6w4m","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-fhjf-83wg-r2j9","Warn: Project is vulnerable to: GHSA-8hfj-j24r-96c4","Warn: Project is vulnerable to: GHSA-wc69-rhjr-hc9g","Warn: Project is vulnerable to: GHSA-w9mr-4mfr-499f","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-4g88-fppr-53pp","Warn: Project is vulnerable to: GHSA-4jqc-8m5r-9rpr","Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6","Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj","Warn: Project is vulnerable to: GHSA-j44m-qm6p-hp7m","Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9","Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw","Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc","Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh","Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-16T19:55:34.095Z","repository_id":11522950,"created_at":"2025-08-16T19:55:34.095Z","updated_at":"2025-08-16T19:55:34.095Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28436268,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T21:32:52.117Z","status":"ssl_error","status_checked_at":"2026-01-14T21:32:33.442Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","api-client","javascript","nodejs","pixiv","react-native"],"created_at":"2024-08-14T10:01:57.840Z","updated_at":"2026-01-14T22:13:40.810Z","avatar_url":"https://github.com/alphasp.png","language":"JavaScript","readme":"# Pixiv API Client\n[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)\n\nPromise based Pixiv API client for node.js and react native \n\n\n## Note\nSince 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.\n\n\n## Install\n\n```\n$ npm install pixiv-api-client --save \n```\n\n## Usage\n\n```js\nconst PixivApi = require('pixiv-api-client');\nconst pixiv = new PixivApi();\n\nconst word = 'ラブライブ';\npixiv.tokenRequest('code', 'codeVerfier').then(() =\u003e {\n  return pixiv.searchIllust(word).then(json =\u003e {\n\tconsole.log(json);\n\treturn pixiv.requestUrl(json.next_url);\n  }).then(json =\u003e {\n\tconsole.log(json); //next results\n  });\n});\n```\n\n## API\n\n### PixivApi(options)\n- `options` - object (optional)\n  - `headers`: custom headers for request\n\n#### pixiv.tokenRequest(code, codeVerifier)\n- `code` - Authorization code return by pixiv auth server through PKCE flow\n- `codeVerifier` - Code verifier generated from PKCE challenge\n\n\n#### [Deprecated] pixiv.login(username, password, rememberPassword)\nApi client will try once to relogin again on error if rememberPassword is set to `true`\n\n- `username` - Pixiv username\n- `password` - Pixiv password\n- `rememberPassword` - Boolean (default: `true`)\n\n#### pixiv.logout()\n\n#### pixiv.refreshAccessToken(refreshToken)\nRefresh access token with refreshToken\n\n- `refreshToken` - string (if not provided, will use refresh token that stored with api client after login)\n\n#### [Deprecated] pixiv.createProvisionalAccount(nickName)\n\n- `nickName` - string\n\n#### pixiv.userState()\nrequire auth\n\n#### pixiv.editUserAccount(fields)\nrequire auth\n\n- `fields` - object\n  - pixivId\n  - email\n  - currentPassword\n  - newPassword\n\n#### pixiv.sendAccountVerificationEmail()  \nrequire auth\n\n#### pixiv.searchIllust(word, options)\nrequire auth\n\n- `word` - word to search (required)\n- `options` - object (optional)\n  - `search_target`: `partial_match_for_tags` | `exact_match_for_tags` | `title_and_caption` (default: `partial_match_for_tags`)\n  - `sort`: `date_desc` | `date_asc` | `popular_desc` (`popular_desc` only available for pixiv premium member) (default: `date_desc`)\n  - `start_date`: Date\n  - `end_date`: Date\n\n#### pixiv.searchIllustPopularPreview(word, options)\nrequire auth\n\n- `word` - word to search (required)\n- `options` - object (optional)\n  - `search_target`: `partial_match_for_tags` | `exact_match_for_tags` | `title_and_caption` (default: `partial_match_for_tags`)\n  - `sort`: `date_desc` | `date_asc` (default: `date_desc`)\n  - `start_date`: Date\n  - `end_date`: Date\n\n#### pixiv.searchIllustBookmarkRanges(word, options)\nrequire auth\n\n- `word` - word to search (required)\n- `options` - object (optional)\n  - `search_target`: `partial_match_for_tags` | `exact_match_for_tags` | `title_and_caption` (default: `partial_match_for_tags`)\n  - `start_date`: Date\n  - `end_date`: Date\n\n#### pixiv.searchUser(word)\nrequire auth\n\n- `word` - word to search (required)\n\n#### [Depcreated] pixiv.searchAutoComplete(word)\nrequire auth\n\n- `word` - word to search (required)\n\n#### pixiv.searchAutoCompleteV2(word)\nrequire auth \n\n- `word` - word to search (required)\n\n#### pixiv.userDetail(userId, options)\n- `userId` - Pixiv user id (required)\n- `options` - object (optional)\n\n#### pixiv.userIllusts(id, options) \nrequire auth\n\n- `id` - Pixiv user id (required)\n- `options` - object (optional)\n  - `type` - one of `illust` | `manga`\n\n#### pixiv.userBookmarksIllust(id, options)\nrequire auth\n\n- `id` - Pixiv user id (required)\n- `options` - object (optional)\n  - `restrict` - one of `public` | `private` (default: `public`)\n\n#### pixiv.userBookmarkIllustTags(options)\nrequire auth\n\n- `options` - object (optional)\n  - `restrict` - one of `public` | `private` (default: `public`)\n\n#### pixiv.userNovels(id, options) \nrequire auth\n\n- `id` - Pixiv user id (required)\n- `options` - object (optional)\n \n#### pixiv.userBookmarksNovel(id, options)\nrequire auth\n\n- `id` - Pixiv user id\n- `options` - object (optional)\n  - `restrict` - one of `public` | `private` (default: `public`)\n\n#### pixiv.userBookmarkNovelTags(options)\nrequire auth\n\n- `options` - object (optional)\n  - `restrict` - one of `public` | `private` (default: `public`)\n\n#### pixiv.illustBookmarkDetail(id, options)\nrequire auth\n\n- `id` - Pixiv illust id (required)\n- `options` - object (optional)\n\n#### pixiv.novelBookmarkDetail(id, options)\nrequire auth\n\n- `id` - Pixiv novel id (required)\n- `options` - object (optional)\n\n\n#### [Deprecated] pixiv.illustComments(id, options)\nrequire auth\n\n- `id` - Pixiv illust id (required)\n- `options` - object (optional)\n\n#### [Deprecated] pixiv.illustCommentsV2(id, options)\nrequire auth\n\n- `id` - Pixiv illust id (required)\n- `options` - object (optional)\n\n#### pixiv.illustCommentsV3(id, options)\nrequire auth\n\n- `id` - Pixiv illust id (required)\n- `options` - object (optional)\n\n#### pixiv.illustCommentReplies(id, options)\nrequire auth\n\n- `id` - Pixiv illust comment id (required)\n- `options` - object (optional)\n\n#### pixiv.illustCommentRepliesV2(id, options)\nrequire auth\n\n- `id` - Pixiv illust comment id (required)\n- `options` - object (optional)\n\n#### pixiv.novelComments(id, options)\nrequire auth\n\n- `id` - Pixiv novel id (required)\n- `options` - object (optional)\n\n#### pixiv.novelCommentsV2(id, options)\nrequire auth\n\n- `id` - Pixiv novel id (required)\n- `options` - object (optional)\n\n#### pixiv.novelCommentsV3(id, options)\nrequire auth\n\n- `id` - Pixiv novel id (required)\n- `options` - object (optional)\n\n#### pixiv.novelCommentReplies(id, options)\nrequire auth\n\n- `id` - Pixiv novel comment id (required)\n- `options` - object (optional)\n\n#### pixiv.novelCommentRepliesV2(id, options)\nrequire auth\n\n- `id` - Pixiv novel comment id (required)\n- `options` - object (optional)\n\n#### pixiv.illustRelated(id, options)\nrequire auth\n\n- `id` - Pixiv illust id (required)\n- `options` - object (optional)\n\n#### pixiv.illustDetail(id, options)\nrequire auth\n\n- `id` - Pixiv illust id (required)\n- `options` - object (optional)\n\n#### pixiv.novelDetail(id, options)\nrequire auth\n\n- `id` - Pixiv novel id (required)\n- `options` - object (optional)\n\n#### [Deprecated] pixiv.novelText(id, options)\nrequire auth\n\n- `id` - Pixiv novel id (required)\n- `options` - object (optional)\n\n#### pixiv.novelWebview(id, raw)\nrequire auth\n\n- `id` - Pixiv novel id (required)\n- `raw` - boolean (optional, default is false) Set to true to return return raw response string or false to return novel object\n\n#### pixiv.novelSeries(id, options)\nrequire auth\n\n- `id` - Pixiv novel series id (required)\n- `options` - object (optional)\n\n#### pixiv.illustNew(options)\nrequire auth\n\n- `options` - object (optional)\n \n#### pixiv.illustFollow(options)\nrequire auth\n\n- `options` - object (optional)\n  - `restrict` - one of `all` | `public` | `private`  (default: `all`)\n\n#### pixiv.novelFollow(options)\nrequire auth\n\n- `options` - object (optional)\n  - `restrict` - one of `all` | `public` | `private`  (default: `all`)\n\n#### pixiv.illustRecommended(options)\nrequire auth\n\n- `options` - object (optional)\n\n#### pixiv.illustRanking(options)\nrequire auth\n\n- `options` - object\n  - `date`: Date\n  - `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`)\n\n#### pixiv.novelRanking(options)\nrequire auth\n\n- `options` - object\n  - `date`: Date\n  - `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`)\n \n#### pixiv.illustMyPixiv()\nrequire auth\n\n#### pixiv.novelMyPixiv()\nrequire auth\n\n#### pixiv.illustAddComment(id, comment, parentCommentId)\nrequire auth\n\n- `id` - Pixiv illust id (required)\n- `comment` - string (required)\n- `parentCommentId` - Pixiv comment id (optional, to reply to comment`\n\n#### pixiv.novelAddComment(id, comment, parentCommentId)\nrequire auth\n\n- `id` - Pixiv novel id (required)\n- `comment` - string (required)\n- `parentCommentId` - Pixiv comment id (optional, to reply to comment`\n\n#### pixiv.ugoiraMetaData(id)\nrequire auth\n\n- `id` - Pixiv illust(ugoira) id (required)\n\n#### pixiv.trendingTagsIllust(options)\nrequire auth\n\n- `options` - object (optional)\n\n#### pixiv.trendingTagsNovel(options)\nrequire auth\n\n- `options` - object (optional)\n\n#### pixiv.bookmarkIllust(id, restrict, tags)\nrequire auth\n\n- `id` - Pixiv illust id (required)\n- `restrict` - one of `public` | `private` (default: `public`)\n- `tags` - array of string (optional)\n\n#### pixiv.unbookmarkIllust(id)\nrequire auth\n\n- `id` - Pixiv illust id (required)\n\n#### pixiv.bookmarkNovel(id, restrict, tags)\nrequire auth\n\n- `id` - Pixiv novel id (required)\n- `restrict` - one of `public` | `private` (default: `public`)\n- `tags` - array of string (optional)\n\n#### pixiv.unbookmarkNovel(id)\nrequire auth\n\n- `id` - Pixiv novel id (required)\n\n#### pixiv.mangaRecommended(options)\nrequire auth\n\n- `options` - object (optional)\n\n#### pixiv.mangaNew(options)\nrequire auth\n\n- `options` - object (optional)\n\n#### pixiv.searchNovel(word, options)\nrequire auth\n\n- `word` - word to search (required)\n- `options` - object (optional)\n  - `search_target`: `partial_match_for_tags` | `text` | `keyword` (default: `partial_match_for_tags`)\n  - `sort`: `date_desc` | `date_asc` | `popular_desc` (`popular_desc` only available for pixiv premium member) (default: `date_desc`)\n  - `start_date`: Date\n  - `end_date`: Date\n\n#### pixiv.searchNovelPopularPreview(word, options)\nrequire auth\n\n- `word` - word to search (required)\n- `options` - object (optional)\n  - `search_target`: `partial_match_for_tags` | `text` | `keyword` (default: `partial_match_for_tags`)\n  - `sort`: `date_desc` | `date_asc` | `popular_desc` (`popular_desc` only available for pixiv premium member) (default: `date_desc`)\n  - `start_date`: Date\n  - `end_date`: Date\n\n#### pixiv.searchNovelBookmarkRanges(word, options)\nrequire auth\n\n- `word` - word to search (required)\n- `options` - object (optional)\n  - `search_target`: `partial_match_for_tags` | `text` | `keyword` (default: `partial_match_for_tags`)\n  - `start_date`: Date\n  - `end_date`: Date\n   \n#### pixiv.novelRecommended(options)\nrequire auth\n\n- `options` - object (optional)\n\n#### pixiv.novelNew(options)\nrequire auth\n\n- `options` - object (optional)\n\n#### pixiv.novelRanking(options)\nrequire auth\n\n- `options` - object\n  - `date`: Date\n  - `mode`: `day` | `week` | `day_male` | `day_female` | `week_rookie` | `day_r18` | `day_male_r18` | `day_female_r18` | `week_r18` | `week_r18g` (default: `day`)\n\n#### pixiv.userRecommended(options)\nrequire auth\n\n- `options` - object (optional)\n\n#### pixiv.userFollowing(id, options)\nrequire auth\n\n- `id` - Pixiv user id (required)\n- `options` - object (optional)\n  - `restrict`: `public` | `private` (default: `public`)\n\n#### pixiv.userFollower(id, options)\nrequire auth\n\n- `id` - Pixiv user id (required)\n- `options` - object (optional)\n\n#### pixiv.userMyPixiv(id)\nrequire auth\n\n- `id` - Pixiv user id (required)\n\n#### pixiv.followUser(id, restrict)\nrequire auth\n\n- `id` - Pixiv user id (required)\n- `restrict` - one of `public` | `private` (default: `public`)\n\n#### pixiv.unfollowUser(id)\nrequire auth\n\n- `id` - Pixiv user id (required)\n\n#### pixiv.setLanguage(lang)\nset HTTP header Accept-Language for pixiv api request\n \n- `lang` - HTTP header Accept-Language\n\n#### pixiv.requestUrl(url, options)\ncan be use to request pixiv endpoint or use for traversing results by passing next_url from result of other api such as `pixiv.searchIllust`\n\n- `options` - object (optional)\n\n\n## Tests\n\nExport pixiv username and password before running Tests.\n\n```\n$ export refresh_token=pixiv account refresh_token\n$ npm test\n```\n\n## Related projects\n[PxView](https://github.com/alphasp/pxview) - Android/iOS client for Pixiv built in react-native\n\n## License\n\nMIT","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falphasp%2Fpixiv-api-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falphasp%2Fpixiv-api-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falphasp%2Fpixiv-api-client/lists"}