REST API

List of all methods is available here: https://api.mail.ru/docs/reference/rest/.

Executing requests

For executing API requests call an instance of APIMethod class. You can get it as an attribute of API class instance or as an attribute of other APIMethod class instance.

from aiomailru import API

api = API(session)

events = await api.stream.get()  # events for current user
friends = await api.friends.get()  # current user's friends

Under the hood each API request is enriched with parameters to generate signature:

• method
• app_id
• session_key
• secure

and with the following parameter after generating signature:

• sig, see https://api.mail.ru/docs/guides/restapi/#sig

Objects

Some objects are returned in several methods.

User

field	description
uid string	User ID.
first_name string	First name.
last_name string	Last name.
nick string	Nickname.
status_text string	User status.
email string	E-mail address.
sex integer, [0,1]	User sex. Possible values: - 0 - male - 1 - female
show_age integer, [0,1]	Information whether the user allows to show the age.
birthday string	User's date of birth. Returned as DD.MM.YYYY.
has_my integer, [0,1]	Information whether the user has profile.
has_pic integer, [0,1]	Information whether the user has profile photo.
pic string	URL of user's photo.
pic_small string	URL of user's photo with at most 45 pixels on the longest side.
pic_big string	URL of user's photo with at most 600 pixels on the longest side.
pic_22 string	URL of square photo of the user photo with 22 pixels in width.
pic_32 string	URL of square photo of the user photo with 32 pixels in width.
pic_40 string	URL of square photo of the user photo with 40 pixels in width.
pic_50 string	URL of square photo of the user photo with 50 pixels in width.
pic_128 string	URL of square photo of the user photo with 128 pixels in width.
pic_180 string	URL of square photo of the user photo with 180 pixels in width.
pic_190 string	URL of square photo of the user photo with 190 pixels in width.
link string	Returns a website address of a user profile.
referer_type string	Referer type. Possible values: - stream.install - stream.publish - invitation - catalog - suggests - left menu suggest - new apps - guestbook - agent
referer_id string	Identifies where a user came from; see https://api.mail.ru/docs/guides/ref/.
is_online integer, [0,1]	Information whether the user is online.
is_friend integer, [0,1]	Information whether the user is a friend of current user.
friends_count integer	Number of friends.
follower integer, [0,1]	Information whether the user is a follower of current user.
following integer, [0,1]	Information whether current user is a follower of the user.
subscribe integer, [0,1]	Information whether current user is a subscriber of the user.
subscribers_count integer	Number of subscribers.
video_count integer	Number of videos.
is_verified integer, [0,1]	Information whether the user is verified.
vip integer, [0,1]	Information whether the user is vip.
app_installed integer, [0,1]	Information whether the user has installed the current app.
last_visit integer	Date (in Unixtime) of the last user's visit.
cover object	Information about profile's cover; see Cover.
group_info object	Object with following fields: - category_id integer - short_description string - full_description string - interests string - posts_cnt integer - category_name string - rules string
location object	Object with following fields: - country object: {id integer, name string} - city object: {id integer, name string} - region object: {id integer, name string}

Event

Object describes an event and contains following fields:

field	description
thread_id string	Comment thread ID in the following format: <User's checksum><ID>.
authors array	Information about authors; see User.
type_name string	Event type name.
click_url string Returns only if current event is likeable.	Event URL.
likes_count integer Returns only if current event is likeable.	Number of "likes".
attachments array	Information about attachments to the event (link, image, video, audio, user, ...) if any; see Attachments.
time integer	Date (in Unixtime) of the event.
huid string	Event ID in the following format: <User's checksum><Event ID>.
generator object	Object with the following fields: - icon string - URL of app icon. - url string - App url. - app_id integer - App ID. - type string - App type. - title string - App title.
user_text string	User text.
is_liked_by_me integer, [0,1]	Shows if current user has liked the event.
subtype string	"event"
is_commentable integer, [0,1]	Shows if the event is commentable.
type string	Event type; see Event types.
is_likeable integer, [0,1]	Shows if the event is likeable.
id string	Event ID.
text_media array Returns only if event's type name is micropost.	Information about text; see Attachments.
comments_count integer Returns only if current event is commentable.	Number of comments.
action_links array	Each object contains following fields: - text string - href string

Event types

