usersSearch {vkR}

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

q

Search query string (e.g., Vasya Babich)

sort

Sort order: 1 - by date registered; 0 - by rating

offset

Offset needed to return a specific subset of users

count

Number of users to return

fields

Profile fields to return

city

City ID

country

Country ID

hometown

City name in a string

university_country

ID of the country where the user graduated

university

ID of the institution of higher education

university_year

Year of graduation from an institution of higher education

university_faculty

Faculty ID

university_chair

Chair ID

sex

1 - female; 2 - male; 0 - any (default)

status

Relationship status: 1 - Not married; 2 - In a relationship; 3 - Engaged; 4 - Married; 5 - It's complicated; 6 - Actively searching; 7 - In love

age_from

Minimum age

age_to

Maximum age

birth_day

Day of birth

birth_month

Month of birth

birth_year

Year of birth

online

1 - online only; 0 - all users

has_photo

1 - with photo only; 0 - all users

school_country

ID of the country where users finished school

school_city

ID of the city where users finished school

school_class

Positive number

school

ID of the school

school_year

School graduation year

religion

Users' religious affiliation

interests

Users' interests

company

Name of the company where users work

position

Job position

group_id

ID of a community to search in communities

from_list

List of comma-separated words

flatten

Automatically flatten nested data frames into a single non-nested data frame

v

Version of API