Modules¶
ACM¶
-
class
amino.acm.
ACM
(profile: amino.lib.util.objects.UserProfile, comId: str = None)¶ Bases:
amino.client.Client
-
accept_join_request
(userId: str)¶
-
add_influencer
(userId: str, monthlyFee: int)¶
-
change_guidelines
(message: str)¶
-
change_module
(module: str, isEnabled: bool)¶
-
change_sidepanel_color
(color: str)¶
-
change_welcome_message
(message: str, isEnabled: bool = True)¶
-
create_community
(name: str, tagline: str, icon: BinaryIO, themeColor: str, joinType: int = 0, primaryLanguage: str = 'en')¶
-
delete_community
(email: str, password: str, verificationCode: str)¶
-
delete_pending_role
(noticeId: str)¶
-
edit_community
(name: str = None, description: str = None, aminoId: str = None, primaryLanguage: str = None, themePackUrl: str = None)¶
-
get_categories
(start: int = 0, size: int = 25)¶
-
get_community_stats
()¶
-
get_community_user_stats
(type: str, start: int = 0, size: int = 25)¶
-
get_join_requests
(start: int = 0, size: int = 25)¶
-
get_notice_list
(start: int = 0, size: int = 25)¶
-
list_communities
(start: int = 0, size: int = 25)¶
-
parse_headers
(data=None)¶
-
promote
(userId: str, rank: str)¶
-
reject_join_request
(userId: str)¶
-
remove_influencer
(userId: str)¶
-
upload_themepack_raw
(file: BinaryIO)¶
-
Client¶
-
class
amino.client.
Client
(deviceId: str = None, socketDebugging=False)¶ Bases:
amino.socket.Callbacks
,amino.socket.SocketHandler
-
accept_host
(chatId: str, requestId: str)¶
-
accept_organizer
(chatId: str, requestId: str)¶
-
activate_account
(email: str, code: str)¶ Activate an account.
- Parameters
- email : Email of the account.
- code : Verification code.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
add_linked_community
(comId: str)¶ Add a Linked Community on your profile.
- Parameters
- comId : ID of the Community.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
block
(userId: str)¶ Block an User.
- Parameters
- userId : ID of the User.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
change_password
(email: str, password: str, code: str)¶ Change password of an account.
- Parameters
- email : Email of the account.
- password : Password of the account.
- code : Verification code.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
check_device
(deviceId: str)¶ Check if the Device ID is valid.
- Parameters
- deviceId : ID of the Device.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
claim_new_user_coupon
()¶ Claim the New User Coupon available when a new account is created.
- Parameters
- No parameters required.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
comment
(message: str, userId: str = None, blogId: str = None, wikiId: str = None, replyTo: str = None)¶ Comment on a User’s Wall, Blog or Wiki.
- Parameters
- message : Message to be sent.
- userId : ID of the User. (for Walls)
- blogId : ID of the Blog. (for Blogs)
- wikiId : ID of the Wiki. (for Wikis)
- replyTo : ID of the Comment to Reply to.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
configure
(age: int, gender: str)¶ Configure the settings of an account.
- Parameters
- age : Age of the account. Minimum is 13.
- gender : Gender of the account.
Male
,Female
orNon-Binary
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
delete_account
(password: str)¶ Delete an account.
- Parameters
- password : Password of the account.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
delete_comment
(commentId: str, userId: str = None, blogId: str = None, wikiId: str = None)¶ Delete a Comment on a User’s Wall, Blog or Wiki.
- Parameters
- commentId : ID of the Comment.
- userId : ID of the User. (for Walls)
- blogId : ID of the Blog. (for Blogs)
- wikiId : ID of the Wiki. (for Wikis)
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
delete_message
(chatId: str, messageId: str, asStaff: bool = False, reason: str = None)¶ Delete a Message from a Chat.
- Parameters
- messageId : ID of the Message.
- chatId : ID of the Chat.
- asStaff : If execute as a Staff member (Leader or Curator).
- reason : Reason of the action to show on the Moderation History.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
edit_chat
(chatId: str, doNotDisturb: bool = None, pinChat: bool = None, title: str = None, icon: str = None, backgroundImage: BinaryIO = None, content: str = None, announcement: str = None, coHosts: list = None, keywords: list = None, pinAnnouncement: bool = None, publishToGlobal: bool = None, canTip: bool = None, viewOnly: bool = None, canInvite: bool = None, fansOnly: bool = None)¶ Send a Message to a Chat.
- Parameters
- chatId : ID of the Chat.
- title : Title of the Chat.
- content : Content of the Chat.
- icon : Icon of the Chat.
- backgroundImage : Background Image of the Chat.
- announcement : Announcement of the Chat.
- pinAnnouncement : If the Chat Announcement should Pinned or not.
- coHosts : List of User IDS to be Co-Host.
- keywords : List of Keywords of the Chat.
- viewOnly : If the Chat should be on View Only or not.
- canTip : If the Chat should be Tippable or not.
- canInvite : If the Chat should be Invitable or not.
- fansOnly : If the Chat should be Fans Only or not.
- publishToGlobal : If the Chat should show on Public Chats or not.
- doNotDisturb : If the Chat should Do Not Disturb or not.
- pinChat : If the Chat should Pinned or not.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
edit_profile
(nickname: str = None, content: str = None, icon: BinaryIO = None, backgroundColor: str = None, backgroundImage: str = None, defaultBubbleId: str = None)¶ Edit account’s Profile.
- Parameters
- nickname : Nickname of the Profile.
- content : Biography of the Profile.
- icon : Icon of the Profile.
- backgroundImage : Url of the Background Picture of the Profile.
- backgroundColor : Hexadecimal Background Color of the Profile.
- defaultBubbleId : Chat bubble ID.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
end_vc
(comId: str, chatId: str, joinType: int = 2)¶
-
flag
(reason: str, flagType: int, userId: str = None, blogId: str = None, wikiId: str = None, asGuest: bool = False)¶ Flag a User, Blog or Wiki.
- Parameters
- reason : Reason of the Flag.
- flagType : Type of the Flag.
- userId : ID of the User.
- blogId : ID of the Blog.
- wikiId : ID of the Wiki.
- asGuest : Execute as a Guest.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
flag_community
(comId: str, reason: str, flagType: int, isGuest: bool = False)¶ Flag a Community.
- Parameters
- comId : ID of the Community.
- reason : Reason of the Flag.
- flagType : Type of Flag.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
follow
(userId: Union[str, list])¶ Follow an User or Multiple Users.
- Parameters
- userId : ID of the User or List of IDs of the Users.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
get_account_info
()¶
-
get_all_users
(start: int = 0, size: int = 25)¶ Get list of users of Amino.
- Parameters
- start : Where to start the list.
- size : Size of the list.
- Returns
- Success :
User Profile Count List Object
- Fail :
Exceptions
- Success :
-
get_avatar_frames
(start: int = 0, size: int = 25)¶
-
get_blocked_users
(start: int = 0, size: int = 25)¶ List of Users that the User Blocked.
- Parameters
- start : Where to start the list.
- size : Size of the list.
- Returns
- Success :
Users List
- Fail :
Exceptions
- Success :
-
get_blocker_users
(start: int = 0, size: int = 25)¶ List of Users that are Blocking the User.
- Parameters
- start : Where to start the list.
- size : Size of the list.
- Returns
- Success :
List of User IDs
- Fail :
Exceptions
- Success :
-
get_blog_comments
(blogId: str = None, wikiId: str = None, quizId: str = None, fileId: str = None, sorting: str = 'newest', start: int = 0, size: int = 25)¶
-
get_blog_info
(blogId: str = None, wikiId: str = None, quizId: str = None, fileId: str = None)¶
-
get_chat_messages
(chatId: str, size: int = 25, pageToken: str = None)¶ List of Messages from an Chat.
- Parameters
- chatId : ID of the Chat.
- size : Size of the list.
- size : Size of the list.
- pageToken : Next Page Token.
- Returns
- Success :
Message List
- Fail :
Exceptions
- Success :
-
get_chat_thread
(chatId: str)¶ Get the Chat Object from an Chat ID.
- Parameters
- chatId : ID of the Chat.
- Returns
- Success :
Chat Object
- Fail :
Exceptions
- Success :
-
get_chat_threads
(start: int = 0, size: int = 25)¶ List of Chats the account is in.
- Parameters
- start : Where to start the list.
- size : Size of the list.
- Returns
- Success :
Chat List
- Fail :
Exceptions
- Success :
-
get_chat_users
(chatId: str, start: int = 0, size: int = 25)¶
-
get_community_info
(comId: str)¶ Information of an Community.
- Parameters
- comId : ID of the Community.
- Returns
- Success :
Community Object
- Fail :
Exceptions
- Success :
-
get_eventlog
(language: str = 'en')¶
-
get_from_code
(code: str)¶ Get the Object Information from the Amino URL Code.
- Parameters
- code : Code from the Amino URL.
- Returns
- Success :
From Code Object
- Fail :
Exceptions
- Success :
-
get_from_deviceid
(deviceId: str)¶ Get the User ID from an Device ID.
- Parameters
- deviceID : ID of the Device.
- Returns
- Success :
User ID
- Fail :
Exceptions
- Success :
-
get_from_id
(objectId: str, objectType: int, comId: str = None)¶ Get the Object Information from the Object ID and Type.
- Parameters
- objectID : ID of the Object. User ID, Blog ID, etc.
- objectType : Type of the Object.
- comId : ID of the Community. Use if the Object is in a Community.
- Returns
- Success :
From Code Object
- Fail :
Exceptions
- Success :
-
get_linked_communities
(userId: str)¶ Get a List of Linked Communities of an User.
- Parameters
- userId : ID of the User.
- Returns
- Success :
Community List
- Fail :
Exceptions
- Success :
-
get_membership_info
()¶ Get Information about your Amino+ Membership.
- Parameters
- No parameters required.
- Returns
- Success :
Membership Object
- Fail :
Exceptions
- Success :
-
get_message_info
(chatId: str, messageId: str)¶ Information of an Message from an Chat.
- Parameters
- chatId : ID of the Chat.
- messageId : ID of the Message.
- Returns
- Success :
Message Object
- Fail :
Exceptions
- Success :
-
get_subscriptions
(start: int = 0, size: int = 25)¶ Get Information about the account’s Subscriptions.
- Parameters
- start : Where to start the list.
- size : Size of the list.
- Returns
- Success :
List
- Fail :
Exceptions
- Success :
-
get_supported_languages
()¶ Get the List of Supported Languages by Amino.
- Parameters
- No parameters required.
- Returns
- Success :
List of Supported Languages
- Fail :
Exceptions
- Success :
-
get_ta_announcements
(language: str = 'en', start: int = 0, size: int = 25)¶ Get the list of Team Amino’s Announcement Blogs.
- Parameters
- language : Language of the Blogs.
en
,es
,pt
,ar
,ru
,fr
,de
- start : Where to start the list.
- size : Size of the list.
- Returns
- Success :
Blogs List
- Fail :
Exceptions
- Success :
-
get_unlinked_communities
(userId: str)¶ Get a List of Unlinked Communities of an User.
- Parameters
- userId : ID of the User.
- Returns
- Success :
Community List
- Fail :
Exceptions
- Success :
-
get_user_followers
(userId: str, start: int = 0, size: int = 25)¶ List of Users that are Following the User.
- Parameters
- userId : ID of the User.
- start : Where to start the list.
- size : Size of the list.
- Returns
- Success :
User List
- Fail :
Exceptions
- Success :
-
get_user_following
(userId: str, start: int = 0, size: int = 25)¶ List of Users that the User is Following.
- Parameters
- userId : ID of the User.
- start : Where to start the list.
- size : Size of the list.
- Returns
- Success :
User List
- Fail :
Exceptions
- Success :
-
get_user_info
(userId: str)¶ Information of an User.
- Parameters
- userId : ID of the User.
- Returns
- Success :
User Object
- Fail :
Exceptions
- Success :
-
get_user_visitors
(userId: str, start: int = 0, size: int = 25)¶ List of Users that Visited the User.
- Parameters
- userId : ID of the User.
- start : Where to start the list.
- size : Size of the list.
- Returns
- Success :
Visitors List
- Fail :
Exceptions
- Success :
-
get_wall_comments
(userId: str, sorting: str, start: int = 0, size: int = 25)¶ List of Wall Comments of an User.
- Parameters
- userId : ID of the User.
- sorting : Order of the Comments.
newest
,oldest
,top
- start : Where to start the list.
- size : Size of the list.
- Returns
- Success :
Comments List
- Fail :
Exceptions
- Success :
-
get_wallet_history
(start: int = 0, size: int = 25)¶ Get the Wallet’s History Information.
- Parameters
- start : Where to start the list.
- size : Size of the list.
- Returns
- Success :
Wallet Object
- Fail :
Exceptions
- Success :
-
get_wallet_info
()¶ Get Information about the account’s Wallet.
- Parameters
- No parameters required.
- Returns
- Success :
Wallet Object
- Fail :
Exceptions
- Success :
-
handle_socket_message
(data)¶
-
invite_to_chat
(userId: Union[str, list], chatId: str)¶ Invite a User or List of Users to a Chat.
- Parameters
- userId : ID of the User or List of User IDs.
- chatId : ID of the Chat.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
invite_to_vc
(chatId: str, userId: str)¶ Invite a User to a Voice Chat
- Parameters
- chatId - ID of the Chat
- userId - ID of the User
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
join_chat
(chatId: str)¶ Join an Chat.
- Parameters
- chatId : ID of the Chat.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
join_community
(comId: str, invitationCode: str = None)¶ Join a Community.
- Parameters
- comId : ID of the Community.
- invitationCode : Invitation Code.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
join_video_chat
(comId: str, chatId: str, joinType: int = 1)¶ Joins a Video Chat
- Parameters
- comId : ID of the Community
- chatId : ID of the Chat
-
join_video_chat_as_viewer
(comId: str, chatId: str)¶
-
join_voice_chat
(comId: str, chatId: str, joinType: int = 1)¶ Joins a Voice Chat
- Parameters
- comId : ID of the Community
- chatId : ID of the Chat
-
kick
(userId: str, chatId: str, allowRejoin: bool = True)¶
-
leave_chat
(chatId: str)¶ Leave an Chat.
- Parameters
- chatId : ID of the Chat.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
leave_community
(comId: str)¶ Leave a Community.
- Parameters
- comId : ID of the Community.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
like_blog
(blogId: Union[str, list] = None, wikiId: str = None)¶ Like a Blog, Multiple Blogs or a Wiki.
- Parameters
- blogId : ID of the Blog or List of IDs of the Blogs. (for Blogs)
- wikiId : ID of the Wiki. (for Wikis)
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
like_comment
(commentId: str, userId: str = None, blogId: str = None, wikiId: str = None)¶ Like a Comment on a User’s Wall, Blog or Wiki.
- Parameters
- commentId : ID of the Comment.
- userId : ID of the User. (for Walls)
- blogId : ID of the Blog. (for Blogs)
- wikiId : ID of the Wiki. (for Wikis)
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
link_identify
(code: str)¶
-
login
(email: str, password: str)¶ Login into an account.
- Parameters
- email : Email of the account.
- password : Password of the account.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
login_sid
(SID: str)¶ Login into an account with an SID
- Parameters
- SID : SID of the account
-
logout
()¶ Logout from an account.
- Parameters
- No parameters required.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
mark_as_read
(chatId: str, messageId: str)¶ Mark a Message from a Chat as Read.
- Parameters
- messageId : ID of the Message.
- chatId : ID of the Chat.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
parse_headers
(data=None)¶
-
register
(nickname: str, email: str, password: str, verificationCode: str, deviceId: str = '01B592EF5658F82E1339B39AA893FF661D7E8B8F1D16227E396EF4B1BF60F33D25566A35AB1514DAB5')¶ Register an account.
- Parameters
- nickname : Nickname of the account.
- email : Email of the account.
- password : Password of the account.
- verificationCode : Verification code.
- deviceId : The device id being registered to.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
remove_linked_community
(comId: str)¶ Remove a Linked Community on your profile.
- Parameters
- comId : ID of the Community.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
reorder_linked_communities
(comIds: list)¶ Reorder List of Linked Communities.
- Parameters
- comIds : IDS of the Communities.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
request_join_community
(comId: str, message: str = None)¶ Request to join a Community.
- Parameters
- comId : ID of the Community.
- message : Message to be sent.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
request_verify_code
(email: str, resetPassword: bool = False)¶ Request an verification code to the targeted email.
- Parameters
- email : Email of the account.
- resetPassword : If the code should be for Password Reset.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
restore
(email: str, password: str)¶ Restore a deleted account.
- Parameters
- email : Email of the account.
- password : Password of the account.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
run_vc
(comId: str, chatId: str, joinType: str)¶
-
search_community
(aminoId: str)¶ Search a Community byt its Amino ID.
- Parameters
- aminoId : Amino ID of the Community.
- Returns
- Success :
Community List
- Fail :
Exceptions
- Success :
-
send_coins
(coins: int, blogId: str = None, chatId: str = None, objectId: str = None, transactionId: str = None)¶
-
send_message
(chatId: str, message: str = None, messageType: int = 0, file: BinaryIO = None, fileType: str = None, replyTo: str = None, mentionUserIds: list = None, stickerId: str = None, embedId: str = None, embedType: int = None, embedLink: str = None, embedTitle: str = None, embedContent: str = None, embedImage: BinaryIO = None)¶ Send a Message to a Chat.
- Parameters
- message : Message to be sent
- chatId : ID of the Chat.
- file : File to be sent.
- fileType : Type of the file.
audio
,image
,gif
- messageType : Type of the Message.
- mentionUserIds : List of User IDS to mention. ‘@’ needed in the Message.
- replyTo : Message ID to reply to.
- stickerId : Sticker ID to be sent.
- embedTitle : Title of the Embed.
- embedContent : Content of the Embed.
- embedLink : Link of the Embed.
- embedImage : Image of the Embed.
- embedId : ID of the Embed.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
set_amino_id
(aminoId: str)¶ Edit account’s Amino ID.
- Parameters
- aminoId : Amino ID of the Account.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
set_privacy_status
(isAnonymous: bool = False, getNotifications: bool = False)¶ Edit account’s Privacy Status.
- Parameters
- isAnonymous : If visibility should be Anonymous or not.
- getNotifications : If account should get new Visitors Notifications.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
start_chat
(userId: Union[str, list], message: str, title: str = None, content: str = None, isGlobal: bool = False, publishToGlobal: bool = False)¶ Start an Chat with an User or List of Users.
- Parameters
- userId : ID of the User or List of User IDs.
- message : Starting Message.
- title : Title of Group Chat.
- content : Content of Group Chat.
- isGlobal : If Group Chat is Global.
- publishToGlobal : If Group Chat should show in Global.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
start_vc
(comId: str, chatId: str, joinType: int = 1)¶
-
sub_clients
(start: int = 0, size: int = 25)¶ List of Communities the account is in.
- Parameters
- start : Where to start the list.
- size : Size of the list.
- Returns
- Success :
Community List
- Fail :
Exceptions
- Success :
-
sub_clients_profile
(start: int = 0, size: int = 25)¶
-
subscribe_amino_plus
(transactionId='', sku='d940cf4a-6cf2-4737-9f3d-655234a92ea5')¶ Subscibes to amino+
- Parameters
- transactionId - The transaction Id as a uuid4
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
unblock
(userId: str)¶ Unblock an User.
- Parameters
- userId : ID of the User.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
unfollow
(userId: str)¶ Unfollow an User.
- Parameters
- userId : ID of the User.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
unlike_blog
(blogId: str = None, wikiId: str = None)¶ Remove a like from a Blog or Wiki.
- Parameters
- blogId : ID of the Blog. (for Blogs)
- wikiId : ID of the Wiki. (for Wikis)
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
unlike_comment
(commentId: str, userId: str = None, blogId: str = None, wikiId: str = None)¶ Remove a like from a Comment on a User’s Wall, Blog or Wiki.
- Parameters
- commentId : ID of the Comment.
- userId : ID of the User. (for Walls)
- blogId : ID of the Blog. (for Blogs)
- wikiId : ID of the Wiki. (for Wikis)
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
upload_media
(file: BinaryIO, fileType: str)¶ Upload file to the amino servers.
- Parameters
- file : File to be uploaded.
- Returns
- Success : Url of the file uploaded to the server.
- Fail :
Exceptions
-
verify
(email: str, code: str)¶ Verify an account.
- Parameters
- email : Email of the account.
- code : Verification code.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
visit
(userId: str)¶ Visit an User.
- Parameters
- userId : ID of the User.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
wallet_config
(level: int)¶ Changes ads config
- Parameters
- level - Level of the ads.
1
,2
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
SubClient¶
-
class
amino.sub_client.
SubClient
(comId: str = None, aminoId: str = None, *, profile: amino.lib.util.objects.UserProfile)¶ Bases:
amino.client.Client
-
accept_host
(chatId: str, requestId: str)¶
-
accept_organizer
(chatId: str, requestId: str)¶
-
accept_wiki_request
(requestId: str, destinationCategoryIdList: list)¶
-
activate_bubble
(bubbleId: str)¶
-
activity_status
(status: str)¶
-
add_poll_option
(blogId: str, question: str)¶
-
add_to_favorites
(userId: str)¶
-
apply_avatar_frame
(avatarId: str, applyToAll: bool = True)¶ Apply avatar frame.
- Parameters
- avatarId : ID of the avatar frame.
- applyToAll : Apply to all.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
apply_bubble
(bubbleId: str, chatId: str, applyToAll: bool = False)¶
-
ban
(userId: str, reason: str, banType: int = None)¶
-
block
(userId: str)¶ Block an User.
- Parameters
- userId : ID of the User.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
check_in
(tz: int = 0)¶
-
check_notifications
()¶
-
claim_vc_reputation
(chatId: str)¶
-
clear_notifications
()¶
-
comment
(message: str, userId: str = None, blogId: str = None, wikiId: str = None, replyTo: str = None, isGuest: bool = False)¶ Comment on a User’s Wall, Blog or Wiki.
- Parameters
- message : Message to be sent.
- userId : ID of the User. (for Walls)
- blogId : ID of the Blog. (for Blogs)
- wikiId : ID of the Wiki. (for Wikis)
- replyTo : ID of the Comment to Reply to.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
create_wiki_category
(title: str, parentCategoryId: str, content: str = None)¶
-
deactivate_bubble
(bubbleId: str)¶
-
delete_blog
(blogId: str)¶
-
delete_chat
(chatId: str)¶ Delete a Chat.
- Parameters
- chatId : ID of the Chat.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
delete_comment
(commentId: str, userId: str = None, blogId: str = None, wikiId: str = None)¶ Delete a Comment on a User’s Wall, Blog or Wiki.
- Parameters
- commentId : ID of the Comment.
- userId : ID of the User. (for Walls)
- blogId : ID of the Blog. (for Blogs)
- wikiId : ID of the Wiki. (for Wikis)
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
delete_invite_code
(inviteId: str)¶
-
delete_message
(chatId: str, messageId: str, asStaff: bool = False, reason: str = None)¶ Delete a Message from a Chat.
- Parameters
- messageId : ID of the Message.
- chatId : ID of the Chat.
- asStaff : If execute as a Staff member (Leader or Curator).
- reason : Reason of the action to show on the Moderation History.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
delete_notification
(notificationId: str)¶
-
delete_wiki
(wikiId: str)¶
-
downvote_comment
(blogId: str, commentId: str)¶
-
edit_blog
(blogId: str, title: str = None, content: str = None, imageList: list = None, categoriesList: list = None, backgroundColor: str = None, fansOnly: bool = False)¶
-
edit_chat
(chatId: str, doNotDisturb: bool = None, pinChat: bool = None, title: str = None, icon: str = None, backgroundImage: BinaryIO = None, content: str = None, announcement: str = None, coHosts: list = None, keywords: list = None, pinAnnouncement: bool = None, publishToGlobal: bool = None, canTip: bool = None, viewOnly: bool = None, canInvite: bool = None, fansOnly: bool = None)¶ Send a Message to a Chat.
- Parameters
- chatId : ID of the Chat.
- title : Title of the Chat.
- content : Content of the Chat.
- icon : Icon of the Chat.
- backgroundImage : Background Image of the Chat.
- announcement : Announcement of the Chat.
- pinAnnouncement : If the Chat Announcement should Pinned or not.
- coHosts : List of User IDS to be Co-Host.
- keywords : List of Keywords of the Chat.
- viewOnly : If the Chat should be on View Only or not.
- canTip : If the Chat should be Tippable or not.
- canInvite : If the Chat should be Invitable or not.
- fansOnly : If the Chat should be Fans Only or not.
- publishToGlobal : If the Chat should show on Public Chats or not.
- doNotDisturb : If the Chat should Do Not Disturb or not.
- pinChat : If the Chat should Pinned or not.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
edit_profile
(nickname: str = None, content: str = None, icon: BinaryIO = None, chatRequestPrivilege: str = None, imageList: list = None, captionList: list = None, backgroundImage: str = None, backgroundColor: str = None, titles: list = None, colors: list = None, defaultBubbleId: str = None)¶ Edit account’s Profile.
- Parameters
- nickname : Nickname of the Profile.
- content : Biography of the Profile.
- icon : Icon of the Profile.
- backgroundImage : Url of the Background Picture of the Profile.
- backgroundColor : Hexadecimal Background Color of the Profile.
- defaultBubbleId : Chat bubble ID.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
edit_titles
(userId: str, titles: list, colors: list)¶
-
feature
(time: int, userId: str = None, chatId: str = None, blogId: str = None, wikiId: str = None)¶
-
flag
(reason: str, flagType: int, userId: str = None, blogId: str = None, wikiId: str = None, asGuest: bool = False)¶ Flag a User, Blog or Wiki.
- Parameters
- reason : Reason of the Flag.
- flagType : Type of the Flag.
- userId : ID of the User.
- blogId : ID of the Blog.
- wikiId : ID of the Wiki.
- asGuest : Execute as a Guest.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
follow
(userId: Union[str, list])¶ Follow an User or Multiple Users.
- Parameters
- userId : ID of the User or List of IDs of the Users.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
generate_invite_code
(duration: int = 0, force: bool = True)¶
-
get_all_users
(type: str = 'recent', start: int = 0, size: int = 25)¶ Get list of users of Amino.
- Parameters
- start : Where to start the list.
- size : Size of the list.
- Returns
- Success :
User Profile Count List Object
- Fail :
Exceptions
- Success :
-
get_best_quiz
(start: int = 0, size: int = 25)¶
-
get_blocked_users
(start: int = 0, size: int = 25)¶ List of Users that the User Blocked.
- Parameters
- start : Where to start the list.
- size : Size of the list.
- Returns
- Success :
Users List
- Fail :
Exceptions
- Success :
-
get_blocker_users
(start: int = 0, size: int = 25)¶ List of Users that are Blocking the User.
- Parameters
- start : Where to start the list.
- size : Size of the list.
- Returns
- Success :
List of User IDs
- Fail :
Exceptions
- Success :
-
get_blog_categories
(size: int = 25)¶
-
get_blog_comments
(blogId: str = None, wikiId: str = None, quizId: str = None, fileId: str = None, sorting: str = 'newest', start: int = 0, size: int = 25)¶
-
get_blog_info
(blogId: str = None, wikiId: str = None, quizId: str = None, fileId: str = None)¶
-
get_blog_users
(blogId: str, start: int = 0, size: int = 25)¶
-
get_blogs_by_category
(categoryId: str, start: int = 0, size: int = 25)¶
-
get_bubble_info
(bubbleId: str)¶
-
get_bubble_template_list
(start: int = 0, size: int = 25)¶
-
get_chat_messages
(chatId: str, size: int = 25, pageToken: str = None)¶ List of Messages from an Chat.
- Parameters
- chatId : ID of the Chat.
- size : Size of the list.
- pageToken : Next Page Token.
- Returns
- Success :
Message List
- Fail :
Exceptions
- Success :
-
get_chat_thread
(chatId: str)¶ Get the Chat Object from an Chat ID.
- Parameters
- chatId : ID of the Chat.
- Returns
- Success :
Chat Object
- Fail :
Exceptions
- Success :
-
get_chat_threads
(start: int = 0, size: int = 25)¶ List of Chats the account is in.
- Parameters
- start : Where to start the list.
- size : Size of the list.
- Returns
- Success :
Chat List
- Fail :
Exceptions
- Success :
-
get_chat_users
(chatId: str, start: int = 0, size: int = 25)¶
-
get_community_stickers
()¶
-
get_featured_users
(start: int = 0, size: int = 25)¶
-
get_influencer_fans
(userId: str, start: int = 0, size: int = 25)¶
-
get_invite_codes
(status: str = 'normal', start: int = 0, size: int = 25)¶
-
get_leaderboard_info
(type: str, start: int = 0, size: int = 25)¶
-
get_live_layer
()¶
-
get_message_info
(chatId: str, messageId: str)¶ Information of an Message from an Chat.
- Parameters
- chatId : ID of the Chat.
- message : ID of the Message.
- Returns
- Success :
Message Object
- Fail :
Exceptions
- Success :
-
get_notices
(start: int = 0, size: int = 25)¶ Parameters: - start – Start of the List (Start: 0)
- size – Amount of Notices to Show
Returns: Notices List
-
get_notifications
(start: int = 0, size: int = 25)¶
-
get_online_favorite_users
(start: int = 0, size: int = 25)¶
-
get_online_users
(start: int = 0, size: int = 25)¶
-
get_public_chat_threads
(type: str = 'recommended', start: int = 0, size: int = 25)¶ List of Public Chats of the Community.
- Parameters
- start : Where to start the list.
- size : Size of the list.
- Returns
- Success :
Chat List
- Fail :
Exceptions
- Success :
-
get_quiz_rankings
(quizId: str, start: int = 0, size: int = 25)¶
-
get_recent_blogs
(pageToken: str = None, start: int = 0, size: int = 25)¶
-
get_recent_quiz
(start: int = 0, size: int = 25)¶
-
get_recent_wiki_items
(start: int = 0, size: int = 25)¶
-
get_saved_blogs
(start: int = 0, size: int = 25)¶
-
get_sticker_collection
(collectionId: str)¶
-
get_sticker_pack_info
(sticker_pack_id: str)¶
-
get_sticker_packs
()¶
-
get_store_chat_bubbles
(start: int = 0, size: int = 25)¶
-
get_store_stickers
(start: int = 0, size: int = 25)¶
-
get_tipped_users
(blogId: str = None, wikiId: str = None, quizId: str = None, fileId: str = None, chatId: str = None, start: int = 0, size: int = 25)¶
-
get_trending_quiz
(start: int = 0, size: int = 25)¶
-
get_user_achievements
(userId: str)¶
-
get_user_blogs
(userId: str, start: int = 0, size: int = 25)¶
-
get_user_checkins
(userId: str)¶
-
get_user_followers
(userId: str, start: int = 0, size: int = 25)¶ List of Users that are Following the User.
- Parameters
- userId : ID of the User.
- start : Where to start the list.
- size : Size of the list.
- Returns
- Success :
User List
- Fail :
Exceptions
- Success :
-
get_user_following
(userId: str, start: int = 0, size: int = 25)¶ List of Users that the User is Following.
- Parameters
- userId : ID of the User.
- start : Where to start the list.
- size : Size of the list.
- Returns
- Success :
User List
- Fail :
Exceptions
- Success :
-
get_user_info
(userId: str)¶ Information of an User.
- Parameters
- userId : ID of the User.
- Returns
- Success :
User Object
- Fail :
Exceptions
- Success :
-
get_user_visitors
(userId: str, start: int = 0, size: int = 25)¶ List of Users that Visited the User.
- Parameters
- userId : ID of the User.
- start : Where to start the list.
- size : Size of the list.
- Returns
- Success :
Visitors List
- Fail :
Exceptions
- Success :
-
get_user_wikis
(userId: str, start: int = 0, size: int = 25)¶
-
get_vc_reputation_info
(chatId: str)¶
-
get_wall_comments
(userId: str, sorting: str, start: int = 0, size: int = 25)¶ List of Wall Comments of an User.
- Parameters
- userId : ID of the User.
- sorting : Order of the Comments.
newest
,oldest
,top
- start : Where to start the list.
- size : Size of the list.
- Returns
- Success :
Comments List
- Fail :
Exceptions
- Success :
-
get_wiki_categories
(start: int = 0, size: int = 25)¶
-
get_wiki_category
(categoryId: str, start: int = 0, size: int = 25)¶
-
get_wiki_info
(wikiId: str)¶
-
get_wiki_submissions
(start: int = 0, size: int = 25)¶
-
hide
(userId: str = None, chatId: str = None, blogId: str = None, wikiId: str = None, quizId: str = None, fileId: str = None, reason: str = None)¶
-
invite_to_chat
(userId: Union[str, list], chatId: str)¶ Invite a User or List of Users to a Chat.
- Parameters
- userId : ID of the User or List of User IDs.
- chatId : ID of the Chat.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
invite_to_vc
(chatId: str, userId: str)¶ Invite a User to a Voice Chat
- Parameters
- chatId - ID of the Chat
- userId - ID of the User
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
join_chat
(chatId: str)¶ Join an Chat.
- Parameters
- chatId : ID of the Chat.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
kick
(userId: str, chatId: str, allowRejoin: bool = True)¶
-
leave_chat
(chatId: str)¶ Leave an Chat.
- Parameters
- chatId : ID of the Chat.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
like_blog
(blogId: Union[str, list] = None, wikiId: str = None)¶ Like a Blog, Multiple Blogs or a Wiki.
- Parameters
- blogId : ID of the Blog or List of IDs of the Blogs. (for Blogs)
- wikiId : ID of the Wiki. (for Wikis)
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
like_comment
(commentId: str, userId: str = None, blogId: str = None, wikiId: str = None)¶ Like a Comment on a User’s Wall, Blog or Wiki.
- Parameters
- commentId : ID of the Comment.
- userId : ID of the User. (for Walls)
- blogId : ID of the Blog. (for Blogs)
- wikiId : ID of the Wiki. (for Wikis)
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
lottery
(tz: int = 0)¶
-
mark_as_read
(chatId: str, messageId: str)¶ Mark a Message from a Chat as Read.
- Parameters
- messageId : ID of the Message.
- chatId : ID of the Chat.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
moderation_history
(userId: str = None, blogId: str = None, wikiId: str = None, quizId: str = None, fileId: str = None, size: int = 25)¶
-
parse_headers
(data=None)¶
-
play_quiz
(quizId: str, questionIdsList: list, answerIdsList: list, quizMode: int = 0)¶
-
play_quiz_raw
(quizId: str, quizAnswerList: list, quizMode: int = 0)¶
-
post_blog
(title: str, content: str, imageList: list = None, captionList: list = None, categoriesList: list = None, backgroundColor: str = None, fansOnly: bool = False, extensions: dict = None)¶
-
post_wiki
(title: str, content: str, icon: str = None, imageList: list = None, keywords: str = None, backgroundColor: str = None, fansOnly: bool = False)¶
-
promotion
(noticeId: str, type: str = 'accept')¶
-
purchase
(objectId: str, objectType: int, aminoPlus: bool = True, autoRenew: bool = False)¶
-
reject_wiki_request
(requestId: str)¶
-
reorder_featured_users
(userIds: list)¶
-
repair_check_in
(method: int = 0)¶
-
reply_wall
(userId: str, commentId: str, message: str)¶
-
repost_blog
(content: str = None, blogId: str = None, wikiId: str = None)¶
-
review_quiz_questions
(quizId: str)¶
-
search_users
(nickname: str, start: int = 0, size: int = 25)¶
-
send_action
(actions: list, blogId: str = None, quizId: str = None, lastAction: bool = False)¶
-
send_coins
(coins: int, blogId: str = None, chatId: str = None, objectId: str = None, transactionId: str = None)¶
-
send_message
(chatId: str, message: str = None, messageType: int = 0, file: BinaryIO = None, fileType: str = None, replyTo: str = None, mentionUserIds: list = None, stickerId: str = None, embedId: str = None, embedType: int = None, embedLink: str = None, embedTitle: str = None, embedContent: str = None, embedImage: BinaryIO = None, linkSnippet: str = None, linkSnippetImage: BinaryIO = None)¶ Send a Message to a Chat.
- Parameters
- message : Message to be sent
- chatId : ID of the Chat.
- file : File to be sent.
- fileType : Type of the file.
audio
,image
,gif
- messageType : Type of the Message.
- mentionUserIds : List of User IDS to mention. ‘@’ needed in the Message.
- replyTo : Message ID to reply to.
- stickerId : Sticker ID to be sent.
- embedTitle : Title of the Embed.
- embedContent : Content of the Embed.
- embedLink : Link of the Embed.
- embedImage : Image of the Embed.
- embedId : ID of the Embed.
- linkSnippet : Link of the target snippet.
- linkSnippetImage : Image target snippet.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
start_chat
(userId: Union[str, list], message: str, title: str = None, content: str = None, isGlobal: bool = False, publishToGlobal: bool = False)¶ Start an Chat with an User or List of Users.
- Parameters
- userId : ID of the User or List of User IDs.
- message : Starting Message.
- title : Title of Group Chat.
- content : Content of Group Chat.
- isGlobal : If Group Chat is Global.
- publishToGlobal : If Group Chat should show in Global.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
strike
(userId: str, time: int, title: str = None, reason: str = None)¶
-
submit_to_wiki
(wikiId: str, message: str)¶
-
subscribe
(userId: str, autoRenew: str = False, transactionId: str = None)¶
-
thank_tip
(chatId: str, userId: str)¶
-
transfer_host
(chatId: str, userIds: list)¶
-
transfer_organizer
(chatId: str, userIds: list)¶
-
unban
(userId: str, reason: str)¶
-
unblock
(userId: str)¶ Unblock an User.
- Parameters
- userId : ID of the User.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
unfeature
(userId: str = None, chatId: str = None, blogId: str = None, wikiId: str = None)¶
-
unfollow
(userId: str)¶ Unfollow an User.
- Parameters
- userId : ID of the User.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
unhide
(userId: str = None, chatId: str = None, blogId: str = None, wikiId: str = None, quizId: str = None, fileId: str = None, reason: str = None)¶
-
unlike_blog
(blogId: str = None, wikiId: str = None)¶ Remove a like from a Blog or Wiki.
- Parameters
- blogId : ID of the Blog. (for Blogs)
- wikiId : ID of the Wiki. (for Wikis)
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
unlike_comment
(commentId: str, userId: str = None, blogId: str = None, wikiId: str = None)¶ Remove a like from a Comment on a User’s Wall, Blog or Wiki.
- Parameters
- commentId : ID of the Comment.
- userId : ID of the User. (for Walls)
- blogId : ID of the Blog. (for Blogs)
- wikiId : ID of the Wiki. (for Wikis)
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
unvote_comment
(blogId: str, commentId: str)¶
-
upvote_comment
(blogId: str, commentId: str)¶
-
vc_permission
(chatId: str, permission: int)¶ Voice Chat Join Permissions 1 - Open to Everyone 2 - Approval Required 3 - Invite Only
-
visit
(userId: str)¶ Visit an User.
- Parameters
- userId : ID of the User.
- Returns
- Success : 200 (int)
- Fail :
Exceptions
-
vote_poll
(blogId: str, optionId: str)¶
-
warn
(userId: str, reason: str = None)¶
-
-
class
amino.sub_client.
VCHeaders
(data=None)¶ Bases:
object
Socket¶
-
class
amino.socket.
Callbacks
(client)¶ Bases:
object
-
call
(type, data)¶
-
default
(data)¶
-
event
(type)¶
-
on_avatar_chat_end
(data)¶
-
on_avatar_chat_not_answered
(data)¶
-
on_avatar_chat_not_cancelled
(data)¶
-
on_avatar_chat_not_declined
(data)¶
-
on_avatar_chat_start
(data)¶
-
on_chat_background_changed
(data)¶
-
on_chat_content_changed
(data)¶
-
on_chat_host_transfered
(data)¶
-
on_chat_icon_changed
(data)¶
-
on_chat_invite
(data)¶
-
on_chat_pin_announcement
(data)¶
-
on_chat_removed_message
(data)¶
-
on_chat_tip
(data)¶
-
on_chat_tipping_disabled
(data)¶
-
on_chat_tipping_enabled
(data)¶
-
on_chat_title_changed
(data)¶
-
on_chat_unpin_announcement
(data)¶
-
on_chat_view_only_disabled
(data)¶
-
on_chat_view_only_enabled
(data)¶
-
on_delete_message
(data)¶
-
on_group_member_join
(data)¶
-
on_group_member_leave
(data)¶
-
on_image_message
(data)¶
-
on_invite_message
(data)¶
-
on_screen_room_end
(data)¶
-
on_screen_room_start
(data)¶
-
on_sticker_message
(data)¶
-
on_strike_message
(data)¶
-
on_text_message
(data)¶
-
on_text_message_force_removed
(data)¶
-
on_text_message_removed_by_admin
(data)¶
-
on_timestamp_message
(data)¶
-
on_user_typing_end
(data)¶
-
on_user_typing_start
(data)¶
-
on_video_chat_end
(data)¶
-
on_video_chat_not_answered
(data)¶
-
on_video_chat_not_cancelled
(data)¶
-
on_video_chat_not_declined
(data)¶
-
on_video_chat_start
(data)¶
-
on_voice_chat_end
(data)¶
-
on_voice_chat_not_answered
(data)¶
-
on_voice_chat_not_cancelled
(data)¶
-
on_voice_chat_not_declined
(data)¶
-
on_voice_chat_permission_invite_only
(data)¶
-
on_voice_chat_permission_invited_and_requested
(data)¶
-
on_voice_chat_permission_open_to_everyone
(data)¶
-
on_voice_chat_start
(data)¶
-
on_voice_message
(data)¶
-
on_welcome_message
(data)¶
-
on_youtube_message
(data)¶
-
resolve
(data)¶
-
Objects¶
-
class
amino.lib.util.objects.
BlogList
(data, nextPageToken=None, prevPageToken=None)¶ Bases:
object
-
BlogList
¶
-
-
class
amino.lib.util.objects.
CommunityStickerCollection
(data)¶ Bases:
object
-
CommunityStickerCollection
¶
-
Bases:
object
-
class
amino.lib.util.objects.
MessageList
(data, nextPageToken=None, prevPageToken=None)¶ Bases:
object
-
MessageList
¶
-
-
class
amino.lib.util.objects.
Objects
¶ Bases:
object
Bases:
object
Bases:
object
Exceptions¶
-
exception
amino.lib.util.exceptions.
API_ERR_CHAT_VVCHAT_NO_MORE_REPUTATIONS
(**kwargs)¶ Bases:
Exception
- API Code : 1627
- API Message :
Unknown Message
- API String : API_ERR_CHAT_VVCHAT_NO_MORE_REPUTATIONS
-
exception
amino.lib.util.exceptions.
API_ERR_COMMUNITY_USER_CREATED_COMMUNITIES_VERIFY
(**kwargs)¶ Bases:
Exception
- API Code : 257
- API Message :
Unknown Message
- API String : API_ERR_COMMUNITY_USER_CREATED_COMMUNITIES_VERIFY
-
exception
amino.lib.util.exceptions.
API_ERR_EMAIL_NO_PASSWORD
(**kwargs)¶ Bases:
Exception
- API Code : 251
- API Message :
Unknown Message
- API String : API_ERR_EMAIL_NO_PASSWORD
-
exception
amino.lib.util.exceptions.
API_ERR_INVALID_AUTH_NEW_DEVICE_LINK
(**kwargs)¶ Bases:
Exception
- API Code : 271
- API Message :
Unknown Message
- API String : API_ERR_INVALID_AUTH_NEW_DEVICE_LINK
-
exception
amino.lib.util.exceptions.
API_ERR_PUSH_SERVER_LIMITATION_APART
(**kwargs)¶ Bases:
Exception
- API Code : 2501
- API Message :
Unknown Message
- API String : API_ERR_PUSH_SERVER_LIMITATION_APART
-
exception
amino.lib.util.exceptions.
API_ERR_PUSH_SERVER_LIMITATION_COUNT
(**kwargs)¶ Bases:
Exception
- API Code : 2502
- API Message :
Unknown Message
- API String : API_ERR_PUSH_SERVER_LIMITATION_COUNT
-
exception
amino.lib.util.exceptions.
API_ERR_PUSH_SERVER_LIMITATION_TIME
(**kwargs)¶ Bases:
Exception
- API Code : 2504
- API Message :
Unknown Message
- API String : API_ERR_PUSH_SERVER_LIMITATION_TIME
-
exception
amino.lib.util.exceptions.
API_ERR_PUSH_SERVER_LINK_NOT_IN_COMMUNITY
(**kwargs)¶ Bases:
Exception
- API Code : 2503
- API Message :
Unknown Message
- API String : API_ERR_PUSH_SERVER_LINK_NOT_IN_COMMUNITY
-
exception
amino.lib.util.exceptions.
AccessDenied
(**kwargs)¶ Bases:
Exception
- API Code : 106
- API Message : Access denied.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
AccountAlreadyRestored
(**kwargs)¶ Bases:
Exception
- API Code : 2800
- API Message : Account already restored.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
AccountDeleted
(**kwargs)¶ Bases:
Exception
- API Code : 246
- API Message :
Unknown Message
- API String : AUTH_RECOVERABLE_DELETED_ACCOUNT
-
exception
amino.lib.util.exceptions.
AccountDisabled
(**kwargs)¶ Bases:
Exception
- API Code : 210
- API Message : This account is disabled.
- API String : AUTH_DISABLED_ACCOUNT
-
exception
amino.lib.util.exceptions.
AccountDoesntExist
(**kwargs)¶ Bases:
Exception
- API Code : 216
- API Message :
Unknown Message
- API String : AUTH_ACCOUNT_NOT_EXISTS
-
exception
amino.lib.util.exceptions.
AccountLimitReached
(**kwargs)¶ Bases:
Exception
- API Code : 219
- API Message : A maximum of 3 accounts can be created from this device. If you forget your password, please reset it.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
ActionNotAllowed
(**kwargs)¶ Bases:
Exception
- API Code : 110
- API Message : Action not allowed.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
ActivateAccount
(**kwargs)¶ Bases:
Exception
- API Code : 238
- API Message : Please activate your account first. Check your email, including your spam folder.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
AgeTooLow
(**kwargs)¶ Bases:
Exception
Raised when you try to configure an account but the age is too low. Minimum is 13.
-
exception
amino.lib.util.exceptions.
AlreadyCheckedIn
(**kwargs)¶ Bases:
Exception
- API Code : 2601
- API Message : Sorry, you can’t check in any more.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
AlreadyPlayedLottery
(**kwargs)¶ Bases:
Exception
- API Code : 4400
- API Message : You have played the maximum number of lucky draws.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
AlreadyRequestedJoinCommunity
(**kwargs)¶ Bases:
Exception
- API Code : 2001
- API Message : Sorry, you have already submitted a membership request.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
AlreadyUsedMonthlyRepair
(**kwargs)¶ Bases:
Exception
- API Code : 2611
- API Message :
Unknown Message
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
AminoIDAlreadyChanged
(**kwargs)¶ Bases:
Exception
- API Code : 6001
- API Message : Amino ID cannot be changed after you set it.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
BadImage
(**kwargs)¶ Bases:
Exception
- API Code : 300
- API Message :
Unknown Message
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
CannotFetchImage
(**kwargs)¶ Bases:
Exception
Raised when an image cannot be fetched.
-
exception
amino.lib.util.exceptions.
CannotSendCoins
(**kwargs)¶ Bases:
Exception
- API Code : 4500, 4501
- API Message :
Unknown Message
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
CantFollowYourself
(**kwargs)¶ Bases:
Exception
- API Code : 221
- API Message :
Unknown Message
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
CantLeaveCommunity
(**kwargs)¶ Bases:
Exception
- API Code : 239
- API Message : Sorry, you can not do this before transferring your Agent status to another member.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
ChatFull
(**kwargs)¶ Bases:
Exception
- API Code : 1605
- API Message :
Unknown Message
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
ChatInvitesDisabled
(**kwargs)¶ Bases:
Exception
- API Code : 1611
- API Message : This user has disabled chat invite requests.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
ChatMessageTooBig
(**kwargs)¶ Bases:
Exception
- API Code : 1664
- API Message :
Unknown Message
- API String : API_ERR_CHAT_MESSAGE_CONTENT_TOO_LONG
-
exception
amino.lib.util.exceptions.
ChatRequestsBlocked
(**kwargs)¶ Bases:
Exception
Raised when you try to make an action but the end user has chat requests blocked.
-
exception
amino.lib.util.exceptions.
ChatViewOnly
(**kwargs)¶ Bases:
Exception
- API Code : 1663
- API Message :
Unknown Message
- API String :
Unknown String
-
amino.lib.util.exceptions.
CheckException
(data)¶
-
exception
amino.lib.util.exceptions.
CommandCooldown
(**kwargs)¶ Bases:
Exception
- API Code : 291
- API Message : Whoa there! You’ve done too much too quickly. Take a break and try again later.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
CommunityCreateLimitReached
(**kwargs)¶ Bases:
Exception
- API Code : 806
- API Message :
Unknown Message
- API String : API_ERR_COMMUNITY_USER_CREATED_COMMUNITIES_EXCEED_QUOTA
-
exception
amino.lib.util.exceptions.
CommunityDeleted
(**kwargs)¶ Bases:
Exception
- API Code : 833
- API Message : This Community has been deleted.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
CommunityDisabled
(**kwargs)¶ Bases:
Exception
- API Code : 814
- API Message : This Community is disabled.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
CommunityNameAlreadyTaken
(**kwargs)¶ Bases:
Exception
- API Code : 805
- API Message :
Unknown Message
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
CommunityNeeded
(**kwargs)¶ Bases:
Exception
Raised when you try to execute an command but a Community needs to be specified.
-
exception
amino.lib.util.exceptions.
CommunityNoLongerExists
(**kwargs)¶ Bases:
Exception
- API Code : 801
- API Message : This Community no longer exists.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
CommunityNotFound
(**kwargs)¶ Bases:
Exception
Raised when you search for a community but nothing is found.
-
exception
amino.lib.util.exceptions.
DuplicatePollOption
(**kwargs)¶ Bases:
Exception
- API Code : 1501
- API Message : Sorry, you have duplicate poll options.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
EmailAlreadyTaken
(**kwargs)¶ Bases:
Exception
- API Code : 215
- API Message : Hey this email
X
has been registered already. You can try to log in with the email or edit the email. - API String : API_ERR_EMAIL_TAKEN
-
exception
amino.lib.util.exceptions.
EmailFlaggedAsSpam
(**kwargs)¶ Bases:
Exception
- API Code : 241
- API Message : This email provider has been flagged for use in spamming.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
FailedLogin
(**kwargs)¶ Bases:
Exception
Raised when you try to login but it fails.
-
exception
amino.lib.util.exceptions.
FileTooLarge
(**kwargs)¶ Bases:
Exception
- API Code : 102
- API Message :
Unknown Message
- API String : API_STD_ERR_ENTITY_TOO_LARGE_RAW
-
exception
amino.lib.util.exceptions.
FlagTypeNeeded
(**kwargs)¶ Bases:
Exception
Raised when you try to flag a community, blog or user but a Flag Type needs to be specified.
-
exception
amino.lib.util.exceptions.
IncorrectVerificationCode
(**kwargs)¶ Bases:
Exception
- API Code : 3102
- API Message : Incorrect verification code.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
InsufficientLevel
(**kwargs)¶ Bases:
Exception
- API Code : 551
- API Message : This post type is restricted to members with a level
X
ranking and above. - API String :
Unknown String
-
exception
amino.lib.util.exceptions.
InvalidAccountOrPassword
(**kwargs)¶ Bases:
Exception
- API Code : 200
- API Message :
Unknown Message
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
InvalidAminoID
(**kwargs)¶ Bases:
Exception
- API Code : 6002
- API Message : Invalid Amino ID
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
InvalidCodeOrLink
(**kwargs)¶ Bases:
Exception
- API Code : 802
- API Message : Sorry, this code or link is invalid.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
InvalidDevice
(**kwargs)¶ Bases:
Exception
- API Code : 218
- API Message : Error! Your device is currently not supported, or the app is out of date. Please update to the latest version.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
InvalidEmail
(**kwargs)¶ Bases:
Exception
- API Code : 213
- API Message : Invalid email address.
- API String : API_ERR_EMAIL
-
exception
amino.lib.util.exceptions.
InvalidName
(**kwargs)¶ Bases:
Exception
- API Code : 99001
- API Message : Sorry, the name is invalid.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
InvalidPassword
(**kwargs)¶ Bases:
Exception
- API Code : 214
- API Message : Invalid password. Password must be 6 characters or more and contain no spaces.
- API String : API_ERR_PASSWORD
-
exception
amino.lib.util.exceptions.
InvalidRequest
(**kwargs)¶ Bases:
Exception
- API Code : 103, 104
- API Message : Invalid Request. Please update to the latest version. If the problem continues, please contact us.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
InvalidSession
(**kwargs)¶ Bases:
Exception
- API Code : 105
- API Message :
Unknown Message
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
InvalidThemepack
(**kwargs)¶ Bases:
Exception
- API Code : 313
- API Message :
Unknown Message
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
InvalidVoiceNote
(**kwargs)¶ Bases:
Exception
- API Code : 314
- API Message :
Unknown Message
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
InviteCodeNotFound
(**kwargs)¶ Bases:
Exception
- API Code : 1900
- API Message : Sorry, the requested data no longer exists. Try refreshing the view.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
LevelFiveRequiredToEnableProps
(**kwargs)¶ Bases:
Exception
- API Code : 1661
- API Message :
Unknown Message
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
LibraryUpdateAvailable
(**kwargs)¶ Bases:
Exception
Raised when a new library update is available.
-
exception
amino.lib.util.exceptions.
MemberKickedByOrganizer
(**kwargs)¶ Bases:
Exception
- API Code : 1637
- API Message : This member was previously kicked by the organizer and cannot be reinvited.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
MessageNeeded
(**kwargs)¶ Bases:
Exception
- API Code : 113
- API Message : Be more specific, please.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
NoChatThread
(**kwargs)¶ Bases:
Exception
Raised when you try to make an action but no chat was selected.
-
exception
amino.lib.util.exceptions.
NoCommunity
(**kwargs)¶ Bases:
Exception
Raised when you try to make an action but no community was selected.
-
exception
amino.lib.util.exceptions.
NoImageSource
(**kwargs)¶ Bases:
Exception
Raised when you try to make an action but no image source was selected.
-
exception
amino.lib.util.exceptions.
NotEnoughCoins
(**kwargs)¶ Bases:
Exception
- API Code : 4300
- API Message :
Unknown Message
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
NotLoggedIn
(**kwargs)¶ Bases:
Exception
Raised when you try to make an action but you aren’t logged in.
-
exception
amino.lib.util.exceptions.
NotOwnerOfChatBubble
(**kwargs)¶ Bases:
Exception
- API Code : 3905
- API Message : You are not the owner of this chat bubble.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
PageRepostedTooRecently
(**kwargs)¶ Bases:
Exception
- API Code : 503
- API Message : Sorry, you have reported this page too recently.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
ReachedMaxCategories
(**kwargs)¶ Bases:
Exception
- API Code : 1002
- API Message : Sorry, you can create up to 100 categories.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
ReachedMaxPollOptions
(**kwargs)¶ Bases:
Exception
- API Code : 1507
- API Message : Sorry, you can only join or add up to 5 of your items per poll.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
ReachedMaxTitles
(**kwargs)¶ Bases:
Exception
- API Code : 262
- API Message : You can only add up to 20 Titles. Please choose the most relevant ones.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
ReachedTitleLength
(**kwargs)¶ Bases:
Exception
- API Code : 240
- API Message : Sorry, the max length of member’s title is limited to 20.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
ReasonNeeded
(**kwargs)¶ Bases:
Exception
Raised when you try to execute an command but a Reason needs to be specified.
-
exception
amino.lib.util.exceptions.
RemovedFromChat
(**kwargs)¶ Bases:
Exception
- API Code : 1612
- API Message : You’ve been removed from this chatroom.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
RequestRejected
(**kwargs)¶ Bases:
Exception
- API Code : 235
- API Message : Request rejected. You have been temporarily muted (read only mode) because you have received a strike. To learn more, please check the Help Center.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
RequestedNoLongerExists
(**kwargs)¶ Bases:
Exception
- API Code : 500, 700, 1600
- API Message : Sorry, the requested data no longer exists. Try refreshing the view.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
ServiceUnderMaintenance
(**kwargs)¶ Bases:
Exception
- API Code : 111
- API Message : Sorry, this service is under maintenance. Please check back later.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
SpecifyType
(**kwargs)¶ Bases:
Exception
Raised when you need to specify the output of the command.
-
exception
amino.lib.util.exceptions.
TooManyChats
(**kwargs)¶ Bases:
Exception
- API Code : 1602
- API Message : Sorry, you can only have up to 1000 chat sessions.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
TooManyInviteUsers
(**kwargs)¶ Bases:
Exception
- API Code : 1606
- API Message : Sorry, you can only invite up to 999 people.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
TooManyRequests
(**kwargs)¶ Bases:
Exception
- API Code : 219
- API Message : Too many requests. Try again later.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
TransferRequestNeeded
(**kwargs)¶ Bases:
Exception
Raised when you need to transfer host to complete the action.
-
exception
amino.lib.util.exceptions.
UnexistentData
(**kwargs)¶ Bases:
Exception
- API Code : 107
- API Message : The requested data does not exist.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
UnknownResponse
(**kwargs)¶ Bases:
Exception
Raised when an error occurs but the reason is unknown.
-
exception
amino.lib.util.exceptions.
UnsupportedEmail
(**kwargs)¶ Bases:
Exception
- API Code : 215
- API Message : This email address is not supported.
- API String : API_ERR_EMAIL_TAKEN
-
exception
amino.lib.util.exceptions.
UnsupportedLanguage
(**kwargs)¶ Bases:
Exception
Raised when you try to use a language that isn’t supported or exists.
-
exception
amino.lib.util.exceptions.
UnsupportedService
(**kwargs)¶ Bases:
Exception
- API Code : 100
- API Message : Unsupported service. Your client may be out of date. Please update it to the latest version.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
UserBannedByTeamAmino
(**kwargs)¶ Bases:
Exception
- API Code : 293
- API Message : Sorry, this user has been banned by Team Amino.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
UserNotJoined
(**kwargs)¶ Bases:
Exception
- API Code : 1613
- API Message : Sorry, this user has not joined.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
UserNotMemberOfCommunity
(**kwargs)¶ Bases:
Exception
- API Code : 230
- API Message : You have to join this Community first.
- API String : API_ERR_USER_NOT_IN_COMMUNITY
Bases:
Exception
- API Code : 225
- API Message : This user is unavailable.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
VerificationRequired
(**kwargs)¶ Bases:
Exception
- API Code : 270
- API Message : Verification Required.
- API String : API_ERR_NEED_TWO_FACTOR_AUTHENTICATION
-
exception
amino.lib.util.exceptions.
WallCommentingDisabled
(**kwargs)¶ Bases:
Exception
- API Code : 702
- API Message : This member has disabled commenting on their wall.
- API String :
Unknown String
-
exception
amino.lib.util.exceptions.
WrongType
(**kwargs)¶ Bases:
Exception
Raised when you attribute the function the wrong type.
-
exception
amino.lib.util.exceptions.
YouAreBanned
(**kwargs)¶ Bases:
Exception
- API Code : 229
- API Message : You are banned.
- API String :
Unknown String