# HolodexWrapper Documentation

## Introduction

A Java wrapper for the [Holodex API](https://docs.holodex.net/docs/holodex/f4e6fa31af431-getting-started) developed with Java 11. 

This project is heavily inspired by [Holodex.NET](https://github.com/EBro912/Holodex.NET), you could even interpret it as an almost 1:1 translation of it. 

## Features

* Support for all the currently available GET and POST endpoints.
* Objects to easily customize your requests.
* All request parameters are included as constants (+70 VTuber groups and organizations).

## Dependencies

* dotenv-java 2.3.2
* unirest-java 1.4.9
* lombok 1.18.26
* junit-jupiter-engine 5.9.3
* jackson-databind 2.15.0
* jackson-datatype-jdk8 2.14.2
* jackson-datatype-jsr318 2.15.0

## Download

```xml
<dependency>
    <groupId>io.github.yagato</groupId>
    <artifactId>HolodexWrapper</artifactId>head
    <version>1.0.0</version>
</dependency>
```

```gradle
implementation group: 'io.github.yagato', name: 'HolodexWrapper', version: '1.0.0'
```

## Getting Started

1. Generate your API key (follow the [guide ](https://docs.holodex.net/docs/holodex/f4e6fa31af431-getting-started)at the official Holodex API documentation).
2. Add the dependency to your project.
3. Enjoy!

{% code lineNumbers="true" %}

```java
HolodexClient holodexClient = new HolodexClient("YOUR_API_KEY");
Channel channel = holodexClient.getChannelInformation("UC5CwaMl1eIgY8h02uZw7u8A");
System.out.println(channel.getName()); // Suisei Channel
System.out.println(channel.getOrg()); // Hololive
System.out.println(channel.getPublishedAt()); // 2018-03-18T08:32:39Z7
```

{% endcode %}