BooruSharp 3.0.4

Install-Package BooruSharp -Version 3.0.4
dotnet add package BooruSharp --version 3.0.4
<PackageReference Include="BooruSharp" Version="3.0.4" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add BooruSharp --version 3.0.4
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: BooruSharp, 3.0.4"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install BooruSharp as a Cake Addin
#addin nuget:?package=BooruSharp&version=3.0.4

// Install BooruSharp as a Cake Tool
#tool nuget:?package=BooruSharp&version=3.0.4
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

BooruSharp

BooruSharp is a C# library to browse Booru websites easily<br/> You can download it from NuGet:

Install-Package BooruSharp
Install-Package BooruSharp.Others

BooruSharp currently handle the following websites:

  • booru.allthefallen.moe
  • danbooru.donmai.us
  • e621.net
  • e926.net
  • gelbooru.com
  • konachan.com
  • lolibooru.moe
  • realbooru.com
  • rule34.xxx
  • safebooru.org
  • sakugabooru.com
  • beta.sankakucomplex.com
  • xbooru.com
  • yande.re

BooruSharp.Others allow to handle more websites that aren't booru:

  • pixiv.net

Documentation

Documentation for version > 2.0.0 isn't available for now
Please either refer to the examples below or use the XML documentation in the code
If you have any question, feel free to contact me

Features availability

Booru Multiple Random Images Post by ID Post by MD5 Tag by ID Comment API Last Comments API Wiki API Related Tag API Post Count API Favorite API
Atfbooru ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️
Danbooru Donmai ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️
E621 ✔️ ✔️ ✔️
E926 ✔️ ✔️ ✔️
Gelbooru ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️
Konachan ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️
Lolibooru ✔️ ✔️ ✔️ ✔️ ✔️
Realbooru ✔️ ✔️ ✔️ ✔️ ✔️ ✔️
Rule 34 ✔️ ✔️ ✔️ ✔️
Safebooru ✔️ ✔️ ✔️ ✔️
Sakugabooru ✔️ ✔️ ✔️ ✔️ ✔️ ✔️
Sankaku Complex ✔️ ✔️ ✔️ ✔️
Xbooru ✔️ ✔️ ✔️ ✔️ ✔️ ✔️
Yandere ✔️ ✔️ ✔️ ✔️ ✔️ ✔️ ✔️
Pixiv ✔️ ✔️ ✔️

Additional notes on Pixiv

Pixiv also have 2 methods to download an image (ImageToByteArrayAsync) or a preview (PreviewToByteArrayAsync), it'll give you a byte array given a SearchResult

Please make note that you also need to provide at least one tag for he following methods:

  • GetLastPostsAsync
  • GetPostCountAsync
  • GetRandomPostAsync

Examples

Random image

var booru = new BooruSharp.Booru.Gelbooru();
var result = await booru.GetRandomPostAsync("hibiki_(kantai_collection)", "school_swimsuit");

Console.WriteLine("Image preview URL: " + result.PreviewUrl.AbsoluteUri + Environment.NewLine +
                  "Image URL: " + result.FileUrl.AbsoluteUri + Environment.NewLine +
                  "Image is safe: " + (result.Rating == BooruSharp.Search.Post.Rating.Safe) + Environment.NewLine +
                  "Tags on the image: " + String.Join(", ", result.Tags));

Random image (Pixiv)

var booru = new BooruSharp.Others.Pixiv();
await booru.LoginAsync("[refreshToken]"); // See https://github.com/Xwilarg/BooruSharp/#pixiv
var result = await booru.GetRandomPostAsync("シンボリルドルフ(ウマ娘)");

Many random images at once

var booru = new BooruSharp.Booru.SankakuComplex();
var results = await booru.GetRandomPostsAsync(10, "ifrit_(arknights)", "silence_(arknights)");

Console.WriteLine(string.Join(Environment.NewLine, results.Select(x => "Random Image: " + x.FileUrl)));

Get tag

var booru = new BooruSharp.Booru.Safebooru();
var result = await booru.GetTagAsync("cirno");

Console.WriteLine("Tag type: " + result.Type + Environment.NewLine +
                  "ID: " + result.ID);

Get Wiki entry

