Predict age for the specified user

Description

Predict age for the specified user

Usage

age_predict(user_id = "")

Arguments

Checks the friendship status between two users

Description

Checks the friendship status between two users

Usage

areFriends(source_id, target_id)

Arguments

Examples

## Not run: 
areFriends(me(), 123456)

## End(Not run)

Returns a list of comments on a topic on a community's discussion board

Description

Returns a list of comments on a topic on a community's discussion board

Usage

boardGetComments(
  group_id = "",
  topic_id = "",
  need_likes = 0,
  start_comment_id = "",
  offset = 0,
  count = 20,
  sort = "",
  extended = 0,
  v = getAPIVersion()
)

Arguments

Returns a list of comments on a topic on a community's discussion board

Description

Returns a list of comments on a topic on a community's discussion board

Usage

boardGetCommentsExecute(
  group_id = "",
  topic_id = "",
  need_likes = 0,
  start_comment_id = "",
  offset = 0,
  count = 20,
  sort = "",
  progress_bar = FALSE,
  v = getAPIVersion()
)

Arguments

Returns a list of comments on a community's discussion board

Description

Returns a list of comments on a community's discussion board

Usage

boardGetCommentsList(topics, progress_bar = FALSE, v = getAPIVersion())

Arguments

Clear text

Description

Clear text

Usage

clear_text(lines, patterns = list())

Arguments

Check if collection exists

Description

Check if collection exists

Usage

collection_exists(
  collection_name,
  collection_suffix = "",
  db_name = db_getActive()
)

Arguments

Create empty collection

Description

Create empty collection

Usage

create_empty_collection(collection, suffix, db_name = db_getActive())

Arguments

Returns list of chairs on a specified faculty

Description

Returns list of chairs on a specified faculty

Usage

databaseGetChairs(
  faculty_id = "",
  offset = "",
  count = "100",
  v = getAPIVersion()
)

Arguments

Examples

## Not run: 
databaseGetChairs(206)

## End(Not run)

Returns a list of cities

Description

Returns a list of cities

Usage

databaseGetCities(
  country_id = "",
  region_id = "",
  q = "",
  need_all = "1",
  offset = "",
  count = "100",
  v = getAPIVersion()
)

Arguments

Examples

## Not run: 
databaseGetCities(country_id=1, need_all=0)

## End(Not run)

Returns information about cities by their IDs

Description

Returns information about cities by their IDs

Usage

databaseGetCitiesById(city_ids = "", v = getAPIVersion())

Arguments

Examples

## Not run: 
databaseGetCitiesById('1,2')

## End(Not run)

Returns a list of countries

Description

Returns a list of countries

Usage

databaseGetCountries(
  need_all = "1",
  code = "",
  offset = "",
  count = "100",
  v = getAPIVersion()
)

Arguments

Examples

## Not run: 
databaseGetCountries(count=234)

## End(Not run)

Returns information about countries by their IDs

Description

Returns information about countries by their IDs

Usage

databaseGetCountriesById(country_ids, v = getAPIVersion())

Arguments

Examples

## Not run: 
databaseGetCountriesById('1,2,3,4')

## End(Not run)

Returns a list of faculties (i.e., university departments)

Description

Returns a list of faculties (i.e., university departments)

Usage

databaseGetFaculties(
  university_id = "",
  offset = "",
  count = "100",
  v = getAPIVersion()
)

Arguments

Examples

## Not run: 
databaseGetFaculties(53)

## End(Not run)

Returns a list of regions

Description

Returns a list of regions

Usage

databaseGetRegions(
  country_id = "",
  q = "",
  offset = "",
  count = "100",
  v = getAPIVersion()
)

Arguments

Examples

## Not run: 
databaseGetRegions(229)

## End(Not run)

Returns a list of available classes

Description

Returns a list of available classes

Usage

databaseGetSchoolClasses(country_id = "", v = getAPIVersion())

Arguments

Examples

## Not run: 
databaseGetSchoolClasses(1)

## End(Not run)

Returns a list of schools

Description

Returns a list of schools

Usage

databaseGetSchools(
  q = "",
  city_id = "",
  offset = "",
  count = "100",
  v = getAPIVersion()
)

Arguments

Examples

## Not run: 
databaseGetSchools(city_id = 2)

## End(Not run)

Returns information about streets by their IDs

Description

Returns information about streets by their IDs

Usage

databaseGetStreetsById(street_ids = "", v = getAPIVersion())

Arguments

Examples

## Not run: 
databaseGetStreetsById(1)

## End(Not run)

Returns a list of higher education institutions

Description

Returns a list of higher education institutions

Usage

databaseGetUniversities(
  q = "",
  country_id = "",
  city_id = "",
  offset = "",
  count = "100",
  v = getAPIVersion()
)

Arguments

Examples

## Not run: 
databaseGetUniversities(city_id = '2')

## End(Not run)

Drop database

Description

Drop database

Usage

db_drop(db_name)

Arguments

Drop collection

Description

Drop collection

Usage

db_drop_collection(
  collection_name,
  collection_suffix = "",
  db_name = db_getActive()
)

Arguments

The current database name

Description

The current database name

Usage

db_getActive()

The current database name

Description

The current database name

Usage

db_getName()

Get collection

Description

Get collection

Usage

db_get_collection(
  collection_name,
  collection_suffix = "",
  db_name = db_getActive()
)

Arguments

Get a mongo connection object

Description

