Programmatically interact with Framer projects.

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

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:

using framer = await connect(projectUrl)

Documentation

• Introduction
• Quick Start
• Reference
• FAQ
• Examples

Feedback

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