tikhub-api-java-client

High-performance asynchronous Douyin(抖音) TikTok Xiaohongshu(小红书) Kuaishou(快手) Weibo(微博) Instagram YouTube(油管) Twitter(X) Captcha Solver(验证码解决器) Temp Mail(临时邮箱) API(接口).

Release Information

• API version: V5.2.9
• Package Version: V1.0.1
• Build Date: 2025-03-08
• Base URL: https://api.tikhub.io

Useful Links

• 🏠 Home: https://www.tikhub.io
• 👨‍💻 Github: https://github.com/TikHub
• ⚡ Documents (Swagger UI): https://api.tikhub.io
• 🦊 Documents (Apifox UI): https://docs.tikhub.io
• 🐙 Demo Code (GitHub): https://github.com/TikHub/TikHub-API-Demo
• 📶 API Status: https://monitor.tikhub.io
• 📧 Support: Discord Server

Requirements

Building the API client library requires:

1. Java 11+
2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>io.tikhub</groupId>
  <artifactId>tikhub-api-java-client</artifactId>
  <version>1.0.1</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "io.tikhub:tikhub-api-java-client:1.0.1"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/tikhub-api-java-client-1.0.1.jar
• target/lib/*.jar

🔑 Authentication with API Key

Most endpoints in the TikHub API require an API Key for authentication. You need to include the API Key in the request header using the Authorization header.

Example: Configuring API Key in Java SDK

import io.tikhub.client.*;
import io.tikhub.client.api.TikHubUserApiApi;
import org.openapitools.client.ApiException;
import org.openapitools.client.model.UserInfoResponseModel;

public class TikHubApiExample {
    public static void main(String[] args) {
        // Initialize the API client
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Set the base URL for TikHub API
        defaultClient.setScheme("https") // Use HTTPS
                     .setHost("api.tikhub.io") // Correct API host
                     .setBasePath(""); // No extra path required

        // Set API Key authentication in the request header
        defaultClient.addDefaultHeader("Authorization", "Bearer YOUR_API_KEY_HERE");

        // Initialize the API instance
        TikHubUserApiApi apiInstance = new TikHubUserApiApi(defaultClient);

        try {
            // Fetch user account details
            UserInfoResponseModel result = apiInstance.getUserInfoApiV1TikhubUserGetUserInfoGet().get();
            System.out.println("User Info: " + result);
        } catch (ApiException e) {
            System.err.println("API request failed: " + e.getMessage());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

---

📖 Example Usage

1️⃣ Fetching Available Endpoints

To get a list of available API endpoints:

import io.tikhub.client.*;
import io.tikhub.client.api.TikHubUserApiApi;
import org.openapitools.client.ApiException;
import org.openapitools.client.model.ResponseModel;

public class EndpointsExample {
    public static void main(String[] args) {
        ApiClient client = Configuration.getDefaultApiClient();
        
        // Set the base URL for TikHub API
        client.setScheme("https") // Use HTTPS
                     .setHost("api.tikhub.io") // Correct API host
                     .setBasePath(""); // No extra path required

        // Set API Key authentication in the request header
        client.addDefaultHeader("Authorization", "Bearer YOUR_API_KEY_HERE");

        TikHubUserApiApi apiInstance = new TikHubUserApiApi(client);

        try {
            ResponseModel endpoints = apiInstance.getAllEndpointsInfoApiV1TikhubUserGetAllEndpointsInfoGet().get();
            System.out.println("Available Endpoints: " + endpoints);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

---

2️⃣ Calculating API Pricing

To calculate the pricing based on usage:

import io.tikhub.client.*;
import io.tikhub.client.api.TikHubUserApiApi;
import org.openapitools.client.ApiException;
import org.openapitools.client.model.ResponseModel;

public class PricingExample {
    public static void main(String[] args) {
        ApiClient client = Configuration.getDefaultApiClient();
        
        // Set the base URL for TikHub API
        client.setScheme("https") // Use HTTPS
                     .setHost("api.tikhub.io") // Correct API host
                     .setBasePath(""); // No extra path required

        // Set API Key authentication in the request header
        client.addDefaultHeader("Authorization", "Bearer YOUR_API_KEY_HERE");

        TikHubUserApiApi apiInstance = new TikHubUserApiApi(client);

        try {
            String endpoint = "/api/v1/tiktok/app/v3/fetch_one_video_by_share_url";
            int requestPerDay = 5000;

            ResponseModel pricing = apiInstance.calculatePriceApiV1TikhubUserCalculatePriceGet(endpoint, requestPerDay).get();
            System.out.println("Pricing Details: " + pricing);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

---

📄 Additional Notes

• Replace YOUR_API_KEY_HERE with your actual API Key.
• The API client supports asynchronous requests using CompletableFuture<>, allowing for non-blocking API calls.
• This SDK is automatically generated using the OpenAPI Generator and should not be manually modified unless necessary.

For full API documentation, please visit TikHub.io API Docs.

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues. However, the instances of the api clients created from the ApiClient are thread-safe and can be re-used.

Documentation for API Endpoints

All URIs are relative to https://api.tikhub.io

Class	Method	HTTP request	Description
BilibiliWebApiApi	fetchCollectFoldersApiV1BilibiliWebFetchAllLiveAreasGet	GET /api/v1/bilibili/web/fetch_all_live_areas	获取所有直播分区列表/Get a list of all live areas
BilibiliWebApiApi	fetchCollectFoldersApiV1BilibiliWebFetchAllLiveAreasGet_0	GET /api/v1/bilibili/web/fetch_all_live_areas	获取所有直播分区列表/Get a list of all live areas
BilibiliWebApiApi	fetchCollectFoldersApiV1BilibiliWebFetchCollectFoldersGet	GET /api/v1/bilibili/web/fetch_collect_folders	获取用户所有收藏夹信息/Get user collection folders
BilibiliWebApiApi	fetchCollectFoldersApiV1BilibiliWebFetchCollectFoldersGet_0	GET /api/v1/bilibili/web/fetch_collect_folders	获取用户所有收藏夹信息/Get user collection folders
BilibiliWebApiApi	fetchCollectFoldersApiV1BilibiliWebFetchComPopularGet	GET /api/v1/bilibili/web/fetch_com_popular	获取综合热门视频信息/Get comprehensive popular video information
BilibiliWebApiApi	fetchCollectFoldersApiV1BilibiliWebFetchComPopularGet_0	GET /api/v1/bilibili/web/fetch_com_popular	获取综合热门视频信息/Get comprehensive popular video information
BilibiliWebApiApi