Get a mongo connection object

Usage

db_get_connection(
  collection_name,
  collection_suffix = "",
  db_name = db_getActive()
)

Arguments

Initialize database

Description

Initialize database

Usage

db_init(db_name = "temp", verbose = FALSE)

Arguments

Insert object into existing collection

Description

Insert object into existing collection

Usage

db_insert(object, collection, suffix, db_name = db_getActive())

Arguments

Load all collections from db for specified data base

Description

Load all collections from db for specified data base

Usage

db_load(db_name = db_getActive())

Arguments

Load collection from db

Description

Load collection from db

Usage

db_load_collection(
  collection_name,
  collection_suffix = "",
  db_name = db_getActive()
)

Arguments

Get meta connection

Description

Get meta connection

Usage

db_metaConnection()

Save object to db

Description

Save object to db

Usage

db_save(object, collection, suffix = "", db_name = db_getActive())

Arguments

Update existing records

Description

Update existing records

Usage

db_update(
  object,
  key,
  collection,
  suffix = "",
  db_name = db_getActive(),
  upsert = FALSE
)

Arguments

A universal method for calling a sequence of other methods while saving and filtering interim results

Description

A universal method for calling a sequence of other methods while saving and filtering interim results

Usage

execute(code, params = list())

Arguments

Filtering attachments by type

Description

Filtering attachments by type

Usage

filterAttachments(attachments, type)

Arguments

Get access token

Description

Get access token

Usage

getAccessToken()

Building a friend graph for an arbitrary list of users

Description

Building a friend graph for an arbitrary list of users

Usage

getArbitraryNetwork(users_ids, format = "edgelist")

Arguments

Get country ID and title by given city ID

Description

Get country ID and title by given city ID

Usage

getCountryByCityId(city_id)

Arguments

Building a friend graph

Description

Building a friend graph

Usage

getEgoNetwork(users_ids = "")

Arguments

Returns a list of user IDs or detailed information about a user's friends

Description

Returns a list of user IDs or detailed information about a user's friends

Usage

getFriends(
  user_id = "",
  order = "",
  list_id = "",
  count = "",
  offset = "",
  fields = "",
  name_case = "",
  flatten = FALSE,
  v = getAPIVersion()
)

Arguments

Examples

## Not run: 
friends_list <- getFriends(user_id=1, order='name', fields='bdate')
friends <- friends_list$items

## End(Not run)

Returns a list of friends IDs for the specified users

Description

Returns a list of friends IDs for the specified users

Usage

getFriendsBy25(user_ids, v = getAPIVersion())

Arguments

Examples

## Not run: 
my_friends <- getFriends()
friends_of_friends <- getFriendsBy25(my_friends$items[1:25])

## End(Not run)

Returns a list of friends IDs for the specified users

Description

Returns a list of friends IDs for the specified users

Usage

getFriendsFor(users_ids, v = getAPIVersion())

Arguments

Examples

## Not run: 
friends <- getFriendsFor(sample(x=seq(1:10000000), size=100, replace=FALSE))
users <- getUsersExecute(friends, fields = 'sex')

## End(Not run)

Returns a list of the communities to which a user belongs

Description

Returns a list of the communities to which a user belongs

Usage

getGroups(
  user_id = "",
  extended = "",
  filter = "",
  fields = "",
  offset = "",
  count = "",
  v = getAPIVersion()
)

Arguments

Examples

## Not run: 
groups <- getGroups(me(), extended = 1, fields = 'city')

## End(Not run)

Returns information about communities by their IDs

Description

Returns information about communities by their IDs

Usage

getGroupsById(group_ids = "", group_id = "", fields = "", v = getAPIVersion())

Arguments

Returns a list of the communities for the specified users

Description

Returns a list of the communities for the specified users

Usage

getGroupsForUsers(
  users,
  extended = "",
  filter = "",
  fields = "",
  progress_bar = FALSE,
  v = getAPIVersion()
)

Arguments

Examples

## Not run: 
members <- getGroupsForUsers(c(me(), 123456), extended = 1, fields='city', progress_bar = TRUE)

## End(Not run)

Returns a list of community members

Description

Returns a list of community members

Usage

getGroupsMembers(
  group_id = "",
  sort = "",
  offset = "",
  count = "",
  fields = "",
  filter = "",
  v = getAPIVersion()
)

Arguments

Examples

## Not run: 
members <- getGroupsMembers(1, fields='sex,bdate,city')

## End(Not run)

Returns a list of community members

Description

Returns a list of community members

Usage

getGroupsMembersExecute(
  group_id = "",
  sort = "",
  offset = 0,
  count = 0,
  fields = "",
  filter = "",
  flatten = FALSE,
  progress_bar = FALSE,
  v = getAPIVersion()
)

Arguments

Examples

## Not run: 
members <- getGroupsMembersExecute(1, fields='sex,bdate,city', progress_bar = TRUE)

## End(Not run)

Returns a list of user IDs of the mutual friends of two users

Description

Returns a list of user IDs of the mutual friends of two users

Usage

getMutual(
  source_id = "",
  target_uid = "",
  target_uids = "",
  order = "",
  count = "",
  offset = "",
  v = getAPIVersion()
)

Arguments

Examples

## Not run: 
mutual_friends <- getMutual(target_uid=1)

## End(Not run)

Returns a list of user IDs of the mutual friends of two users

Description

Returns a list of user IDs of the mutual friends of two users

