From 0240139464d69a6ad213aeefad30e4649b4b5e89 Mon Sep 17 00:00:00 2001 From: Pinapelz Date: Fri, 17 Jan 2025 23:35:12 -0800 Subject: add jholodex --- .vitepress/config.mts | 3 +- repos/jholodex.md | 120 ++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 122 insertions(+), 1 deletion(-) create mode 100644 repos/jholodex.md diff --git a/.vitepress/config.mts b/.vitepress/config.mts index 5b95f02..b9b8278 100644 --- a/.vitepress/config.mts +++ b/.vitepress/config.mts @@ -16,7 +16,8 @@ export default defineConfig({ items: [ { text: 'Patchwork Archive API', link: '/repos/patchwork-archive-api' }, { text: 'I Miss Someone VT (Legacy)', link: '/repos/i-miss-someone-vt' }, - { text: 'VTuber Captcha', link: '/repos/vtuber-captcha' } + { text: 'VTuber Captcha', link: '/repos/vtuber-captcha' }, + { text: 'JHolodex', link: '/repos/jholodex' }, ] }, { diff --git a/repos/jholodex.md b/repos/jholodex.md new file mode 100644 index 0000000..fb054b6 --- /dev/null +++ b/repos/jholodex.md @@ -0,0 +1,120 @@ +--- +title: JHolodex +lang: en-US +outline: deep +--- +Below is so mini-docs/examples for how to use JHolodex, a Java wrapper for the Holodex API. Its very heavily object oriented + +# JHolodex +[![build](https://github.com/pinapelz/JHolodex/actions/workflows/maven.yml/badge.svg)](https://github.com/pinapelz/JHolodex/actions/workflows/maven.yml) +![Maven Central](https://img.shields.io/maven-central/v/com.pinapelz/jholodex) + + +A Java wrapper for the [Holodex API](https://docs.holodex.net/#section/Holodex-API-Documentation). + +All GET and POST requests are supported and is modelled after the Holodex API. +Please check the [Holodex API](https://holodex.stoplight.io/) for more information regarding the specifications + + +[Holodex License](https://docs.holodex.net/#section/LICENSE) + +## Download +![Maven Central](https://img.shields.io/maven-central/v/com.pinapelz/jholodex) + +### Maven +```xml + + com.pinapelz + jholodex + VERSION + +``` + +### Gradle +![Maven Central](https://img.shields.io/maven-central/v/com.pinapelz/jholodex) +```java +implementation group: 'com.pinapelz', name: 'jholodex', version: '1.4' +``` + +Alternatively use Jitpack for pre-releases + + + +## Getting Started +Please check what values are available at each endpoint through the [Holodex API Documentation](https://docs.holodex.net/#section/Holodex-API-Documentation). + +The use of enums is optional, you can always pass in Strings as parameters as they appear on Holodex + +The following are some example use cases to get you started. +### Channel Information +```java +Holodex holodex = new Holodex("YOUR_API_KEY_HERE"); +Channel channel = holodex.getChannel("UCupmjRr7kPgzXKh-cPxxGbg"); +System.out.println(channel.name); // Erina Ch. エリナ・マキナ 【Phase Connect】 +System.out.println(channel.english_name); // Erina Makina # This provides an English or localized name if available +System.out.println(channel.type); // vtuber +System.out.println(channel.subscriber_count); // 28500 +``` + +### Live and Upcoming Videos +Queries the videos for a particular channel +```java +List