ImageBoard API

ImageBoard API is a simple asynchronous Java API wrapper around the most popular danbooru-compatible imageboard APIs. The interface also supports other types of custom boards given a little tweaking. Releases are published in Bintray.

This helps you craft requests to most of the danbooru-compatible imageboards (boorus) that exist out there.

Supported Image Boards

• Rule34
• e621
• Konachan
• Yande.re
• Danbooru
• Safebooru
• Gelbooru
• e926

Creating your own ImageBoard instance is possible, but would require a little tweaking. Please refer to the ImageBoards.java and CustomBoard.java to set up boards that are not included with this API. The boorus listed above are available by default with no further configuration required by the user.

Adding ImageBoardAPI to your project

Check instructions here for the latest version, in case this is outdated

Gradle

repositories {
maven {
url "https://dl.bintray.com/kodehawa/maven" }
}
dependencies { implementation 'net.kodehawa:imageboard-api:2.4.1'
}

Maven

Add the https://dl.bintray.com/kodehawa/maven repository to your pom.

<dependency>
<groupId>net.kodehawa</groupId>
<artifactId>imageboard-api</artifactId>
<version>2.4.1</version>
<type>pom</type>
</dependency>

Set Up

There is a ImageBoards class located under utils, that one contains static, pre-created ImageBoardAPI objects for you, but you can roll your own.

Implementation

You can find implementation details and a lot of examples in the tests for this project and in Mantaro

Examples

Random Images

importnet.kodehawa.lib.imageboards.entities.BoardImage;
importnet.kodehawa.lib.imageboards.DefaultImageBoards;
publicclassRandomImages {
publicstaticvoidmain(String[] args) {
// Asynchronous GET// 60 random imagesDefaultImageBoards.KONACHAN.get().async(images -> {
for (BoardImageimage : images) System.out.println(image.getURL());
});
// Asynchronous GET// 30 random imagesImageBoards.KONACHAN.get(30).async(images -> {
for (BoardImageimage : images) System.out.println(image.getURL());
});
// Blocking GET// 5 random imageBoardImageimage = DefaultImageBoards.KONACHAN.get(5).blocking().get(0);
System.out.println(image.getURL());
System.out.println(image.getRating());
System.out.println(image.getTags());
System.out.println(image.getHeight());
System.out.println(image.getWidth());
}
}

Image Tag Search

importnet.kodehawa.lib.imageboards.entities.BoardImage;
importnet.kodehawa.lib.imageboards.DefaultImageBoards;
publicclassTagImages {
publicstaticvoidmain(String[] args) {
// Asynchronous GET// 20 images tagged with animal_earsDefaultImageBoards.KONACHAN.search(20, "animal_ears").async(images -> {
for (BoardImageimage : images) System.out.println(image.getURL());
});
// Blocking GET// 60 images tagged with animal_earsBoardImageimage = DefaultImageBoards.KONACHAN.search("animal_ears").blocking().get(0);
System.out.println(image.getURL());
System.out.println(image.getRating());
System.out.println(image.getTags());
System.out.println(image.getHeight());
System.out.println(image.getWidth());
}
}

Filter bad results

You might want to filter BoardImage#isPending, as the tags/rating of those is almost guaranteed to never be correct.

For filtering other results, you can filter tags from BoardImage#getTags and use a .contains call on the list.