# @vkontakte/api-schema-typescript

> TypeScript typings for VK API

Latest version **1.5199.0** (published 2025-05-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install @vkontakte/api-schema-typescript
pnpm add @vkontakte/api-schema-typescript
yarn add @vkontakte/api-schema-typescript
bun add @vkontakte/api-schema-typescript
```

## Health

**Score 45/100 (D)** — status: stable.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 1.5199.0 |
| Published | 2025-05-26 |
| First published | 2020-12-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 845.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 11 |
| Author | VK Team |
| Maintainers | vkcom-publisher, vkarelin |

## Links

- npm: https://www.npmjs.com/package/@vkontakte/api-schema-typescript
- Repository: https://github.com/VKCOM/api-schema-typescript
- npm.io page: https://npm.io/package/@vkontakte/api-schema-typescript

## Recent versions

- 1.5199.0 (latest) — 2025-05-26
- 1.5131.2 — 2021-09-15
- 1.5131.1 — 2021-07-15
- 1.5131.0 — 2021-07-08
- 0.5131.1 — 2021-07-08
- 0.5131.0 — 2021-07-08
- 0.5130.0 — 2021-02-18
- 0.5126.1 — 2021-01-13
- 0.5126.0 — 2020-12-28
- 0.0.2 — 2020-12-21
- 0.0.1 — 2020-12-21

## README

# VK API Schema Typescript

This repository contains prebuilt TypeScript typings for [VK API Schema](https://github.com/VKCOM/vk-api-schema).
The generation is performed with [VKCOM/api-schema-typescript-generator](https://github.com/VKCOM/api-schema-typescript-generator).

## Current API version – **5.199**

The package versions will follow API versions. It means that for **5.199** API version the package version will be **\*.5199.\***.

## Install

```
yarn add @vkontakte/api-schema-typescript
```

```
npm i --save @vkontakte/api-schema-typescript
```

## Usage

You can import params, responses, and objects from the library.

```typescript
import {
  MessagesGetByIdParams,           // Method params
  MessagesGetByIdExtendedResponse, // Response interface
  MessagesMessage,                 // Any object
} from '@vkontakte/api-schema-typescript';

const params: MessagesGetByIdParams = {
  message_ids: [1, 2, 3].join(','),
  extended: 1,
};

apiRequest('messages.getById', params).then((response: MessagesGetByIdExtendedResponse) => {
  response.items.forEach((message) => {
    if (message.out) {

    }
  });
});
```

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