Skip to content
The reimagined Figma API (super)powered by GraphQL
TypeScript JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode
assets
docs
src
.all-contributorsrc
.eslintrc
.gitignore
.prettierignore
.prettierrc
.releaserc
.snyk
.travis.yml
CHANGELOG.md
LICENSE
README.md
commitlint.config.js
doczrc.js
jest.config.js
package.json
tsconfig.json
yarn.lock

README.md

figma-graphql

The reimagined Figma API (super)powered by GraphQL

Build Status Greenkeeper badge Code Coverage Known Vulnerabilities All Contributors PRs Welcome
Prettier format Commitizen friendly semantic-release MIT License

Quick start

Open figma-graphql

  1. Open figma-graphql sandbox and fork it

  2. Add your Figma API Token as FIGMA_TOKEN in the codesandbox secret keys

  3. Try your first query!

{
    file(id: "cLp23bR627jcuNSoBGkhL04E") {
        name
    }
}

Documentation

Please read the full documentation for additional examples and best practices.

Developing

  1. Clone this repo
  2. Run yarn install to install all dependencies
  3. Run FIGMA_TOKEN={YOUR_PERSONAL_FIGMA_TOKEN} yarn run dev or add it to an .env file
  4. The Figma GraphQL playground should be available at http://localhost:3001/

Figma file

This isn't really necessary but here's the base Figma file that is being used during development.

It should work with any file so can use your own Figma files and just replace file(id: "cLp23bR627jcuNSoBGkhL04E") with the id of the file you want to query.

Contributors

Thanks goes to these wonderful people (emoji key):

Bernardo Raposo
Bernardo Raposo

💬 💻 📖 🎨 🤔 👀 ⚠️
Sara Vieira
Sara Vieira

💻 📖 👀
Andrey Okonetchnikov
Andrey Okonetchnikov

📖 💻
Travis Arnold
Travis Arnold

📖

This project follows the all-contributors specification. Contributions of any kind welcome!

You can’t perform that action at this time.