Usage

getMutualExecute(
  source_id = "",
  target_uid = "",
  target_uids = "",
  order = "",
  count = "",
  offset = "",
  progress_bar = FALSE,
  v = getAPIVersion()
)

Arguments

Examples

## Not run: 
mutual_friends <- getMutualExecute(target_uid=1)

## End(Not run)

Returns a list of paths between two users

Description

Returns a list of paths between two users

Usage

getPaths(source_id, target_id, are_friends = FALSE, max_depth = 5)

Arguments

Returns data required to show the status of a users and/or communities

Description

Returns data required to show the status of a users and/or communities

Usage

getStatus(
  users_ids = c(),
  groups_ids = c(),
  progress_bar = FALSE,
  v = getAPIVersion()
)

Arguments

Examples

## Not run: 
status.me <- getStatus()
status.friends <- getStatus(users_ids = getFriends()$items)
status.groups  <- getStatus(groups_ids = getGroups()$items)
status.friends_and_groups <- getStatus(users_ids = getFriends()$items,
 groups_ids = getGroups()$items, progress_bar = T)

## End(Not run)

Returns a list of topics on a community's discussion board

Description

Returns a list of topics on a community's discussion board

Usage

getTopics(
  group_id = "",
  topics_ids = "",
  order = "",
  offset = 0,
  count = 40,
  extended = 0,
  preview = 0,
  preview_length = 90,
  v = getAPIVersion()
)

Arguments

Returns a list of topics on a community's discussion board

Description

Returns a list of topics on a community's discussion board

Usage

getTopicsExecute(
  group_id = "",
  order = "",
  offset = 0,
  count = 40,
  preview = 0,
  preview_length = 90,
  use_db = FALSE,
  db_params = list(),
  progress_bar = FALSE,
  v = getAPIVersion()
)

Arguments

Extract URLs from messages

Description

Extract URLs from messages

Usage

getURLs(messages, message_body = FALSE)

Arguments

Returns detailed information on users

Description

Returns detailed information on users

Usage

getUsers(
  user_ids = "",
  fields = "",
  name_case = "nom",
  flatten = FALSE,
  v = getAPIVersion()
)

Arguments

Details

User object describes a user profile, contains the following fields:

• uid User ID

• first_name First name

• last_name Last name

• deactivated Returns if a profile is deleted or blocked. Gets the value deleted or banned. Keep in mind that in this case no additional fields are returned

• hidden: 1 Returns while operating without access_token if a user has set the "Who can see my profile on the Internet" -> "Only VK users" privacy setting. Keep in mind that in this case no additional fields are returned

• verified Returns 1 if the profile is verified, 0 if not

• blacklisted Returns 1 if a current user is in the requested user's blacklist

• sex User sex (1 - female; 2 - male; 0 - not specified)

• bdate User's date of birth. Returned as DD.MM.YYYY or DD.MM (if birth year is hidden). If the whole date is hidden, no field is returned

• city ID of the city specified on user's page in "Contacts" section. Returns city ID that can be used to get its name using places.getCityById method. If no city is specified or main information on the page is hidden for in privacy settings, then it returns 0

• country ID of the country specified on user's page in "Contacts" section. Returns country ID that can be used to get its name using places.getCountryById method. If no country is specified or main information on the page is hidden in privacy settings, then it returns 0

• home_town User's home town

• photo_50 Returns URL of square photo of the user with 50 pixels in width. In case user does not have a photo, http://vk.com/images/camera_c.gif is returned

• photo_100 Returns URL of square photo of the user with 100 pixels in width. In case user does not have a photo, http://vk.com/images/camera_b.gif is returned

• photo_200_orig Returns URL of user's photo with 200 pixels in width. In case user does not have a photo, http://vk.com/images/camera_a.gif is returned

• photo_200 Returns URL of square photo of the user with 200 pixels in width. If the photo was uploaded long time ago, there can be no image of such size and in this case the reply will not include this field

• photo_400_orig Returns URL of user's photo with 400 pixels in width. If user does not have a photo of such size, reply will not include this field

• photo_max Returns URL of square photo of the user with maximum width. Can be returned a photo both 200 and 100 pixels in width. In case user does not have a photo, http://vk.com/images/camera_b.gif is returned

• photo_max_orig Returns URL of user's photo of maximum size. Can be returned a photo both 400 and 200 pixels in width. In case user does not have a photo, http://vk.com/images/camera_a.gif is returned

• online Information whether the user is online. Returned values: 1 - online, 0 - offline. If user utilizes a mobile application or site mobile version, it returns online_mobile additional field that includes 1. With that, in case of application, online_app additional field is returned with application ID.

• lists Information about friend lists. Returns IDs of friend lists the user is member of, separated with a comma. The field is available for friends.get method only. To get information about ID and names of friend lists use friends.getLists method. If user is not a member of any friend list, then when accepting data in XML format the respective <user> node does not contain <lists> tag

• domain Page screen name. Returns a string with a page screen name (only subdomain is returned, like andrew). If not set, "id'+uid is returned, e.g. id35828305

• has_mobile Information whether the user's mobile phone number is available. Returned values: 1 - available, 0 - not available. We recommend you to use it prior to call of secure.sendSMSNotification method

• contacts Information about user's phone numbers. If data are available and not hidden in privacy settings, the following fields are returned (mobile_phone - user's mobile phone number (only for standalone applications); home_phone - user's additional phone number)

