WebcastHttpClient

Defined in: src/lib/web/lib/http-client.ts:16

Constructors

Constructor

new WebcastHttpClient(webcastWebConfig, eulerApiInstance?, gotHttpConfig?): WebcastHttpClient

Defined in: src/lib/web/lib/http-client.ts:38

Instantiate a Webcast HTTP Client

Parameters

webcastWebConfig

Randomized config for Webcast requests

DEFAULT_HTTP_CLIENT_HEADERS

{ Accept: string; Accept-Encoding: string; Accept-Language: string; Cache-Control: string; Connection: string; Cookie: string; Origin: string; Referer: string; Sec-Fetch-Dest: string; Sec-Fetch-Mode: string; Sec-Fetch-Site: string; Sec-Fetch-Ua-Mobile: string; User-Agent: string; } = ...

DEFAULT_HTTP_CLIENT_HEADERS.Accept

string = 'text/html,application/json,application/protobuf'

DEFAULT_HTTP_CLIENT_HEADERS.Accept-Encoding

string = 'gzip, deflate'

DEFAULT_HTTP_CLIENT_HEADERS.Accept-Language

string = 'en-US,en;q=0.9'

DEFAULT_HTTP_CLIENT_HEADERS.Cache-Control

string = 'max-age=0'

DEFAULT_HTTP_CLIENT_HEADERS.Connection

string = 'keep-alive'

DEFAULT_HTTP_CLIENT_HEADERS.Cookie

string = 'tt-target-idc=useast1a'

DEFAULT_HTTP_CLIENT_HEADERS.Origin

string = 'https://www.tiktok.com'

DEFAULT_HTTP_CLIENT_HEADERS.Referer

string = 'https://www.tiktok.com/'

DEFAULT_HTTP_CLIENT_HEADERS.Sec-Fetch-Dest

string = 'empty'

DEFAULT_HTTP_CLIENT_HEADERS.Sec-Fetch-Mode

string = 'cors'

DEFAULT_HTTP_CLIENT_HEADERS.Sec-Fetch-Site

string = 'same-site'

DEFAULT_HTTP_CLIENT_HEADERS.Sec-Fetch-Ua-Mobile

string = '?0'

DEFAULT_HTTP_CLIENT_HEADERS.User-Agent

string = TEMPLATED_VALUE

DEFAULT_HTTP_CLIENT_OPTIONS

{ } = {}

DEFAULT_HTTP_CLIENT_PARAMS

{ aid: string; app_language: string; app_name: string; browser_language: string; browser_name: string; browser_online: string; browser_platform: string; browser_version: string; channel: string; cookie_enabled: string; data_collection_enabled: string; device_id: string; device_platform: string; focus_state: string; from_page: string; history_len: string; is_fullscreen: string; is_page_visible: string; os: string; priority_region: string; referer: string; region: string; root_referer: string; screen_height: string; screen_width: string; tz_name: string; user_is_login: string; webcast_language: string; } = ...

DEFAULT_HTTP_CLIENT_PARAMS.aid

string = ...

DEFAULT_HTTP_CLIENT_PARAMS.app_language

string = TEMPLATED_VALUE

DEFAULT_HTTP_CLIENT_PARAMS.app_name

string = 'tiktok_web'

DEFAULT_HTTP_CLIENT_PARAMS.browser_language

string = TEMPLATED_VALUE

DEFAULT_HTTP_CLIENT_PARAMS.browser_name

string = TEMPLATED_VALUE

DEFAULT_HTTP_CLIENT_PARAMS.browser_online

string = 'true'

DEFAULT_HTTP_CLIENT_PARAMS.browser_platform

string = TEMPLATED_VALUE

DEFAULT_HTTP_CLIENT_PARAMS.browser_version

string = TEMPLATED_VALUE

DEFAULT_HTTP_CLIENT_PARAMS.channel

string = 'tiktok_web'

DEFAULT_HTTP_CLIENT_PARAMS.cookie_enabled

string = 'true'

DEFAULT_HTTP_CLIENT_PARAMS.data_collection_enabled

string = 'true'

DEFAULT_HTTP_CLIENT_PARAMS.device_id

string = TEMPLATED_VALUE

DEFAULT_HTTP_CLIENT_PARAMS.device_platform

string = 'web_pc'

DEFAULT_HTTP_CLIENT_PARAMS.focus_state

string = 'true'

DEFAULT_HTTP_CLIENT_PARAMS.from_page

string = 'user'

DEFAULT_HTTP_CLIENT_PARAMS.history_len

string = '10'

DEFAULT_HTTP_CLIENT_PARAMS.is_fullscreen

string = 'false'

DEFAULT_HTTP_CLIENT_PARAMS.is_page_visible

string = 'true'

DEFAULT_HTTP_CLIENT_PARAMS.os

string = TEMPLATED_VALUE

DEFAULT_HTTP_CLIENT_PARAMS.priority_region

string = TEMPLATED_VALUE

DEFAULT_HTTP_CLIENT_PARAMS.referer

string = 'https://www.tiktok.com/'

DEFAULT_HTTP_CLIENT_PARAMS.region

string = TEMPLATED_VALUE

DEFAULT_HTTP_CLIENT_PARAMS.root_referer

string = 'https://www.tiktok.com/'

DEFAULT_HTTP_CLIENT_PARAMS.screen_height

string = TEMPLATED_VALUE

DEFAULT_HTTP_CLIENT_PARAMS.screen_width

