# vk-io

> Modern VK API SDK for Node.js

Latest version **4.10.1** (published 2025-10-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install vk-io
pnpm add vk-io
yarn add vk-io
bun add vk-io
```

## Health

**Score 55/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 4.10.1 |
| Published | 2025-10-31 |
| First published | 2016-01-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=12.20.0 |
| Dependencies | 7 |
| Unpacked size | 1.2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 566 |
| Author | Vladlen |
| Maintainers | negezor |
| Keywords | vk, api, sdk, bot, node, js, es6, es7 |

## Links

- npm: https://www.npmjs.com/package/vk-io
- Repository: https://github.com/negezor/vk-io
- Homepage: https://github.com/negezor/vk-io#readme
- Issues: https://github.com/negezor/vk-io/issues
- npm.io page: https://npm.io/package/vk-io

## Dependencies (7)

- [debug](https://npm.io/package/debug.md) ^4.4.3
- [node-fetch](https://npm.io/package/node-fetch.md) ^3.3.2
- [inspectable](https://npm.io/package/inspectable.md) ^2.1.0
- [formdata-node](https://npm.io/package/formdata-node.md) ^4.4.1
- [middleware-io](https://npm.io/package/middleware-io.md) ^2.8.1
- [abort-controller](https://npm.io/package/abort-controller.md) ^3.0.0
- [form-data-encoder](https://npm.io/package/form-data-encoder.md) ^1.7.2

## Alternatives

- [@mapbox/jsonlint-lines-primitives](https://npm.io/package/@mapbox/jsonlint-lines-primitives.md) — 5.3M weekly downloads
- [reftools](https://npm.io/package/reftools.md) — 3.5M weekly downloads
- [@hey-api/openapi-ts](https://npm.io/package/@hey-api/openapi-ts.md) — 3.5M weekly downloads
- [@mapbox/geojson-rewind](https://npm.io/package/@mapbox/geojson-rewind.md) — 2.4M weekly downloads
- [turbo-stream](https://npm.io/package/turbo-stream.md) — 1.7M weekly downloads

## Recent versions

- 4.10.1 (latest) — 2025-10-31
- 4.10.0 — 2025-09-23
- 4.9.1 — 2024-01-11
- 4.9.0 — 2024-01-09
- 4.8.3 — 2023-04-02
- 4.8.2 — 2023-03-31
- 4.8.1 — 2023-01-22
- 4.8.0 — 2023-01-22
- 4.7.0 — 2022-09-05
- 4.6.0 — 2022-05-31
- 4.5.2 — 2022-03-15
- 4.5.1 — 2022-03-08
- 4.5.0 — 2022-02-23
- 4.4.0 — 2021-09-08
- 4.3.2 — 2021-07-06
- … 113 more at https://npm.io/package/vk-io/versions

## README

<p align="center"><img src="https://raw.githubusercontent.com/negezor/vk-io/master/docs/logo.svg?sanitize=true"></p>
<p align="center">
<a href="https://www.npmjs.com/package/vk-io"><img src="https://img.shields.io/npm/v/vk-io.svg?style=flat-square" alt="NPM version"></a>
<a href="https://github.com/negezor/vk-io/actions/workflows/tests.yml"><img src="https://img.shields.io/github/actions/workflow/status/negezor/vk-io/tests.yml?style=flat-square" alt="Build Status"></a>
<a href="https://www.npmjs.com/package/vk-io"><img src="https://img.shields.io/npm/dt/vk-io.svg?style=flat-square" alt="NPM downloads"></a>
</p>

> **VK-IO** - This is a powerful [Node.js](https://nodejs.org) module that allows you to easily interact with the VK API 🚀

| 📖 [Documentation](https://negezor.github.io/vk-io/) | 🤖 [Examples](docs/examples/) |
| ---------------------------------------------------- | ----------------------------- |

## Features

1. **Complete.** `100%` coverage of the VK API
2. **Simple.** Predictable abstraction of VK API. 1 to 1 mapping of API method
   ```javascript
   vk.api.users.get({...})
   ```
3. **Reliable.** The library is written in **TypeScript** and covered by tests.
4. **Modern.** The library comes with native ESM support
5. **Powerful.** Supports following additional features:
   - **Proxy** support via Custom Agents;
   - Automatic **request parallelization** for processing massive amounts of requests to API;
   - User [Authorization](./packages/authorization/README.md) (even with login and password);
   - [Ecosystem for bot development](#useful-modules-that-may-be-useful-to-you).

## 📦 Installation

> **[Node.js](https://nodejs.org/) 12.20.0 or newer is required**

- **Using `npm`** (recommended)
  ```shell
  npm i vk-io
  ```
- **Using `Yarn`**
  ```shell
  yarn add vk-io
  ```
- **Using `pnpm`**
  ```shell
  pnpm add vk-io
  ```

## Example usage

```javascript
import { VK } from 'vk-io';

const vk = new VK({
    token: process.env.TOKEN
});

async function run() {
    const response = await vk.api.wall.get({
        owner_id: 1
    });

    console.log(response);
}

run().catch(console.log);
```

## Community

### Useful modules that may be useful to you

- [@vk-io/authorization](https://github.com/negezor/vk-io/tree/master/packages/authorization): Authorization by login & password, and etc...
- [@vk-io/streaming](https://github.com/negezor/vk-io/tree/master/packages/streaming): Receiving data with Streaming API
- [@vk-io/session](https://github.com/negezor/vk-io/tree/master/packages/session): Simple implementation of the sessions
- [@vk-io/scenes](https://github.com/negezor/vk-io/tree/master/packages/scenes): Simple implementation of middleware-based scene management
- [@vk-io/hear](https://github.com/negezor/vk-io/tree/master/packages/hear): Simple implementation of the hears
- [vk-io-question](https://github.com/fakemancat/vk-io-question): Simple promise-based prompt
- [vk-io-pages](https://github.com/MrZillaGold/vk-io-pages): Dynamic pages pagination module
- [henta](https://github.com/u14-team/henta): Simple VK bot engine
- [vk-io-redis-storage](https://github.com/xtcry/vk-io-redis-storage): Simple storage add-on for [@vk-io/session](packages/session)
- [nestjs-vk](https://github.com/xtcry/nestjs-vk): Module for [NestJS](https://github.com/nestjs/nest)

> If you want to add your module in the list, create a [new issue](https://github.com/negezor/vk-io/issues/new) in the repository.

---
_Source: https://npm.io/package/vk-io · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._