• site Returns a website address from a user profile

• education Information about user's higher education institution. The following fields are returned:

  • university University ID

  • university_name University name

  • faculty Faculty ID

  • faculty_name Faculty name

  • graduation Graduation year

• universities List of higher education institutions where user studied. Returns universities array with university objects with the following fields:

  • id University ID

  • country ID of the country the university is located in

  • city ID of the city the university is located in

  • name University name

  • faculty Faculty ID

  • faculty_name Faculty name

  • chair University chair ID

  • chair_name Chair name

  • graduation Graduation year

• schools List of schools where user studied in. Returns schools array with school objects with the following fields:

  • id School ID

  • country ID of the country the school is located in

  • city ID of the city the school is located in

  • name School name

  • year_from Year the user started to study

  • year_to Year the user finished to study

  • year_graduated Graduation year

  • class School class letter

  • speciality Speciality

  • type Type ID

  • type_str Type name

• status User status. Returns a string with status text that is in the profile below user's name

• last_seen Last visit date. Returns last_seen object with the following fields:

  • time Last visit date (in Unix time)

  • platform Type of the platform that used for the last authorization. See more at Using LongPoll server

• followers_count Number of user's followers

• common_count Number of common friends with a current user

• counters Number of various objects the user has. Can be used in users.get method only when requesting information about a user. Returns an object with fields:

  • albums Number of photo albums

  • videos Number of videos

  • audios Number of audios

  • notes Number of notes

  • friends Number of friends

  • groups Number of communities

  • online_friends Number of online friends

  • mutual_friends Number of mutual friends

  • user_videos Number of videos the user is tagged on

  • followers Number of followers

  • user_photos Number of photos the user is tagged on

  • subscriptions Number of subscriptions

• occupation Current user's occupation. Returns following fields:

  • type Can take the values: work, school, university

  • id ID of school, university, company group (the one a user works in)

  • name Name of school, university or work place

• nickname User nickname

• relatives Current user's relatives list. Returns a list of objects with id and type fields (name instead of id if a relative is not a VK user). type - relationship type. Possible values:

  • sibling

  • parent

  • child

  • grandparent

  • grandchild

• relation User relationship status. Returned values:

  • 1 - Single

  • 2 - In a relationship

  • 3 - Engaged

  • 4 - Married

  • 5 - It's complicated

  • 6 - Actively searching

  • 7 - In love

• personal Information from the "Personal views" section

  • political Political views:

    • 1 - Communist

    • 2 - Socialist

    • 3 - Moderate

    • 4 - Liberal

    • 5 - Conservative

    • 6 - Monarchist

    • 7 - Ultraconservative

    • 8 - Apathetic

    • 9 - Libertian

  • langs Languages

  • religion World view

  • inspired_by Inspired by

  • people_main Improtant in others:

    • 1 - Intellect and creativity

    • 2 - Kindness and honesty

    • 3 - Health and beauty

    • 4 - Wealth and power

    • 5 - Courage and persistance

    • 6 - Humor and love for life

  • life_main Personal priority:

    • 1 - Family and children

    • 2 - Career and money

    • 3 - Entertainment and leisure

    • 4 - Science and research

    • 5 - Improving the world

    • 6 - Personal development

    • 7 - Beauty and art

    • 8 - Fame and influence

  • smoking Views on smoking (1 - very negative; 2 - negative; 3 - neutral; 4 - compromisable; 5 - positive)

  • alcohol Views on alcohol (1 - very negative; 2 - negative; 3 - neutral; 4 - compromisable; 5 - positive)

• connections Returns specified services such as: skype, facebook, twitter, livejournal, instagram

• exports External services with export configured (twitter, facebook, livejournal, instagram)

• wall_comments Wall comments allowed(1 - allowed, 0 - not allowed)

• activities Activities

• interests Interests

• music Favorite music

• movies Favorite movies

• tv Favorite TV shows

• books Favorite books

• games Favorite games

• about "About me"

• quotes Favorite quotes

• can_post Can post on the wall: 1 - allowed, 0 - not allowed

• can_see_all_posts Can see other users' posts on the wall: 1 - allowed, 0 - not allowed

• can_see_audio Can see other users' audio on the wall: 1 - allowed, 0 - not allowed

• can_write_private_message Can write private messages to a current user: 1 - allowed, 0 - not allowed

• timezone user time zone. Retuns only while requesting current user info

• screen_name User page's screen name (subdomain)

Examples

## Not run: 
user <- getUsers('1', fields='sex,bdate,city')

## End(Not run)

Returns detailed information on arbitrary number of users

Description

Returns detailed information on arbitrary number of users

Usage

getUsersExecute(
  users_ids,
  fields = "",
  name_case = "nom",
  drop = FALSE,
  flatten = FALSE,
  use_db = FALSE,
  db_params = list(),
  progress_bar = FALSE,
  v = getAPIVersion()
)

Arguments

Details

User object describes a user profile, contains the following fields:

• uid User ID

• first_name First name

• last_name Last name

• deactivated Returns if a profile is deleted or blocked. Gets the value deleted or banned. Keep in mind that in this case no additional fields are returned

• hidden: 1 Returns while operating without access_token if a user has set the "Who can see my profile on the Internet" -> "Only VK users" privacy setting. Keep in mind that in this case no additional fields are returned

• verified Returns 1 if the profile is verified, 0 if not

• blacklisted Returns 1 if a current user is in the requested user's blacklist

