figma-graphql

The reimagined Figma API (super)powered by GraphQL

Quick start

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 💬 💻 📖 🎨 🤔 👀 ⚠️

Sara Vieira 💻 📖 👀

Andrey Okonetchnikov 📖 💻

Travis Arnold 📖

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