string = TEMPLATED_VALUE

DEFAULT_HTTP_CLIENT_PARAMS.tz_name

string = TEMPLATED_VALUE

DEFAULT_HTTP_CLIENT_PARAMS.user_is_login

string = 'true'

DEFAULT_HTTP_CLIENT_PARAMS.webcast_language

string = TEMPLATED_VALUE

SESSION_COOKIE_NAMES

string[] = ...

TARGET_IDC_COOKIE_NAME

string = 'tt-target-idc'

TIKTOK_HOST_WEB

string = 'www.tiktok.com'

TIKTOK_HOST_WEBCAST

string = 'webcast.tiktok.com'

TIKTOK_HTTP_ORIGIN

string = 'https://www.tiktok.com'

eulerApiInstance?

EulerStreamApiClient

Rarely needed override for the cached & lazy-loaded API client

gotHttpConfig?

WebcastGotHttpConfig

Rarely needed override for the Got HTTP library configuration

Returns

WebcastHttpClient

Properties

clientHeaders

readonly clientHeaders: Record<string, string>

Defined in: src/lib/web/lib/http-client.ts:28

clientParams

readonly clientParams: Record<string, string>

Defined in: src/lib/web/lib/http-client.ts:27

cookieJar

readonly cookieJar: WebcastCookieJar

Defined in: src/lib/web/lib/http-client.ts:29

oAuthSessionBundle

oAuthSessionBundle: OAuthTokenSessionBundle | null = null

Defined in: src/lib/web/lib/http-client.ts:19

Accessors

apiClient

Get Signature

get apiClient(): EulerStreamApiClient

Defined in: src/lib/web/lib/http-client.ts:82

Get an instance of the underlying API Client

Returns

EulerStreamApiClient

roomId

Get Signature

get roomId(): string

Defined in: src/lib/web/lib/http-client.ts:98

Get the Room ID for the client

Returns

string

Set Signature

set roomId(roomId): void

Defined in: src/lib/web/lib/http-client.ts:91

Set the Room ID for the client

Parameters

roomId

string

The client’s Room ID

Returns

void

Methods

getDeserializedObjectFromWebcastApi()

getDeserializedObjectFromWebcastApi<T>(path, params, schemaName, signRequest?, options?): Promise<WebcastMessage[T]>

Defined in: src/lib/web/lib/http-client.ts:201

Get deserialized object from Webcast API

Type Parameters

T

Parameters

path

string

Path to the API endpoint

params

Record<string, string>

Query parameters to be sent with the request

schemaName

T

Schema name for deserialization

signRequest?

boolean = false

Whether to sign the request or not

options?

Partial<WebcastHttpClientRequestParams> = {}

Additional request options

Returns

Promise<WebcastMessage[T]>

getHtmlFromTikTokWebsite()

getHtmlFromTikTokWebsite(path, options?): Promise<string>

Defined in: src/lib/web/lib/http-client.ts:174

Get HTML from TikTok website

Parameters

path

string

Path to the HTML page

options?

Partial<WebcastHttpClientRequestParams> = {}

Additional request options

Returns

Promise<string>

getJsonObjectFromTikTokApi()

getJsonObjectFromTikTokApi<T>(path, params, signRequest?, options?): Promise<T>

Defined in: src/lib/web/lib/http-client.ts:287

Get JSON object from TikTok API

Type Parameters

T

T extends Record<string, any>

Parameters

path

string

Path to the API endpoint

params

Record<string, string>

Query parameters to be sent with the request

signRequest?

boolean = false

Whether to sign the request or not

options?

Partial<WebcastHttpClientRequestParams> = {}

Additional request options

Returns

Promise<T>

getJsonObjectFromWebcastApi()

getJsonObjectFromWebcastApi<T>(path, params, signRequest?, options?): Promise<T>

Defined in: src/lib/web/lib/http-client.ts:258

Get JSON object from Webcast API

Type Parameters

T

T extends Record<string, any>

Parameters

path

string

Path to the API endpoint

params

Record<string, string>

Query parameters to be sent with the request

signRequest?

boolean = false

Whether to sign the request or not

options?

Partial<WebcastHttpClientRequestParams> = {}

Additional request options

Returns

Promise<T>

postJsonObjectToWebcastApi()

postJsonObjectToWebcastApi<T>(path, params, data, signRequest?, options?): Promise<T>

Defined in: src/lib/web/lib/http-client.ts:222

Type Parameters

T

T extends Record<string, any>

Parameters

path

string

params

Record<string, string>

data

Record<string, any>

signRequest?

boolean = false

options?

Partial<WebcastHttpClientRequestParams> = {}

Returns

Promise<T>

request()

request(__namedParameters): Promise<Response<string>>

Defined in: src/lib/web/lib/http-client.ts:116

Issue an HTTP request, merging the per-call options with the live client state (headers, search params, cookie jar) and optionally routing the URL through the sign server first.

host: host portion of the request URL.
path: path appended to the host.
searchParams: merged on top of clientParams; per-call values win.
signRequest: sign through RouteConfig.fetchWebcastSignatureFromProvider and honor the returned URL and User-Agent.
method: HTTP method, defaulting to GET.
headers: merged on top of clientHeaders; per-call values win.

Other fields are forwarded to got (body, responseType, retry, etc.).

Parameters

__namedParameters

WebcastHttpClientRequestParams

Returns

Promise<Response<string>>