waifu-pics-api
v1.0.6
Published
An up-to-date unofficial wrapper for the Waifu.pics API 100% API Coverage 100% Type-Script coverage
Readme
⚠️ DEPRECATION NOTICE
This package is temporarily or indefinitely deprecated, depending on whether the API will come back online or not. At the time of writing this (07/05/2026) the waifu.pics domain has expired and the API is not accessible. With the last update this package is made unusable, to prevent users from receiving empty responses.
Waifu.Pics API Wrapper
An up-to-date unofficial wrapper for the Waifu.pics API 100% API Coverage 100% TypeScript Coverage
Getting started
import WaifuPics from 'waifu-pics-api';
await WaifuPics('neko'); // returns String
await WaifuPics('neko', { nsfw: true }); // returns String
await WaifuPics('neko', { many: true }); // returns Array of Strings
await WaifuPics('neko', { nsfw: true, many: true }); // returns Array of Strings
await WaifuPics('neko', { many: true, exclude: ['https://i.waifu.pics/xxx.jpg'] }); // returns Array of Strings
await WaifuPics('neko', { nsfw: true, many: true, exclude: ['https://i.waifu.pics/xxx.jpg'] }); // returns Array of StringsOptions
nsfw: boolean
many: boolean
exclude: string[] (Array of URLs)
(All options are optional)Support
If you need Help, please contact me at Discord or open an Issue on GitHub
Contributing
I will happily accept your Pull-Request if it:
- looks reasonable
- does not break backwards compatibility
