# @scalar/api-reference

> Generate beautiful API references from OpenAPI documents

Latest version **1.69.2** (published 2026-09-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install @scalar/api-reference
pnpm add @scalar/api-reference
yarn add @scalar/api-reference
bun add @scalar/api-reference
```

## Health

**Score 80/100 (A)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; recently updated; high maintenance score; high quality score; popular repo.

Warnings: low downloads; large bundle.

## Facts

| | |
|---|---|
| Version | 1.69.2 |
| Published | 2026-09-19 |
| First published | 2023-08-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=22 |
| Dependencies | 26 |
| Unpacked size | 39.9 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 16149 |
| Author | Scalar (https://github.com/scalar) |
| Maintainers | cameronrohani, marclave, scalar_geoff, hwkr, hanspagel, amritk, scalar-machine |
| Keywords | component, documentation, openapi, reference, spec, swagger, vue, vue3 |

## Links

- npm: https://www.npmjs.com/package/@scalar/api-reference
- Repository: https://github.com/scalar/scalar
- Issues: https://github.com/scalar/scalar/issues/new/choose
- npm.io page: https://npm.io/package/@scalar/api-reference

## Dependencies (26)

- [vue](https://npm.io/package/vue.md) ^3.5.40
- [yaml](https://npm.io/package/yaml.md) ^2.9.0
- [nanoid](https://npm.io/package/nanoid.md) ^5.1.6
- [fuse.js](https://npm.io/package/fuse.js.md) ^7.5.0
- [microdiff](https://npm.io/package/microdiff.md) ^1.5.0
- [@unhead/vue](https://npm.io/package/@unhead/vue.md) ^2.1.4
- [@vueuse/core](https://npm.io/package/@vueuse/core.md) 13.9.0
- [@scalar/icons](https://npm.io/package/@scalar/icons.md) 0.7.6
- [@scalar/types](https://npm.io/package/@scalar/types.md) 0.20.0
- [@scalar/blocks](https://npm.io/package/@scalar/blocks.md) 0.1.19
- [@scalar/themes](https://npm.io/package/@scalar/themes.md) 0.18.0
- [@headlessui/vue](https://npm.io/package/@headlessui/vue.md) 1.7.23
- [@scalar/helpers](https://npm.io/package/@scalar/helpers.md) 0.12.0
- [@scalar/schemas](https://npm.io/package/@scalar/schemas.md) 0.10.0
- [@scalar/sidebar](https://npm.io/package/@scalar/sidebar.md) 0.11.4
- [@scalar/snippetz](https://npm.io/package/@scalar/snippetz.md) 0.9.31
- [@scalar/oas-utils](https://npm.io/package/@scalar/oas-utils.md) 0.20.2
- [@scalar/use-hooks](https://npm.io/package/@scalar/use-hooks.md) 0.4.12
- [@scalar/agent-chat](https://npm.io/package/@scalar/agent-chat.md) 0.12.33
- [@scalar/api-client](https://npm.io/package/@scalar/api-client.md) 3.19.2
- [@scalar/components](https://npm.io/package/@scalar/components.md) 0.29.3
- [@scalar/use-toasts](https://npm.io/package/@scalar/use-toasts.md) 0.10.5
- [@scalar/validation](https://npm.io/package/@scalar/validation.md) 0.6.3
- [@scalar/localization](https://npm.io/package/@scalar/localization.md) 0.2.0
- [@scalar/code-highlight](https://npm.io/package/@scalar/code-highlight.md) 0.4.6
- [@scalar/workspace-store](https://npm.io/package/@scalar/workspace-store.md) 0.63.0

## Alternatives

- [@cantoo/pdf-lib](https://npm.io/package/@cantoo/pdf-lib.md) — 297.9K weekly downloads
- [datatables.net-buttons](https://npm.io/package/datatables.net-buttons.md) — 200.1K weekly downloads
- [@ckeditor/ckeditor5-export-pdf](https://npm.io/package/@ckeditor/ckeditor5-export-pdf.md) — 167.0K weekly downloads
- [scanbot-web-sdk](https://npm.io/package/scanbot-web-sdk.md) — 15.0K weekly downloads
- [@syncfusion/ej2-angular-pdfviewer](https://npm.io/package/@syncfusion/ej2-angular-pdfviewer.md) — 8.8K weekly downloads

## Recent versions

- 1.69.2 (latest) — 2026-09-19
- 1.10.4-alpha (alpha) — 2023-12-15
- 1.69.1 — 2026-09-18
- 1.69.0 — 2026-09-16
- 1.68.0 — 2026-09-07
- 1.67.0 — 2026-08-28
- 1.66.1 — 2026-08-20
- 1.65.1 — 2026-08-13
- 1.65.0 — 2026-08-13
- 1.64.1 — 2026-08-07
- 1.64.0 — 2026-07-31
- 1.63.0 — 2026-07-20
- 1.62.9 — 2026-07-16
- 1.62.8 — 2026-07-16
- 1.62.7 — 2026-07-15
- … 694 more at https://npm.io/package/@scalar/api-reference/versions

## README

# Scalar API Reference

[![Version](https://img.shields.io/npm/v/%40scalar/api-reference)](https://www.npmjs.com/package/@scalar/api-reference)
[![Downloads](https://img.shields.io/npm/dm/%40scalar/api-reference)](https://www.npmjs.com/package/@scalar/api-reference)
[![Hits on jsdelivr](https://img.shields.io/jsdelivr/npm/hm/%40scalar%2Fapi-reference)](https://www.jsdelivr.com/package/npm/@scalar/api-reference)
[![License](https://img.shields.io/npm/l/%40scalar%2Fapi-reference)](https://www.npmjs.com/package/@scalar/api-reference)
[![Discord](https://img.shields.io/discord/1135330207960678410?style=flat&color=5865F2)](https://discord.gg/scalar)

Interactive API Reference from OpenAPI/Swagger Documents [Try our Demo](https://docs.scalar.com/swagger-editor)

---

Scalar is an open-source API platform for teams who want beautiful developer interfaces without vendor lock-in.

- **[API References](https://scalar.com/products/api-references/getting-started)** — Interactive API documentation from OpenAPI and AsyncAPI specs.
- **[Developer Docs](https://scalar.com/products/docs/getting-started)** — Write in Markdown/MDX, generate API references, sync with two-way Git.
- **[SDK Generator](https://scalar.com/products/sdk-generator/getting-started)** — Type-safe SDKs and CLIs in TypeScript, Python, Go, PHP, Java, and Ruby.
- **[API Client](https://scalar.com/products/api-client/getting-started)** — Open-source, offline-first Postman alternative built on OpenAPI.

20M+ monthly npm installs · 15,500+ GitHub stars · MIT licensed · [scalar.com](https://scalar.com)

---

[![Screenshot of an API Reference](https://github.com/scalar/scalar/assets/6201407/d8beb5e1-bf64-4589-8cb0-992ba79215a8)](https://docs.scalar.com/swagger-editor)

### CDN

```html
<!doctype html>
<html>
  <head>
    <title>Scalar API Reference</title>
    <meta charset="utf-8" />
    <meta
      name="viewport"
      content="width=device-width, initial-scale=1" />
  </head>

  <body>
    <div id="app"></div>

    <!-- Load the Script -->
    <script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script>

    <!-- Initialize the Scalar API Reference -->
    <script>
      Scalar.createApiReference('#app', {
        // The URL of the OpenAPI/Swagger document
        url: 'https://registry.scalar.com/@scalar/apis/galaxy?format=json',
        // Avoid CORS issues
        proxyUrl: 'https://proxy.scalar.com',
      })
    </script>
  </body>
</html>
```

## Documentation

[Read the documentation here](https://scalar.com/products/api-references/integrations/html-js)

## Community

We are API nerds. You too? Let's chat on Discord: <https://discord.gg/scalar>

## License

The source code in this repository is licensed under [MIT](https://github.com/scalar/scalar/blob/main/LICENSE).

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