-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Create functions for executing API calls of 4 kinds: * comment/list/ - video comments * post/item_list/ - user posts * challenge/item_list/ - popular videos tagged with a challenge * related/item_list/ - videos related to this one * Opens up potential future resolutions for #35, #38, #40, #43, and #44
- Loading branch information
1 parent
7f18280
commit 417859d
Showing
4 changed files
with
800 additions
and
0 deletions.
There are no files selected for viewing
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,192 @@ | ||
from urllib.parse import quote, urlencode | ||
|
||
from playwright.async_api import BrowserContext as AsyncContext | ||
from playwright.sync_api import BrowserContext as SyncContext | ||
from tiktokapipy import TikTokAPIError | ||
from tiktokapipy.util.signing import ( | ||
sign_and_get_request_async, | ||
sign_and_get_request_sync, | ||
) | ||
|
||
TEMPLATE_QUERY_PARAMS_DICT = { | ||
"aid": 1988, | ||
"app_name": "tiktok_web", | ||
"browser_language": "en-US", # TODO - Set dynamically? | ||
"browser_platform": "Win32", # TODO - Set dynamically? | ||
"count": 20, | ||
"device_id": "", | ||
"device_platform": "web_pc", # TODO - Set dynamically? | ||
"os": "windows", # TODO - Set dynamically? | ||
"priority_region": "", | ||
"referrer": "", | ||
"region": "US", # TODO - Set dynamically? | ||
"screen_height": 0, | ||
"screen_width": 0, | ||
} | ||
|
||
|
||
ENDPOINT_ID_MAP = { | ||
"comment": "aweme_id", # comment/list/ | ||
"post": "secUid", # post/item_list/ | ||
"challenge": "challengeID", # challenge/item_list/ | ||
"related": "itemID", # related/item_list | ||
} | ||
|
||
|
||
async def get_necessary_query_params_async(context: AsyncContext) -> str: | ||
""" | ||
As of June 14, 2023, the following parameters are necessary to make comment API requests and don't seem to affect | ||
other API requests: | ||
* ``aid``=1988 | ||
* ``app_name``=tiktok_web | ||
* ``browser_language``=en-US | ||
* ``browser_name``=Mozilla | ||
* ``browser_platform``=Win32 | ||
* ``browser_version``=Rest of UserAgent | ||
* ``count``=20 | ||
* ``device_id`` (empty, but needed) | ||
* ``device_platform``=web_pc | ||
* ``os``=windows | ||
* ``priority_region`` (empty, but needed) | ||
* ``referer`` (empty, but needed) | ||
* ``region``=US | ||
* ``screen_height`` (can be 0) | ||
* ``screen_width`` (can be 0) | ||
Unique to Comments: | ||
* ``aweme_id``=7244619447191735595 | ||
* Video ID | ||
* ``cursor``=0 | ||
* Index into list of comments | ||
Unique to Related Videos: | ||
* ``itemID``=7244619447191735595 | ||
* Video ID | ||
* ``cursor``=0 | ||
* Index into list of related videos | ||
Unique to User Posts: | ||
* ``secUid``=MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM | ||
* User ID | ||
* ``cursor`` is a Unix Timestamp. The retrieved videos are the newest ``count`` since before said timestamp | ||
* Next ``cursor`` is provided in response | ||
* Requires msToken cookie(s) | ||
Unique to Challenges: | ||
* ``challengeID``=7882 | ||
* Challenge ID | ||
* ``cursor``=0 | ||
* Index into list of posts (sorted by popularity) | ||
:param context: Playwright Context retrieved from :class:`.AsyncTikTokAPI` with ``api.context`` | ||
:return: a paramstring containing query parameters necessary for all API calls | ||
""" | ||
page = await context.new_page() | ||
agent: str = await page.evaluate("navigator.userAgent") | ||
await page.close() | ||
browser_name, browser_version = agent.split("/", 1) | ||
query = dict( | ||
**TEMPLATE_QUERY_PARAMS_DICT, | ||
browser_name=browser_name, | ||
browser_version=browser_version, | ||
) | ||
return urlencode(query) | ||
|
||
|
||
def get_necessary_query_params_sync(context: SyncContext) -> str: | ||
""" | ||
As of June 14, 2023, the following parameters are necessary to make comment API requests and don't seem to affect | ||
other API requests: | ||
* ``aid``=1988 | ||
* ``app_name``=tiktok_web | ||
* ``browser_language``=en-US | ||
* ``browser_name``=Mozilla | ||
* ``browser_platform``=Win32 | ||
* ``browser_version``=Rest of UserAgent | ||
* ``count``=20 | ||
* ``device_id`` (empty, but needed) | ||
* ``device_platform``=web_pc | ||
* ``os``=windows | ||
* ``priority_region`` (empty, but needed) | ||
* ``referer`` (empty, but needed) | ||
* ``region``=US | ||
* ``screen_height`` (can be 0) | ||
* ``screen_width`` (can be 0) | ||
Unique to Comments: | ||
* ``aweme_id``=7244619447191735595 | ||
* Video ID | ||
* ``cursor``=0 | ||
* Index into list of comments | ||
Unique to Related Videos: | ||
* ``itemID``=7244619447191735595 | ||
* Video ID | ||
* ``cursor``=0 | ||
* Index into list of related videos | ||
Unique to User Posts: | ||
* ``secUid``=MS4wLjABAAAAv7iSuuXDJGDvJkmH_vz1qkDZYo1apxgzaxdBSeIuPiM | ||
* User ID | ||
* ``cursor`` is a Unix Timestamp. The retrieved videos are the newest ``count`` since before said timestamp | ||
* Next ``cursor`` is provided in response | ||
* Requires msToken cookie(s) | ||
Unique to Challenges: | ||
* ``challengeID``=7882 | ||
* Challenge ID | ||
* ``cursor``=0 | ||
* Index into list of posts (sorted by popularity) | ||
:param context: Playwright Context retrieved from :class:`.AsyncTikTokAPI` with ``api.context`` | ||
:return: a paramstring containing query parameters necessary for all API calls | ||
""" | ||
page = context.new_page() | ||
agent: str = page.evaluate("navigator.userAgent") | ||
page.close() | ||
browser_name, browser_version = agent.split("/", 1) | ||
query = dict( | ||
**TEMPLATE_QUERY_PARAMS_DICT, | ||
browser_name=browser_name, | ||
browser_version=browser_version, | ||
) | ||
return urlencode(query, quote_via=quote) | ||
|
||
|
||
def get_id_type(endpoint: str) -> str: | ||
for k, v in ENDPOINT_ID_MAP.items(): | ||
if k in endpoint: | ||
return v | ||
raise TikTokAPIError(f"Unsupported endpoint: {endpoint}") | ||
|
||
|
||
async def make_request_async( | ||
endpoint: str, cursor: int, target_id: int, context: AsyncContext | ||
) -> dict: | ||
params = await get_necessary_query_params_async(context) | ||
id_type = get_id_type(endpoint) | ||
params += f"&cursor={cursor}&{id_type}={target_id}" | ||
return await sign_and_get_request_async( | ||
f"https://www.tiktok.com/api/{endpoint}?{params}", context | ||
) | ||
|
||
|
||
def make_request_sync( | ||
endpoint: str, cursor: int, target_id: int, context: SyncContext | ||
) -> dict: | ||
params = get_necessary_query_params_sync(context) | ||
id_type = get_id_type(endpoint) | ||
params += f"&cursor={cursor}&{id_type}={target_id}" | ||
return sign_and_get_request_sync( | ||
f"https://www.tiktok.com/api/{endpoint}?{params}", context | ||
) | ||
|
||
|
||
__all__ = [ | ||
"get_necessary_query_params_async", | ||
"get_necessary_query_params_sync", | ||
"make_request_async", | ||
"make_request_sync", | ||
] |
Oops, something went wrong.