# @api.stream/sdk

> JavaScript client for accessing API.stream cloud services

Latest version **1.0.42** (published 2025-07-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install @api.stream/sdk
pnpm add @api.stream/sdk
yarn add @api.stream/sdk
bun add @api.stream/sdk
```

## Health

**Score 30/100 (F)** — status: maintenance-mode.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.42 |
| Published | 2025-07-08 |
| First published | 2022-04-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 17 |
| Unpacked size | 2.3 MB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Lightstream |
| Maintainers | api.stream-bot, luket, samirageb, hudbuddy, mkanter |
| Keywords | api.stream, api-stream, api stream, video, live, streaming, webrtc, rtmp, audio, camera, microphone, live streaming, live-streaming, compositor |

## Links

- npm: https://www.npmjs.com/package/@api.stream/sdk
- Repository: https://github.com/golightstream/api.stream-sdk
- Homepage: https://api.stream
- Issues: https://github.com/golightstream/api.stream-sdk/issues
- npm.io page: https://npm.io/package/@api.stream/sdk

## Dependencies (17)

- [ws](https://npm.io/package/ws.md) ^8.4.0
- [rxjs](https://npm.io/package/rxjs.md) ^7.5.5
- [uuid](https://npm.io/package/uuid.md) ^8.3.2
- [matcher](https://npm.io/package/matcher.md) ^4.0.0
- [@types/ws](https://npm.io/package/@types/ws.md) ^8.2.2
- [jwt-decode](https://npm.io/package/jwt-decode.md) ^3.1.2
- [detect-node](https://npm.io/package/detect-node.md) ^2.1.0
- [isomorphic-ws](https://npm.io/package/isomorphic-ws.md) ^4.0.1
- [nice-grpc-web](https://npm.io/package/nice-grpc-web.md) ^3.3.4
- [livekit-client](https://npm.io/package/livekit-client.md) ^0.15.2
- [typescript-logging](https://npm.io/package/typescript-logging.md) ^2.0.1
- [@api.stream/livekit-server-sdk](https://npm.io/package/@api.stream/livekit-server-sdk.md) ^0.5.7
- [@api.stream/protocol-event-api](https://npm.io/package/@api.stream/protocol-event-api.md) 1.0.4
- [typedoc-plugin-missing-exports](https://npm.io/package/typedoc-plugin-missing-exports.md) ^0.22.6
- [@api.stream/protocol-layout-api](https://npm.io/package/@api.stream/protocol-layout-api.md) 1.0.4
- [typescript-logging-category-style](https://npm.io/package/typescript-logging-category-style.md) ^2.0.1
- [@improbable-eng/grpc-web-node-http-transport](https://npm.io/package/@improbable-eng/grpc-web-node-http-transport.md) ^0.15.0

## Alternatives

- [byte-size](https://npm.io/package/byte-size.md) — 2.1M weekly downloads
- [speed-limiter](https://npm.io/package/speed-limiter.md) — 16.0K weekly downloads
- [@powersync/node](https://npm.io/package/@powersync/node.md) — 10.9K weekly downloads
- [@ledgerhq/coin-cardano](https://npm.io/package/@ledgerhq/coin-cardano.md) — 1.0K weekly downloads
- [@jayesol/jayeson.lib.streamfinder](https://npm.io/package/@jayesol/jayeson.lib.streamfinder.md) — 1.0K weekly downloads

## Recent versions

- 1.0.42 (latest) — 2025-07-08
- 1.0.24-alpha.3 (alpha) — 2023-10-31
- 1.0.41 — 2025-04-24
- 1.0.40 — 2025-04-24
- 1.0.39 — 2025-04-23
- 1.0.38 — 2024-08-29
- 1.0.37 — 2024-08-27
- 1.0.36 — 2024-08-27
- 1.0.35 — 2024-08-22
- 1.0.34 — 2024-07-11
- 1.0.33 — 2024-07-11
- 1.0.32 — 2024-07-01
- 1.0.31 — 2024-05-22
- 1.0.30 — 2024-05-22
- 1.0.29 — 2024-05-22
- … 33 more at https://npm.io/package/@api.stream/sdk/versions

## README

# JavaScript SDK
JavaScript client for interacting with the API.stream Live, Layout and Event APIs. This SDK supports running in both a browser context and server side within NodeJS.

[SDK Documentation](https://api.stream/docs/sdk/api/js/docs/)

## Getting started
```bash
npm install @api.stream/sdk
```

### Creating an authentication token
```ts
import { ApiStream } from '@api.stream/sdk';

const client = new ApiStream({ apiKey: 'your-api-key' });

const credentials = await client.LiveAPI().backendAuthentication?.createAccessToken({
	serviceUserId: 'test-user',
});

await client.load(credentials.accessToken);
```

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