# framer-api

Latest version **5.1.0** (published 2026-09-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install framer-api
pnpm add framer-api
yarn add framer-api
bun add framer-api
```

## Health

**Score 70/100 (B)** — status: active.

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

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 5.1.0 |
| Published | 2026-09-24 |
| First published | 2025-11-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=22 |
| Dependencies | 2 |
| Unpacked size | 448.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | framerjs-owner, lempsink, motifus, koenrh, shuangq, melirofman, iamakulov, hunterhcaron, tom-james-watson, serhii.havrylenko, triozer-framer, niekert1, kaloyanvi, tomht-framer, djovanni-framer, matej-framer, elmarburke, erikbooijfr, framergeorge, coobaha_ |

## Links

- npm: https://www.npmjs.com/package/framer-api
- npm.io page: https://npm.io/package/framer-api

## Dependencies (2)

- [devalue](https://npm.io/package/devalue.md) ^5.8.1
- [std-env](https://npm.io/package/std-env.md) ^4.0.0

## Recent versions

- 5.1.0 (latest) — 2026-09-24
- 5.0.1-alpha.6 (alpha) — 2026-09-16
- 0.1.30-beta.0 (beta) — 2026-08-17
- 0.0.1-nightly.20260121115836 (nightly) — 2026-01-21
- 5.0.1-alpha.5 — 2026-09-15
- 5.0.1-alpha.4 — 2026-09-14
- 5.0.1-alpha.3 — 2026-09-14
- 5.0.1-alpha.2 — 2026-09-10
- 5.0.0 — 2026-09-08
- 0.1.31-alpha.1 — 2026-09-02
- 0.1.31-alpha.0 — 2026-08-27
- 0.1.30 — 2026-08-25
- 0.1.30-alpha.4 — 2026-08-13
- 0.1.30-alpha.3 — 2026-08-12
- 0.1.30-alpha.2 — 2026-08-12
- … 50 more at https://npm.io/package/framer-api/versions

## README

<h1 align="center" margin="0">
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="https://misc.framerstatic.com/framer-api/package-logo-light.svg">
    <source media="(prefers-color-scheme: light)" srcset="https://misc.framerstatic.com/framer-api/package-logo.svg">
    <img alt="Framer Server API" src="https://misc.framerstatic.com/framer-api/package-logo.svg" width="200">
  </picture>
</h1>
<h3 align="center" style="margin: 0;">
Programmatically interact with Framer projects.
</h3>

<br>

![server-api](https://misc.framerstatic.com/framer-api/server-api-header.png)

```bash
npm install framer-api
```

## Compatibility

Works with any modern JavaScript runtime.

- Node.js 22+
- Bun 1.1+
- Deno 1.4+
- Cloudflare Workers

## Getting Started

1. Open your project in Framer
2. Open settings (Cmd+K → "open settings")
3. Find the "API Keys" section
4. Create and copy your API key

Set the `FRAMER_API_KEY` environment variable, or pass it as the second argument to `connect()`.

## Quick Start

```typescript
import { connect } from "framer-api"

const framer = await connect("https://framer.com/projects/Website--aabbccdd1122")

const info = await framer.getProjectInfo()

await framer.disconnect()
```

With Node.js 24+ or Bun 1.3+, use `using` for automatic cleanup:

```typescript
using framer = await connect(projectUrl)
```

## Documentation

- [Introduction](https://www.framer.com/developers/server-api-introduction)
- [Quick Start](https://www.framer.com/developers/server-api-quick-start)
- [Reference](https://www.framer.com/developers/server-api-reference)
- [FAQ](https://www.framer.com/developers/server-api-faq)
- [Examples](https://github.com/framer/server-api-examples)

## Feedback

Have questions or feedback? Email us at <server-api-feedback@framer.com>

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