var booru = new BooruSharp.Booru.Konachan();
var result = await booru.GetWikiAsync("loli");

Console.WriteLine("Description: " + result.Body + Environment.NewLine +
                  "ID: " + result.ID + Environment.NewLine +
                  "Created at: " + result.Creation.ToString("dd/MM/yy HH:mm:ss") + Environment.NewLine +
                  "Last update at: " + result.LastUpdate.ToString("dd/MM/yy HH:mm:ss"));

Get related tags

var booru = new BooruSharp.Booru.Yandere();
var results = await booru.GetRelatedAsync("see_through");

Console.WriteLine(String.Join(Environment.NewLine,
    results.Select(delegate (BooruSharp.Search.Related.SearchResult res) { return ("Name: " + res.Name +" (" + res.Count + ")"); })));

Get comments

var booru = new BooruSharp.Booru.Lolibooru();
var results = await booru.GetCommentAsync(134097);

Console.WriteLine(String.Join(Environment.NewLine,
    results.Select(delegate (BooruSharp.Search.Comment.SearchResult res) { return ("Author: " + res.AuthorName + ", the " + res.Creation.ToString("dd/MM/yy HH:mm:ss") + " - " + res.Body); })));

Add to favorite

var booru = new BooruSharp.Booru.Safebooru();
booru.SetBooruAuth(new BooruSharp.Booru.BooruAuth("yourUserId", "yourPasswordHash")); // See https://github.com/Xwilarg/BooruSharp/#booru
await booru.AddFavoriteAsync(1759793);

Get all character tags containing a string

var yandere = new BooruSharp.Booru.Yandere();
var results = await yandere.GetTagsAsync("tsukiko");
Console.WriteLine(String.Join(Environment.NewLine,
	results.Where(delegate (BooruSharp.Search.Tag.SearchResult res) { return (res.Type == BooruSharp.Search.Tag.TagType.Character); })
           .Select(delegate (BooruSharp.Search.Tag.SearchResult res) { return (res.Name); })));

Authentification

Booru

For booru authentification, you'll need your user id and your password hash
To get it, I advise you to go on an image, open the developer panel (F12) and go in "Network"
Then press the button to add the image to your favorite and look at the "Cookies" section of the last request Authentification

Pixiv

For Pixiv authentification, please use LoginAsync with a refresh token
To get your refresh token, you can follow this tutorial: https://gist.github.com/ZipFile/c9ebedb224406f4f11845ab700124362

Want to contribute

Feel free to open a pull request.

Need more help

Feel free to open an issue or come ask on Discord.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on BooruSharp:

Package Downloads
BooruSharp.Others

Extension of BooruSharp to handle non-booru websites and handle them like the others

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.0.4 21 1/19/2022
3.0.3 1,139 5/21/2021
3.0.2 998 2/5/2021
3.0.1 633 11/17/2020
3.0.0 310 11/12/2020
2.11.0 917 9/7/2020
2.10.0 716 8/18/2020
2.9.0 625 8/17/2020
2.8.1 301 8/17/2020
2.8.0 573 8/2/2020
2.7.0 425 7/9/2020
2.6.1 283 7/8/2020
2.6.0 279 7/8/2020
2.5.0 247 7/7/2020
2.4.0 234 7/6/2020
2.3.1 305 6/23/2020
2.3.0 295 6/22/2020
2.2.0 238 6/22/2020
2.1.0 351 6/4/2020
2.0.3 800 3/24/2020
2.0.2 290 3/24/2020
2.0.1 280 3/23/2020
2.0.0 292 3/21/2020
1.4.8 414 2/21/2020
1.4.7 322 1/31/2020
1.4.6 404 9/24/2019
1.4.4 775 8/1/2019
1.4.3 439 7/13/2019
1.4.2 570 5/30/2019
1.4.1 627 4/8/2019
1.4.0 507 2/27/2019
1.3.6 677 1/10/2019
1.3.5 542 1/5/2019
1.3.3 676 10/17/2018
1.3.1 609 8/21/2018
1.3.0 638 8/14/2018
1.2.0 601 7/31/2018
1.1.1 573 7/30/2018
1.1.0 591 7/27/2018
1.0.1 625 7/22/2018