• sex User sex (1 - female; 2 - male; 0 - not specified)

• bdate User's date of birth. Returned as DD.MM.YYYY or DD.MM (if birth year is hidden). If the whole date is hidden, no field is returned

• city ID of the city specified on user's page in "Contacts" section. Returns city ID that can be used to get its name using places.getCityById method. If no city is specified or main information on the page is hidden for in privacy settings, then it returns 0

• country ID of the country specified on user's page in "Contacts" section. Returns country ID that can be used to get its name using places.getCountryById method. If no country is specified or main information on the page is hidden in privacy settings, then it returns 0

• home_town User's home town

• photo_50 Returns URL of square photo of the user with 50 pixels in width. In case user does not have a photo, http://vk.com/images/camera_c.gif is returned

• photo_100 Returns URL of square photo of the user with 100 pixels in width. In case user does not have a photo, http://vk.com/images/camera_b.gif is returned

• photo_200_orig Returns URL of user's photo with 200 pixels in width. In case user does not have a photo, http://vk.com/images/camera_a.gif is returned

• photo_200 Returns URL of square photo of the user with 200 pixels in width. If the photo was uploaded long time ago, there can be no image of such size and in this case the reply will not include this field

• photo_400_orig Returns URL of user's photo with 400 pixels in width. If user does not have a photo of such size, reply will not include this field

• photo_max Returns URL of square photo of the user with maximum width. Can be returned a photo both 200 and 100 pixels in width. In case user does not have a photo, http://vk.com/images/camera_b.gif is returned

• photo_max_orig Returns URL of user's photo of maximum size. Can be returned a photo both 400 and 200 pixels in width. In case user does not have a photo, http://vk.com/images/camera_a.gif is returned

• online Information whether the user is online. Returned values: 1 - online, 0 - offline. If user utilizes a mobile application or site mobile version, it returns online_mobile additional field that includes 1. With that, in case of application, online_app additional field is returned with application ID.

• lists Information about friend lists. Returns IDs of friend lists the user is member of, separated with a comma. The field is available for friends.get method only. To get information about ID and names of friend lists use friends.getLists method. If user is not a member of any friend list, then when accepting data in XML format the respective <user> node does not contain <lists> tag

• domain Page screen name. Returns a string with a page screen name (only subdomain is returned, like andrew). If not set, "id'+uid is returned, e.g. id35828305

• has_mobile Information whether the user's mobile phone number is available. Returned values: 1 - available, 0 - not available. We recommend you to use it prior to call of secure.sendSMSNotification method

• contacts Information about user's phone numbers. If data are available and not hidden in privacy settings, the following fields are returned (mobile_phone - user's mobile phone number (only for standalone applications); home_phone - user's additional phone number)

• site Returns a website address from a user profile

• education Information about user's higher education institution. The following fields are returned:

  • university University ID

  • university_name University name

  • faculty Faculty ID

  • faculty_name Faculty name

  • graduation Graduation year

• universities List of higher education institutions where user studied. Returns universities array with university objects with the following fields:

  • id University ID

  • country ID of the country the university is located in

  • city ID of the city the university is located in

  • name University name

  • faculty Faculty ID

  • faculty_name Faculty name

  • chair University chair ID

  • chair_name Chair name

  • graduation Graduation year

• schools List of schools where user studied in. Returns schools array with school objects with the following fields:

  • id School ID

  • country ID of the country the school is located in

  • city ID of the city the school is located in

  • name School name

  • year_from Year the user started to study

  • year_to Year the user finished to study

  • year_graduated Graduation year

  • class School class letter

  • speciality Speciality

  • type Type ID

  • type_str Type name

• status User status. Returns a string with status text that is in the profile below user's name

• last_seen Last visit date. Returns last_seen object with the following fields:

  • time Last visit date (in Unix time)

  • platform Type of the platform that used for the last authorization. See more at Using LongPoll server

• followers_count Number of user's followers

• common_count Number of common friends with a current user

• counters Number of various objects the user has. Can be used in users.get method only when requesting information about a user. Returns an object with fields:

  • albums Number of photo albums

  • videos Number of videos

  • audios Number of audios

  • notes Number of notes

  • friends Number of friends

  • groups Number of communities

  • online_friends Number of online friends

  • mutual_friends Number of mutual friends

  • user_videos Number of videos the user is tagged on

  • followers Number of followers

  • user_photos Number of photos the user is tagged on

  • subscriptions Number of subscriptions

• occupation Current user's occupation. Returns following fields:

  • type Can take the values: work, school, university

  • id ID of school, university, company group (the one a user works in)

  • name Name of school, university or work place

• nickname User nickname

• relatives Current user's relatives list. Returns a list of objects with id and type fields (name instead of id if a relative is not a VK user). type - relationship type. Possible values:

  • sibling

  • parent

  • child

  • grandparent

  • grandchild

• relation User relationship status. Returned values:

  • 1 - Single

  • 2 - In a relationship

  • 3 - Engaged

  • 4 - Married

  • 5 - It's complicated

  • 6 - Actively searching

  • 7 - In love