• 1-1 Photo
• 1-2 Video
• 1-3 Photo mark
• 1-4 Video mark
• 1-6 TYPE_PHOTO_WAS_SELECTED
• 1-7 Music
• 1-8 Photo comment
• 1-9 TYPE_PHOTO_SUBSCRIPTION
• 1-10 Video comment
• 1-11 TYPE_PHOTO_WAS_MODERATED
• 1-12 TYPE_VIDEO_WAS_MODERATED
• 1-13 TYPE_VIDEO_TRANSLATION
• 1-14 Private photo comment
• 1-15 Private video comment
• 1-16 Music comment
• 1-17 TYPE_PHOTO_NEW_COMMENT
• 1-18 TYPE_VIDEO_NEW_COMMENT
• 3-1 Blog post
• 3-2 Blog post comment
• 3-3 Join community
• 3-4 Community
• 3-5 TYPE_USER_COMMUNITY_LEAVE
• 3-6 TYPE_BLOG_COMMUNITY_POST
• 3-7 TYPE_USER_GUESTBOOK
• 3-8 TYPE_BLOG_CHALLENGE_ACCEPT
• 3-9 TYPE_BLOG_CHALLENGE_THROW
• • 3-10 TYPE_BLOG_SUBSCRIPTION
• 3-12 Blog post mark
• 3-13 Community post mark
• 3-23 Post in micro blog
• 3-25 Private post in micro blog
• 4-1 TYPE_QUESTION
• 4-2 TYPE_QUESTION_ANSWER
• 4-6 TYPE_QUESTION_ANSWER_PRIVATE
• 5-1 TYPE_USER_FRIEND
• 5-2 TYPE_USER_ANKETA
• 5-4 TYPE_USER_CLASSMATES
• 5-5 TYPE_USER_CAREER
• 5-7 TYPE_USER_AVATAR
• 5-9 TYPE_USER_PARTNER
• 5-10 TYPE_GIFT_SENT
• 5-11 TYPE_GIFT_RECEIVED
• 5-12 TYPE_USER_MILITARY
• 5-13 TYPE_USER_PARTNER_APPROVED
• 5-15 TYPE_USER_ITEM
• 5-16 App install
• 5-17 App event
• 5-18 Community post
• 5-19 Post in community guestbook
• 5-20 Join community
• 5-21 Community video
• 5-22 Community photo
• 5-24 App event
• 5-24 TYPE_APP_INFO
• 5-26 Link share
• 5-27 Event like
• 5-29 Video share
• 5-30 Comment to link share
• 5-31 Comment to video share
• 5-32 Micropost comment

Like

Object wraps an event that a user liked and contains following fields:

field	description
time integer	Date (in Unixtime) of the "like".
author object	Information about the user; see User.
huid string	Like ID in the following format: <User's checksum><Like ID>.
subevent object	Information about the event; see Event.
subtype string	"like".
is_commentable integer, [0,1]	0.
id string	Like ID.
is_likeable integer, [0,1]	0.

Comment

Object wraps an event that a user commented and contains following fields:

field	description
time integer	Date (in Unixtime) of the comment.
huid string	Comment ID in the following format: <User's checksum><Comment ID>.
subevent object	Information about the event; see Event.
subtype string	"comment".
comment object	Object with following fields: - text string - Text. - time integer - Date (in Unixtime) of the comment. - is_deleted integer [0,1] - Shows if the comment deleted. - id string - Comment ID. - author object - Information about the user; see User. - text_media object - Object: {object string and content string}.
is_commentable integer, [0,1]	0.
id string	Comment ID.
is_likeable integer, [0,1]	0.

Attachments

Information about event's media attachments is returned in field attachments and contains an array of objects. Each object contains field object with type name that defines all other fields.

text

contains following fields:

field
object string, ["text"]
content string

tag

contains one additional field content with an object with following fields:

field
is_blacklist integer, [0,1]
tag string

link

contains one additional field content with an object with following fields:

field
type-id string, ["text"]
contents string

or contains following fields:

field
object string, ["link"]
text string
url string

avatar

contains one additional field new with an object with following fields:

field
thread_id string
width integer
click_url string
album_id string
src string
height integer
desc string
src_hires string
id string
owner_id string

image

contains following fields:

field
likes_count integer
thread_id string
width string
object string, ["image"]
click_url string
album_id string
src string
resized_src string
height string
src_filed string
src_hires string
id string
owner_id string
comments_count integer

All fields but object and src may not be returned.

music

contains following fields:

field
is_add integer
click_url string
object string, ["music"]
name string
author string
duration integer
file_url string
uploader string
mid string

video

contains following fields:

field
width integer
object string, ["video"]
album_id string
view_count integer
desc string
comments_count integer
likes_count integer
thread_id string
image_filed string
click_url string
src string
duration integer
height integer
is_liked_by_me integer
external_id string
owner_id string
title string

app

contains one additional field content with an object with following fields:

field
PublishStatus object Object with following fields: - My string - Mobile string
ID string
InstallationsSpaced string
ShortName string
Genre array Each object contains following fields: - name string - id string - admin_genre integer, [0,1]
Votes object Object with following fields: - VoteSum string - VotesCount string - VotesStarsWidth string - Votes2IntRounded string - Votes2DigitRounded string
Installations integer
ShortDescription string
Name string
Description string
Pictures object

group

contains one additional field content with an object; see User.

gift

contains one additional field content with an object with following fields:

field
is_private integer, [0,1]
click_url string
is_anonymous integer, [0,1]
time integer
is_read integer, [0,1]
to object see User.
gift object
from object see User.
text string
rus_time string
long_id string

Other

Objects that are not classified.

Cover

Object contains information about profile's cover.

field
cover_position string
width string
size string
aid string
pid string
thread_id string
owner string
target_album object Information about target album; see Target Album.
click_url string
src string
height string
cover_width string
created string
comment string
src_small string
cover_height string
title string

Target Album

Object contains information about cover's target album.

field
link string
owner string
sort_order string
sort_by string
description string
privacy_desc string
size integer
aid string
created integer
cover_pid string
cover_url string
is_commentable integer, [0,1]
title string
updated integer
privacy integer
can_read_comment integer, [0,1]