theBreadCompany/libpixiv
1
0
Fork 0
Code Issues 3 Pull requests Projects Releases Packages Wiki Activity Actions
No description
61 commits 3 branches 3 tags 304 KiB
  • Rust 100%
Find a file
Exact
theBreadCompany 7649415e29
Some checks failed
Publish / audit for vulnerabilities (push) Successful in 2m29s
Details
/ test (push) Successful in 59s
Details
Publish / test library (push) Successful in 1m1s
Details
Publish / publish (push) Failing after 28s
Details
add docs and fix pipeline
2026-02-05 21:00:52 +01:00
.cargo add publishing workflow 2025-09-03 03:38:37 +02:00
.forgejo/workflows add docs and fix pipeline 2026-02-05 21:00:52 +01:00
src add docs and fix pipeline 2026-02-05 21:00:52 +01:00
.gitignore remove fxpixiv 2025-09-03 02:30:53 +02:00
Cargo.lock add docs and fix pipeline 2026-02-05 21:00:52 +01:00
Cargo.toml add docs and fix pipeline 2026-02-05 21:00:52 +01:00
LICENSE fix file modes 2025-07-31 00:25:03 +02:00
README.md add docs and fix pipeline 2026-02-05 21:00:52 +01:00

README.md

libpixiv

Client library for pixiv

Usage

NOTE: Also consider minor version bumps as breaking change as long as this library is pre-1.0.

For now, no OAuth2 login will be provided, so please make sure to provide refresh tokens yourself.

The following features are available (some might be missing)

  • users
    • search
    • metadata
    • related
    • following/unfollowing
    • bookmarks
  • illustrations
    • search
    • metadata
    • related
    • comments
    • recommendations
    • bookmarking
    • bookmarks
  • animations (ugoira)
    • metadata lookup
    • NOTE: Animations are provided as image sequences, building those is currently not implemented in this crate.

Testing

You can run the following command to test existing features:

PIXIV_REFRESH_TOKEN= cargo test --lib

Notes

  • The crate user is currently responsible to refresh the token from time to time (API currently reports an expiration of 1 hour)
  • Documentation is NOT complete
  • cargo-llvm-cov currently reports a coverage of 67%
  • This is an unofficial API library, please consider all the implications this might have.
  • Also, this library is probably missing a few endpoints and/or features - if you happen to know or find any of those, feel free to open a PR :)