• personal Information from the "Personal views" section

  • political Political views:

    • 1 - Communist

    • 2 - Socialist

    • 3 - Moderate

    • 4 - Liberal

    • 5 - Conservative

    • 6 - Monarchist

    • 7 - Ultraconservative

    • 8 - Apathetic

    • 9 - Libertian

  • langs Languages

  • religion World view

  • inspired_by Inspired by

  • people_main Improtant in others:

    • 1 - Intellect and creativity

    • 2 - Kindness and honesty

    • 3 - Health and beauty

    • 4 - Wealth and power

    • 5 - Courage and persistance

    • 6 - Humor and love for life

  • life_main Personal priority:

    • 1 - Family and children

    • 2 - Career and money

    • 3 - Entertainment and leisure

    • 4 - Science and research

    • 5 - Improving the world

    • 6 - Personal development

    • 7 - Beauty and art

    • 8 - Fame and influence

  • smoking Views on smoking (1 - very negative; 2 - negative; 3 - neutral; 4 - compromisable; 5 - positive)

  • alcohol Views on alcohol (1 - very negative; 2 - negative; 3 - neutral; 4 - compromisable; 5 - positive)

• connections Returns specified services such as: skype, facebook, twitter, livejournal, instagram

• exports External services with export configured (twitter, facebook, livejournal, instagram)

• wall_comments Wall comments allowed(1 - allowed, 0 - not allowed)

• activities Activities

• interests Interests

• music Favorite music

• movies Favorite movies

• tv Favorite TV shows

• books Favorite books

• games Favorite games

• about "About me"

• quotes Favorite quotes

• can_post Can post on the wall: 1 - allowed, 0 - not allowed

• can_see_all_posts Can see other users' posts on the wall: 1 - allowed, 0 - not allowed

• can_see_audio Can see other users' audio on the wall: 1 - allowed, 0 - not allowed

• can_write_private_message Can write private messages to a current user: 1 - allowed, 0 - not allowed

• timezone user time zone. Retuns only while requesting current user info

• screen_name User page's screen name (subdomain)

Examples

## Not run: 
random_ids <- sample(x=seq(1:10000000), size=10000, replace=FALSE)
users <- getUsersExecute(random_ids, fields='sex,bdate,city')

## End(Not run)

Returns a list of posts on a user wall or community wall

Description

Returns a list of posts on a user wall or community wall

Usage

getWall(
  owner_id = "",
  domain = "",
  offset = "",
  count = "",
  filter = "owner",
  extended = "",
  fields = "",
  v = getAPIVersion()
)

Arguments

Value

Returns a list of post objects. If extended is set to 1, also returns the following:

• wall - Contains a list of post objects.

• profiles - Contains user objects with additional fields photo and online.

• groups - Contains community objects.

Examples

## Not run: 
wall <- getWall(domain='spbrug', count=10, progress_bar=TRUE)

## End(Not run)

Returns a list of posts on a user wall or community wall

Description

Returns a list of posts on a user wall or community wall

Usage

getWallExecute(
  owner_id = "",
  domain = "",
  offset = 0,
  count = 10,
  filter = "owner",
  extended = "",
  fields = "",
  use_db = FALSE,
  db_params = list(),
  progress_bar = FALSE,
  v = getAPIVersion()
)

Arguments

Value

Returns a list of post objects. If extended is set to 1, also returns the following:

• wall - Contains a list of post objects.

• profiles - Contains user objects with additional fields photo and online.

• groups - Contains community objects.

Examples

## Not run: 
# get all posts from wall
wall <- getWallExecute(domain='spbrug', count=0, progress_bar=TRUE)

## End(Not run)

Get stop words list for russian language

Description

Get stop words list for russian language

Usage

get_stop_words(stop_words = c())

Arguments

Returns a list of communities matching the search criteria

Description

Returns a list of communities matching the search criteria

Usage

groupsSearch(
  q = "",
  type = "",
  country_id = "",
  city_id = "",
  future = 0,
  market = 0,
  sort = 0,
  offset = 0,
  count = 20,
  v = getAPIVersion()
)

Arguments

Captcha error handler

Description

Captcha error handler

Usage

handle_captcha(error)

Arguments

Validation error handler

Description

Validation error handler

Usage

handle_validation(error)

Arguments

Get error code from response

Description

Get error code from response

Usage

has_error(response)

Arguments

Returns a list of IDs of users who added the specified object to their Likes list

Description

Returns a list of IDs of users who added the specified object to their Likes list

Usage

likesGetList(
  type = "",
  owner_id = "",
  item_id = "",
  page_url = "",
  filter = "",
  friends_only = "0",
  extended = "",
  offset = "",
  count = "100",
  skip_own = 0,
  v = getAPIVersion()
)

Arguments

Returns a list of IDs of users who added the specified objects to their Likes list

Description

Returns a list of IDs of users who added the specified objects to their Likes list

Usage

likesGetListForObjects(
  objects,
  type = "post",
  filter = "likes",
  friends_only = 0,
  extended = 0,
  skip_own = 0,
  progress_bar = FALSE,
  v = getAPIVersion()
)

Arguments

Examples

## Not run: 
wall <- getWallExecute(domain = 'privivkanet', count = 10, progress_bar = TRUE)
post_likers <- likesGetListForObjects(wall, type = 'post', progress_bar = TRUE)
post_likers_extended <- likesGetListForObjects(wall, type = 'post',
   extended = 1, progress_bar = TRUE)

## End(Not run)

Returns current user ID

Description

Returns current user ID

Usage

me()

Returns a list of the current user's incoming or outgoing private messages

Description

Returns a list of the current user's incoming or outgoing private messages

Usage

