ResearchTikPy is a Python library designed to facilitate access to TikTok's Research API, providing a simple and intuitive interface for collecting data on videos, users, comments, and more. This library is intended for academic and research purposes, aiming to streamline the data collection process from TikTok without directly interfering with the API.
Features of ResearchTikPy:
| Includes | Does Not Yet Include (Working on it =) ) |
|---|---|
| Fetch video infos by key term(s) | Downloading videos |
| Fetch user infos | Extracting text from videos (OCR) |
| Search for videos by user(s) | Downloading sounds of videos |
| Collect comments from video(s) | |
| Fetch the followers of account(s) | |
| Fetch account(s) followed by a user | |
| Fetch videos liked by a user | |
| Fetch videos pinned by a user |
- This package is in active development! Please report bugs & errors, and feel free to suggest additional functions!
- Read TikTok's guide about the research API to inform you about restrictions, daily quotas and FAQs.
- Splitting your requests into smaller chunks is generally advised to avoid longer fetching times and data loss.
- If you still have problems getting access to the Research TikTok API because TikTok is ghosting you or does not accept your application, raise your voice by reporting your case to this survey by the #DSA40 Data Access Collaboratory
Currently, the most efficient method is to install the package via pip.
# Install
pip install researchtikpy
# Import
import researchtikpy as rtk
# Or import individual modules: F.e.
from researchtikpy import get_acces_token() # This way you could leave out the `rtk.` at the beginning of every researchtikpy function.Before using ResearchTikPy, you must obtain access credentials (client key and secret) from TikTok's developer platform. Navigate to manage apps on TikToks developer webpage to find your client_key and client_secret
Once you have your credentials, you can use the library to generate an access token that you need to reference every time you run a command in this library:
# It is advised to store your tokens in separate objects or save them in your system's environment to avoid accidental publication of the credentials.
client_key = 'your_client_key'
client_secret = 'your_client_secret'
access_token = rtk.get_access_token(client_key, client_secret)
# OR paste the credentials within the command
access_token = rtk.get_access_token('your_client_key', 'your_client_secret')
# print(access_token) # Testing, if necessary. It should look something like this:
#Access Token: clt.Vl7HEasdfdeX28Z0G4wervRoPpY5f3zAGgYmGAAyGkowkYCusgbwqmb4NtNzn2QstXh
#Expires In: 7200
#Token Type: Bearer
This package features every possible query currently provided by the Researcher API of TikTok. For the full documentation, including a list of variables, see the official Codebook.
Fetches video information by hashtag.
videos_df = rtk.get_videos_hashtag(hashtags, access_token, start_date, end_date, total_max_count (optional),
region_code (optional), music_id (optional), effect_id (optional), max_count (optional), rate_limit_pause (optional))Example call
access_token = "clt.rasddUatUsHasdnHYV2zGw7aQasdxpYpxNz3zjaMfBksdfxXA7" # Dont share you access_token!
hashtags = ["fyp", "FYP"]
start_date = "20230101"
end_date = "20240131"
videos_df = rtk.get_videos_hashtag(hashtags, access_token, start_date, end_date, total_max_count = 500)Parameters:
- hashtags: A list of hashtag(s) to search for, e.g., "FYP" or ["FYP", "FORYOURPAGE"].
- access_token: Your valid access token for the TikTok Research API. Stored as a string.
- start_date: The start date for the search. The format should be 'YYYYMMDD'.
- end_date: The end date for the search. The format should be 'YYYYMMDD'.
- total_max_count (Optional): The total maximum number of videos to collect. Keeping this within a manageable range is advised because of the fetching duration and daily quota limit! The default is infinite. Stored as an integer, e.g., 500.
- region_code (Optional): The region code to filter videos by. See list of region_codes.
- music_id (Optional): The music ID to filter videos by. Stored as a string.
- effect_id (Optional): The effect ID to filter videos by. Stored as a string.
- max_count (Optional): The maximum number of videos to return per individual get request (default & max is 100).
- rate_limit_pause (Optional): Time in seconds to wait when a rate limit error is encountered. The default is 60 seconds. It can be adjusted as you like, e.g., 30.
Fetches account information for given usernames within the specified date range and compiles them into a single data frame.
user_df = rtk.get_users_info(usernames, access_token, start_date, end_date)Parameters:
- usernames: List of username(s) to fetch videos for.
- access_token: Authorization token for TikTok Research API.
- max_count (Optional): Maximum number of videos to return per request (default is 100).
- verbose (Optional): If True (default), prints detailed logs; if False, suppresses most print statements.
Fetches all videos & video metadata of an account or accounts and compiles them into a single data frame (with account IDs).
videos_df = rtk.get_videos_info(usernames, access_token, start_date(optional), end_date(optional), fields (optional), max_count(optional))Parameters:
- usernames: List of usernames to fetch videos for.
- access_token: Authorization token for TikTok Research API.
- start_date: The start date for the video search (format YYYYMMDD).
- end_date: End date for the video search (format YYYYMMDD).
- max_count (Optional): Maximum number of videos to return per request (default is 100).
- verbose (Optional): If True (default), prints detailed logs; if False, suppresses most print statements.
Fetches comments on video(s) and compiles them into a single data frame (with video IDs).
comments_df = rtk.get_video_comments(videos_df, access_token, fields (optional), max_count (optional), verbose (optional))Parameters:
- videos_df: DataFrame with a column 'id' containing video IDs (f.e. provided by
get_videos_info). - access_token: Authorization token for TikTok Research API.
- fields (optional)
- max_count (optional)
- verbose (optional)
Fetches pinned videos of accounts and compiles them into a single DataFrame.
pinned_df = rtk.get_pinned_videos(usernames, access_token, fields (optional), max_count (optional), verbose (optional))- usernames: List of usernames to fetch videos for. Reports no pinned videos if the account has none.
- access_token: Authorization token for TikTok Research API.
- fields (optional)
- verbose (optional)
Fetches metadata of videos accounts have like. Only works if accounts enable this feature. If an account has not enabled this, the section on his profil pages is keyed out and a lock symbol is placed there.
liked_df = rtk.get_liked_videos(usernames, access_token, fields (optional), max_count (optional), verbose (optional))Parameters:
- usernames: List of usernames to fetch videos for. Reports no liked videos if account has none.
- access_token: Authorization token for TikTok Research API.
- fields (optional)
- max_count (optional)
- verbose (optional)
Fetches followers of accounts and compiles them into a single data frame. It is advised to keep the list of usernames short to avoid longer runtimes and account for a large number of possible followers!
Compiles them into a single data frame with the variable target_account indicating the seed account.
following = rtk.get_following (usernames, access_token, fields (optional), max_count (optional), verbose (optional))Parameters:
- usernames: List of usernames to fetch videos for. Reports no pinned videos if account has none.
- access_token: Authorization token for TikTok Research API.
- fields (optional)
- max_count (optional)
- verbose (optional)
Fetches followers for multiple users and compiles them into a single data frame. It is advised to keep the list of
usernames short to avoid longer runtimes OR to use the total_count parameter to avoid reaching daily quotas rather quickly.
followers = rtk.get_followers (usernames, access_token, total_count (optional) fields (optional), max_count (optional), verbose (optional))Parameters:
- usernames: List of usernames to fetch videos for. Reports no pinned videos if account has none.
- access_token: Authorization token for TikTok Research API.
- total_count (optional): Maximum total number of followers to retrieve per user (integer input).
- fields (optional)
- max_count (optional)
- verbose (optional)
Please feel free to cite me when using the package:
Hohner, J. (2024). ResearchPikTy (Python Library). GitHub Repository: https://github.com/HohnerJulian/ResearchTikPy doi:10.13140/RG.2.2.24209.03682
or Bibtex:
@misc{Hohner2024ResearchTikPy, author = {Hohner, Julian}, title = {{ResearchTikPy: Python Library for TikTok's Research API}}, year = {2024}, howpublished = {\url{https://github.com/HohnerJulian/ResearchTikPy}}, note = {Accessed: yyyy-mm-dd}, doi = {10.13140/RG.2.2.24209.03682} }