build_request

Method of TikTokHTTPClient.

BUILD a request to call the httpx client

Signature

async def build_request(
    url: str | URL,
    method: str,
    httpx_client: Optional[httpx.AsyncClient] = None,
    extra_params: Optional[Dict] = None,
    extra_headers: Optional[Dict] = None,
    base_params: bool = True,
    base_headers: bool = True,
    sign_url: bool = False,
    sign_url_method: Optional[str] = None,
    sign_url_type: Optional[Literal['xhr', 'fetch']] = None,
    sign_url_payload: Optional[str] = None,
    **kwargs,
) -> httpx.Request

Parameters

• url (str | URL) — The URL to request
• method (str) — The HTTP method to use
• httpx_client (Optional[httpx.AsyncClient], default None) — An optional override for the httpx.AsyncClient client
• extra_params (Optional[Dict], default None) — Extra parameters to append to the globals
• extra_headers (Optional[Dict], default None) — Extra headers to append to the globals
• base_params (bool, default True) — Whether to include the base params
• base_headers (bool, default True) — Whether to include the base headers
• sign_url (bool, default False) — Whether to sign the URL before requesting
• sign_url_method (Optional[str], default None) — The HTTP method to sign with
• sign_url_type (Optional[Literal['xhr', 'fetch']], default None) — The type of signing to use
• sign_url_payload (Optional[str], default None) — The payload to use for signing
• **kwargs — Optional keywords for the httpx.AsyncClient.get method

Returns

httpx.Request — An httpx.Response object

Import

from TikTokLive.client.web.web_base import TikTokHTTPClient

Source

TikTokLive/client/web/web_base.py:190