messagesGet(
  out = "",
  offset = "",
  count = "",
  time_offset = "",
  filters = "",
  preview_length = "",
  last_message_id = "",
  v = getAPIVersion()
)

Arguments

Returns message history for the specified user or group chat

Description

Returns message history for the specified user or group chat

Usage

messagesGetHistory(
  offset = "",
  count = "",
  user_id = "",
  peer_id = "",
  start_message_id = "",
  rev = "",
  v = getAPIVersion()
)

Arguments

Returns all message history for the specified user or group chat

Description

Returns all message history for the specified user or group chat

Usage

messagesGetHistoryAll(user_id = "", peer_id = "", rev = 0, v = getAPIVersion())

Arguments

Returns message history for the specified user or group chat

Description

Returns message history for the specified user or group chat

Usage

messagesGetHistoryExecute(
  offset = 0,
  count = 0,
  user_id = "",
  peer_id = "",
  start_message_id = "",
  rev = 0,
  progress_bar = FALSE,
  v = getAPIVersion()
)

Arguments

Sends a message.

Description

Sends a message.

Usage

messagesSend(
  user_id,
  random_id = "",
  peer_id = "",
  domain = "",
  chat_id = "",
  user_ids = "",
  message = "",
  lat = "",
  long = "",
  attachment = "",
  forward_messages = "",
  sticker_id = "",
  v = getAPIVersion()
)

Arguments

Split messages by days, weeks, months

Description

Split messages by days, weeks, months

Usage

messagesSplitByDate(messages, format = "%y-%m-%d")

Arguments

Returns search results by statuses

Description

Returns search results by statuses

Usage

newsfeedSearch(
  q = "",
  extended = "",
  count = "",
  latitude = "",
  longitude = "",
  start_time = "",
  end_time = "",
  start_from = "",
  fields = "",
  v = getAPIVersion()
)

Arguments

Logical or operator

Description

Logical or operator

Usage

or(expr1, expr2)

Arguments

Returns a list of comments on a post on a user wall or community wall

Description

Returns a list of comments on a post on a user wall or community wall

Usage

postGetComments(
  owner_id = "",
  post_id = "",
  need_likes = 1,
  start_comment_id = "",
  offset = 0,
  count = 10,
  sort = "",
  preview_length = 0,
  extended = "",
  progress_bar = FALSE,
  v = getAPIVersion()
)

Arguments

Helper function for working with profile fields

Description

Helper function for working with profile fields

Usage

profile_fields(fields = "")

Arguments

Examples

## Not run: 
# get list of all fields
fields <- profile_fields('all')

# get list of all fields except specified
fields <- profile_fields('all - photo_50,photo_100,photo_200')

# get only specified fields
fields <- profile_fields('sex,bdate')

## End(Not run)

Returns a query string

Description

Returns a query string

Usage

queryBuilder(method_name, ...)

Arguments

Repeat last function call

Description

Repeat last function call

Usage

repeat_last_query(params = list(), n = 1)

Arguments

Delaying a request if necessary

Description

VK can accept maximum 3 requests to API methods per second from a client.

Usage

request_delay()

Converts the given igraph object to GEXF format and saves it at the given filepath location

Description

Converts the given igraph object to GEXF format and saves it at the given filepath location

Usage

saveAsGEXF(g, filepath = "converted_graph.gexf")

Arguments

Author(s)

Gopalakrishna Palem, Gopalakrishna.Palem@Yahoo.com

Allows the programmer to do a quick search for any substring

Description

Allows the programmer to do a quick search for any substring

Usage

search.getHints(
  q = "",
  limit = "",
  filters = "",
  search_global = "",
  v = getAPIVersion()
)

Arguments

Set API version

Description

Set API version

Usage

setAPIVersion(v)

Arguments

Set access token

Description

Set access token

Usage

setAccessToken(access_token = "")

Arguments

Set maximum number of repeats

Description

Set maximum number of repeats

Usage

setRepeats(n)

Arguments

Set timeout

Description

Set timeout

Usage

setTimeout(secs)

Arguments

Show collections

Description

Show collections

Usage

show_collections()

Show databases

Description

Show databases

Usage

show_dbs()

Returns user id by tag

Description

Returns user id by tag

Usage

tag2Id(tag)

Arguments

Check response for errors

Description

Check response for errors

Usage

try_handle_error(response)

Arguments

Try to handle network error

Description

Try to handle network error

Usage

try_handle_network_error(error)

Arguments

Switch database

Description

Switch database

Usage

use_db(db_name)

Arguments

Returns a list of IDs of followers of the user in question, sorted by date added, most recent first

Description

Returns a list of IDs of followers of the user in question, sorted by date added, most recent first

Usage

usersGetFollowers(
  user_id = "",
  offset = 0,
  count = 0,
  fields = "",
  name_case = "",
  drop = FALSE,
  flatten = FALSE,
  progress_bar = FALSE,
  v = getAPIVersion()
)

Arguments

Examples

## Not run: 
my_followers <- usersGetFollowers(me())

## End(Not run)

Returns a list of IDs of users and communities followed by the user

Description

Returns a list of IDs of users and communities followed by the user

Usage

usersGetSubscriptions(
  user_id = "",
  extended = "1",
  offset = 0,
  count = 0,
  fields = "",
  flatten = FALSE,
  progress_bar = FALSE,
  v = getAPIVersion()
)

Arguments

Examples

## Not run: 
my_subscriptions <- usersGetSubscriptions(me())

