Python API wrapper around vk.com API


Keywords
vk.com, vk, vkontakte, vk api, api, api-wrapper, vk-api, vkapi, vkontakte-api, vkontakte-client
License
MIT
Install
pip install py-vkontakte==2018.5.31

Documentation

py-vkontakte — Python client for API vk.com

Build codecov
Package GitHub release Solid Solid

Table of contents

Install

pip install py-vkontakte

Run tests

pip install -r requirements-dev.txt
pytest

First start

>>> import vk
>>> api = vk.Api('YOUR_TOKEN')

User

>>> user = api.get_user('durov')  # single user
>>> user_items = api.get_users([1, 's.gaynetdinov'])  # many user
>>> [user.id for user in user_items]
[1, 23768217]
# User object
>>> user.id  # 1
>>> user.first_name  # 'Павел'
>>> user.last_name  # 'Дуров'
>>> user.maiden_name  # None
>>> user.nickname  # ''
>>> user.bdate  # '10.10.1984'
>>> user.sex  # 'male'
>>> user.status  # '道德經'
>>> user.site  # 'http://t.me/durov'
>>> user.relation  # None
>>> user.relation_partner  # None
>>> user.facebook  # '501012028'
>>> user.skype  # None
>>> user.twitter  # 'durov'
>>> user.livejournal  # None
>>> user.instagram  # 'durov'
>>> user.is_verified  # True
>>> user.is_trending  # False
>>> user.domain  # 'durov'
>>> user.screen_name  # 'durov'
>>> user.last_seen  # datetime.datetime
>>> user.platform  # 'web (vk.com)'
>>> user.is_deactivated  # False
>>> user.is_deleted  # False
>>> user.is_banned  # False

>>> user.get_about()
>>> user.get_activities()
>>> user.get_books()
>>> user.get_career()  # UserCareer
>>> user.get_games()
>>> user.get_movies()
>>> user.get_music()
>>> user.get_quotes()
>>> user.get_tv()

UserCareer

>>> career = user.get_career()
>>> career.group
>>> career.company
>>> career.country
>>> career.city
>>> career.city_name
>>> career.start
>>> career.end
>>> career.position

Group

>>> groups_items = api.get_groups([1, 'devclub'])  # return generator
>>> [group for group in groups_items]
[<Group: apiclub>, <Group: devclub>]
# checking a user is a member of a current group
>>> user = api.get_user('durov')
>>> group = api.get_group('telegram')
>>> user in group  # or 100500 in group