https://github.com/book000/pixivts

pixiv Unofficial API Library for TypeScript : https://book000.github.io/pixivts/
https://github.com/book000/pixivts

Last synced: 1 day ago
JSON representation

pixiv Unofficial API Library for TypeScript : https://book000.github.io/pixivts/

• Host: GitHub
• URL: https://github.com/book000/pixivts
• Owner: book000
• License: mit
• Created: 2023-04-14T05:52:36.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-11-06T22:06:10.000Z (8 days ago)
• Last Synced: 2024-11-06T23:18:06.934Z (8 days ago)
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@book000/pixivts
• Size: 1.87 MB
• Stars: 10
• Watchers: 1
• Forks: 2
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# pixivts

[pixiv](https://www.pixiv.net/) Unofficial API Library for TypeScript

This is NOT a fork of [@ibaraki-douji/pixivts](https://www.npmjs.com/package/@ibaraki-douji/pixivts). However, I do use it as a reference.

## 🚀 Install

This library is available at npm: [@book000/pixivts](https://www.npmjs.com/package/@book000/pixivts)

If you are using npm:

```shell

npm install @book000/pixivts

```

or if you are using yarn:

```shell

yarn add @book000/pixivts

```

## ✨ Features

- It mainly uses the private API that the iOS pixiv app communicates with. Inspired by [pixivpy](https://github.com/upbit/pixivpy).

- All API request methods return an [axios](https://www.npmjs.com/package/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](https://book000.github.io/pixivts/).  

Please note that many of the comments in the document are written in Japanese!

## 📑 License

This project is licensed under the [MIT License](LICENSE).