/vk/users/search

POST /api/vk/users/search

Price: 1 credit

Search VK users (people) by a free-text query (name). Returns the top matching profiles with id, name, alias, avatar, sex, verified and city.

How to use it

Search VK people by name. Returns top matching user profiles (id, name, alias, image, sex, is_verified, city). Free-text query only; structured demographic filters are not available.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• query string required — People search query (name) (examples: "Durov"; minLength: 1)
• count integer required — Max number of results to return (examples: 20; min: 1)

Response

• @type string (default: "VkUser")
• id integer required
• name string nullable
• first_name string nullable
• last_name string nullable
• alias string nullable
• image string nullable
• is_verified boolean (default: false)
• is_closed boolean (default: false)
• is_online boolean (default: false)
• sex string nullable
• status string nullable
• about string nullable
• bdate string nullable
• city string nullable
• country string nullable
• home_town string nullable
• site string nullable
• occupation string nullable
• occupation_type string nullable
• relation string nullable
• interests string nullable
• activities string nullable
• music string nullable
• movies string nullable
• tv string nullable
• books string nullable
• games string nullable
• quotes string nullable
• personal object nullable
  • @type string (default: "VkUserPersonal")
  • political string nullable
  • religion string nullable
  • inspired_by string nullable
  • life_main string nullable
  • people_main string nullable
  • smoking string nullable
  • alcohol string nullable
  • langs array (default: [])
• career array (default: [])
  • @type string (default: "VkUserCareer")
  • group_id integer nullable
  • company string nullable
  • position string nullable
  • from_year integer nullable
  • until_year integer nullable
  • city_id integer nullable
• universities array (default: [])
  • @type string (default: "VkUserUniversity")
  • id integer nullable
  • name string nullable
  • faculty string nullable
  • chair string nullable
  • education_form string nullable
  • education_status string nullable
  • graduation_year integer nullable
  • city_id integer nullable
• schools array (default: [])
  • @type string (default: "VkUserSchool")
  • id string nullable
  • name string nullable
  • year_from integer nullable
  • year_to integer nullable
  • graduation_year integer nullable
  • speciality string nullable
  • class_letter string nullable
• relatives array (default: [])
  • @type string (default: "VkUserRelative")
  • relative_type string nullable
  • user_id integer nullable
  • name string nullable
• last_seen_at integer nullable
• follower_count integer nullable
• profile_url string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.