## End(Not run)

Returns a list of users matching the search criteria

Description

Returns a list of users matching the search criteria

Usage

usersSearch(
  q = "",
  sort = "",
  offset = "",
  count = "20",
  fields = "",
  city = "",
  country = "",
  hometown = "",
  university_country = "",
  university = "",
  university_year = "",
  university_faculty = "",
  university_chair = "",
  sex = "",
  status = "",
  age_from = "",
  age_to = "",
  birth_day = "",
  birth_month = "",
  birth_year = "",
  online = "",
  has_photo = "",
  school_country = "",
  school_city = "",
  school_class = "",
  school = "",
  school_year = "",
  religion = "",
  interests = "",
  company = "",
  position = "",
  group_id = "",
  from_list = "",
  flatten = FALSE,
  v = getAPIVersion()
)

Arguments

Apply a method over a vector of objects

Description

Returns a data frame of the same number of rows as length of 'objs', each element of which is the result of applying 'method' to the corresponding element of 'objs'

Usage

vkApply(objs, method)

Arguments

Examples

## Not run: 
 users <- vkApply(c("",1234567), function(user) getUsers(user, fields="sex"))
 countries <- vkApply(c(2,5122182,1906578), getCountryByCityId)

## End(Not run)

Client authorization

Description

Client authorization

Usage

vkOAuth(client_id, scope = "friends", email, password)

Arguments

Details

List of Available Settings of Access Permissions:

• friends Access to friends.

• photos Access to photos.

• audio Access to audios.

• video Access to videos.

• docs Access to documents.

• notes Access to user notes.

• pages Access to wiki pages.

• status Access to user status.

• wall Access to standard and advanced methods for the wall.

• groups Access to user groups.

• messages Access to advanced methods for messaging.

• notifications Access to notifications about answers to the user.

Examples

## Not run: 
# an example of an authenticated request
vkOAuth(client_id = 123456,
        scope = "friends,groups,messages",
        email = "your_email@example.com",
        password = "your_secret_password")

# save access token for future sessions
at <- getAccessToken()

# an example of request
me()

# an example of an authenticated request without specifying email and password
vkOAuth(client_id = 123456, scope = "friends,groups,messages")

# copy access token from browser address bar
setAccessToken("your_secret_access_token")

## End(Not run)

Client authorization (for web application)

Description

Client authorization (for web application)

Usage

vkOAuthWeb(app_name, client_id, client_secret)

Arguments

Create post object

Description

Create post object

Usage

vkPost(...)

Arguments

Access to VK API via R

Description

This package provides a series of functions that allow R users to access VK's API (https://vk.com/dev/methods) to get information about users, messages, groups, posts and likes.

Details

VK (https://vk.com/) is the largest European online social networking service, based in Russia. It is available in several languages, and is especially popular among Russian-speaking users. VK allows users to message each other publicly or privately, to create groups, public pages and events, share and tag images, audio and video, and to play browser-based games [1].

Author(s)

Dmitriy Sorokin dementiy@yandex.ru

References

[1] https://en.wikipedia.org/wiki/VK_(social_networking)

See Also

vkOAuth, getUsersExecute, getWallExecute, getFriends, getFriendsFor, getGroupsForUsers, getGroupsMembersExecute, likesGetListForObjects, messagesGetHistoryExecute, getArbitraryNetwork, getStatus

Custom error

Description

Custom error

Usage

vk_stop(message = "", call = sys.call(), error_code = "")

Arguments

Returns a list of posts from user or community walls by their IDs

Description

Returns a list of posts from user or community walls by their IDs

Usage

wallGetById(
  posts = "",
  extended = "",
  copy_history_depth = "",
  fields = "",
  v = getAPIVersion()
)

Arguments

Value

Returns a list of post objects. If extended is set to 1, returns the following:

• wall - Contains post objects.

• profiles - Contains user objects with additional fields sex, photo, photo_medium_rec, and online.

• groups - Contains community objects.

If the post is a copy of another post, returns an additional array copy_history with information about original posts.

Returns a list of comments on a post on a user wall or community wall

Description

Returns a list of comments on a post on a user wall or community wall

Usage

wallGetComments(
  owner_id = "",
  post_id = "",
  need_likes = "",
  start_comment_id = "",
  offset = "",
  count = "10",
  sort = "",
  preview_length = "0",
  extended = "",
  v = getAPIVersion()
)

Arguments

Returns a list of comments on a user wall or community wall

Description

Returns a list of comments on a user wall or community wall

Usage

wallGetCommentsList(posts, progress_bar = FALSE, v = getAPIVersion())

Arguments

Returns information about reposts of a post on user wall or community wall

Description

Returns information about reposts of a post on user wall or community wall

Usage

wallGetReposts(
  owner_id = "",
  post_id = "",
  offset = "",
  count = "20",
  v = getAPIVersion()
)

Arguments

Value

Returns an object containing the following fields:

• items - An array of wall reposts.

• profiles - Information about users with additional fields sex, online, photo, photo_medium_rec, and screen_name.

• groups - Information about communities.

Allows to search posts on user or community walls

Description

Allows to search posts on user or community walls

Usage

wallSearch(
  owner_id = "",
  domain = "",
  query = "",
  owners_only = "",
  count = "20",
  offset = "0",
  extended = "",
  fields = "",
  v = getAPIVersion()
)

Arguments

Value

If executed successfully, returns a list of post objects.