# @openscreen/sdk

> Generate Unique, Dynamic and trackable QR Codes at scale with Openscreen SDK

Latest version **1.7.1** (published 2026-01-29) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @openscreen/sdk
pnpm add @openscreen/sdk
yarn add @openscreen/sdk
bun add @openscreen/sdk
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 1.7.1 |
| Published | 2026-01-29 |
| First published | 2021-07-24 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 1.9 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Openscreen Inc. |
| Maintainers | farhan.zare, openscreen_nimish, aaronm30, abigaylehickey |
| Keywords | qr, qrcode, qr-code, QR Code, QR Code Generator, barcode, node.js |

## Links

- npm: https://www.npmjs.com/package/@openscreen/sdk
- Repository: https://github.com/openscreen-inc/openscreen-sdk-js
- Homepage: https://github.com/openscreen-inc/openscreen-sdk-js#readme
- Issues: https://github.com/openscreen-inc/openscreen-sdk-js/issues
- npm.io page: https://npm.io/package/@openscreen/sdk

## Dependencies (3)

- [axios](https://npm.io/package/axios.md) ^1.12.2
- [cookie](https://npm.io/package/cookie.md) ^1.0.2
- [axios-cookiejar-support](https://npm.io/package/axios-cookiejar-support.md) ^6.0.4

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 1.7.1 (latest) — 2026-01-29
- 1.6.0 — 2023-07-28
- 1.5.0 — 2023-05-19
- 1.4.0 — 2023-03-01
- 1.3.1 — 2023-02-21
- 1.3.0 — 2023-01-31
- 1.2.1 — 2022-11-22
- 1.2.0 — 2022-10-21
- 1.1.0 — 2022-09-14
- 1.0.1 — 2022-08-23
- 1.0.0 — 2022-08-11
- 0.9.0 — 2022-06-23
- 0.8.2 — 2022-05-25
- 0.8.1 — 2022-05-13
- 0.8.0 — 2022-05-13
- … 15 more at https://npm.io/package/@openscreen/sdk/versions

## README

# Openscreen Node SDK

[Openscreen][OSC] is a software developer platform that allows users to easily generate unique and trackable
QR Codes at scale using our Node SDK.

Additional information on using the Node SDK can be found in our developer
[documentation][DOCS].

## Requirements

- [NodeJS](https://nodejs.org) & [NPM](https://www.npmjs.com)
- An [Openscreen][OSC] account

If you don't already have an Openscreen account, you can sign up for a free account [here](https://app.openscreen.com/signup).

## Installation / Usage

```bash
npm install @openscreen/sdk
# or using Yarn
yarn add @openscreen/sdk
```

### CommonJS

```javascript
const {Openscreen} = require('@openscreen/sdk')
```

### ES6 & TypeScript

```javascript
import {Openscreen} from '@openscreen/sdk'
```

## Getting Started

Openscreen authenticates your API requests using your account's API key and API secret key. You will
also need the ID of the project you wish to work with. Your API key, secret key and project ID can
all be found in your by logging into your Openscreen [dashboard][DASH]. The following examples
demonstrates how to use these values in the SDK to generate your first QR code.

```javascript
const {Openscreen} = require('@openscreen/sdk')

const PROJECT_ID = '**PROJECT_ID**'

const os = new Openscreen().config({
  key: '**KEY**',
  secret: '**SECRET**',
})


async function myFirstQRCode(event) {
  const res = await os
    .project(PROJECT_ID)
    .assets()
    .create({
      name: 'Openscreen website',
      description: 'Dynamic QR code to https://openscreen.com',
      qrCodes: [
        {
          intent: 'https://openscreen.com',
          intentType: 'DYNAMIC_REDIRECT',
        },
      ],
    })

  const [qrCode] = res.asset.qrCodes

  await os.saveQrImageDataToFile(qrCode, 'my-first-qr.png')
}

myFirstQRCode().catch(console.error)
```

## Links

- [Openscreen website][OSC]
- [Developer Documentation][DOCS]
- [Additional Examples and Use Cases][TUTORIALS]

[OSC]: https://openscreen.com
[DASH]: https://app.openscreen.com
[TUTORIALS]: https://docs.openscreen.com/tutorials/
[DOCS]: https://docs.openscreen.com/overview/

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