Skip to content

book000/pixivts

Repository files navigation

pixivts

pixiv Unofficial API Library for TypeScript

This is NOT a fork of @ibaraki-douji/pixivts. However, I do use it as a reference.

🚀 Install

This library is available at npm: @book000/pixivts

If you are using npm:

npm install @book000/pixivts

or if you are using yarn:

yarn add @book000/pixivts

✨ Features

  • It mainly uses the private API that the iOS pixiv app communicates with. Inspired by pixivpy.
  • All API request methods return an axios response. This allows this library users to use all responses, without having to wait for library updates if the API response changes.

📚 API Document

The API documentation for this library is hosted on GitHub Pages and can be found here.
Please note that many of the comments in the document are written in Japanese!

📑 License

This project is licensed under the MIT License.