Module TikTok.Query

Provides the Query class, which facilitates interaction with the TikTok API.

The Query class acts as a façade for accessing various underlying query classes that handle specific API requests. To understand the available methods and functionalities, users should refer to the class variables that represent these underlying query classes.

This class is designed to work with an OAuth2 authentication instance and an asynchronous HTTP client to perform various API requests, such as retrieving user and playlist information. The module also handles error logging and exception management.

Usage

1. Authenticate using the OAuth2 class:

from TikTok.Auth import OAuth2
from TikTok.ValidationModels.OAuth2 import RequestHeadersModel, TokenRequestBodyModel

auth: OAuth2 = await OAuth2.authenticate(
    headers=RequestHeadersModel(),
    body=TokenRequestBodyModel(
        client_key="YOUR_CLIENT_KEY",
        client_secret="YOUR_CLIENT_SECRET",
    ),
)

1. Instantiate the Query class with the authenticated OAuth2 instance:

from TikTok.Query import Query

query = Query(auth)

1. Retrieve user information:

from TikTok.ValidationModels.User import UserInfoQueryFields

user_info = await query.user.info(
    username="example_username",
    fields=[
        UserInfoQueryFields.display_name,
        UserInfoQueryFields.follower_count,
        UserInfoQueryFields.following_count,
        UserInfoQueryFields.video_count,
        UserInfoQueryFields.likes_count,
    ],
)

1. Retrieve playlist information:

playlist_info = await query.playlist.info(
    playlist_id=123456,
    cursor=None,
)

Classes

class Query (auth: OAuth2)

A class to interact with the TikTok API.

This class requires an OAuth2 authentication instance to initialize and uses an asynchronous HTTP client to make requests to the TikTok API.

Attributes

client : httpx.AsyncClient

The HTTP client for making API requests.

auth : OAuth2

The OAuth2 authentication instance.

endpoints : APIEndpoints

The API endpoints used for making requests.

Initializes the Query class with an OAuth2 authentication instance.

Parameters

auth (OAuth2): An instance of OAuth2 for authentication.

Expand source code

class Query:
    """
    A class to interact with the TikTok API.

    This class requires an OAuth2 authentication instance to initialize and uses an
    asynchronous HTTP client to make requests to the TikTok API.

    Attributes:
        client (httpx.AsyncClient): The HTTP client for making API requests.
        auth (OAuth2): The OAuth2 authentication instance.
        endpoints (APIEndpoints): The API endpoints used for making requests.
    """

    client: httpx.AsyncClient
    auth: OAuth2
    endpoints: APIEndpoints
    user: UserQueries
    playlist: PlaylistQueries
    video: VideoQueries

    def __init__(self, auth: OAuth2):
        """
        Initializes the Query class with an OAuth2 authentication instance.

        Parameters:
            auth (OAuth2): An instance of OAuth2 for authentication.
        """
        self.client = httpx.AsyncClient()
        self.auth = auth
        self.endpoints = APIEndpoints()
        self.user = UserQueries(self)
        self.playlist = PlaylistQueries(self)
        self.video = VideoQueries(self)

Class variables

var auth : OAuth2

var client : httpx.AsyncClient

var endpoints : APIEndpoints

var playlist : PlaylistQueries

var user : UserQueries

var video : VideoQueries