Unofficial API for Threads by Instagram. With type hints.
To install the library on Linux:
python3 -m pip install threads-py-wrapper
To install the library on Windows:
py -m pip install threads-py-wrapper
Python 3.8 or higher is needed for the library
This library will be under active development so please raise the issue with your concerns and errors.
login(self) -> bool
get_user_id(self, username: str, instagram: bool = False) -> int
get_user_profile(self, user_id: int) -> ThreadsUser
search_user(self, query: str) -> SearchUsersResponse
get_thread(self, user_id: int) -> ThreadResponse
get_user_threads(self, user_id: int) -> List[Thread]
get_user_followers(self, user_id: int) -> UserFollowersResponse
get_user_following(self, user_id: int) -> UserFollowingResponse
get_friendship_status(self, user_id: int) -> FriendshipStatusResponse
follow_user(self, user_id: int) -> FriendshipStatusResponse
unfollow_user(self, user_id: int) -> FriendshipStatusResponse
mute_user(self, user_id: int) -> FriendshipStatusResponse
unmute_user(self, user_id: int) -> FriendshipStatusResponse
restrict_user(self, user_id: int) -> RestrictResponse
unrestrict_user(self, user_id: int) -> RestrictResponse
block_user(self, user_id: int) -> FriendshipStatusResponse
unblock_user(self, user_id: int) -> FriendshipStatusResponse
like(self, thread_id: int) -> bool
unlike(self, thread_id: int) -> bool
repost(self, thread_id: int) -> RepostData
unrepost(self, original_thread_id: int) -> bool
delete(self, thread_id: int) -> bool
create(self, text: str, url: str = None, image: Optional[Union[str, List]] = None, reply_to: int = None) -> dict
get_user_threads() -> List[Thread]
get_user_followers() -> UserFollowersResponse
get_user_following() -> UserFollowingResponse
get_friendship_status() -> FriendshipStatusResponse
follow_user() -> FriendshipStatusResponse
unfollow_user() -> FriendshipStatusResponse
mute_user() -> FriendshipStatusResponse
unmute_user() -> FriendshipStatusResponse
restrict_user() -> RestrictResponse
unrestrict_user() -> RestrictResponse
block_user() -> FriendshipStatusResponse
unblock_user() -> FriendshipStatusResponse
like
boolTrue if the liking is successful, False otherwise.unlike
boolTrue if the unliking is successful, False otherwise.repost
RepostDataunrepost
boolTrue if the un-reposting is successful, False otherwise.delete
boolTrue if the deletion is successful, False otherwise.It is very easy to work with this library everything is type hinted and the names are straight forward, also go through the above Customized Types section to use this library efficiently. Here is a small example.
import threadspy
import os
USERNAME = os.environ.get("USERNAME")
PASSWORD = os.environ.get("PASSWORD")
threads_api = threadspy.ThreadsApi(USERNAME, PASSWORD)
login_status = threads_api.login()
if login_status:
user_id = threads_api.get_user_id('zuck') # Get the user id of zuck
zuck = threads_api.get_user_profile(user_id) # Get the user profile of zuck
zuck.follow_user() # Follow zuck (Customized type)
zuck_threads = zuck.get_user_threads() # Get the threads of zuck
for thread in zuck_threads[:3]: # Like the first 3 threads of zuck
thread.like()
print(f"Liked thread with ID: {thread.id} and Caption: {thread.posts[0].caption.text}" )
else:
print("Login failed")
⚠️ Be cautious and try the library with your Alt Account. There is always risk of getting banned.
threads_api = threadspy.ThreadsApi(USERNAME, PASSWORD, settings_file="/path/to/settings", token_path="/path/to/token")
Its a good idea to provide these paths, but if not provided then the settings.json and threads_token.bin will be store in the directory from where the code is run.
FAQs
Unofficial API for Threads by Instagram. With type hints.
We found that threads-py-wrapper demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.
Security News
Research
Attackers are impersonating Sindre Sorhus on npm with a fake 'chalk-node' package containing a malicious backdoor to compromise developers' projects.
Security News
The npm package for the LottieFiles Player web component was hit with a supply chain attack after a software engineer's npmjs credentials were compromised.