Universal.Figma.Client 1.0.1

Universal.Figma.Client

A complete C# client for the Figma REST API: files, nodes, images, comments, projects/folders, components/styles, webhooks, variables, dev resources, library analytics, and admin/enterprise endpoints (activity logs, developer logs, AI usage, payments), plus oEmbed.

Getting started

Construct with a personal access token (or OAuth token) — it's sent as the X-Figma-Token header on every request:

var client = new FigmaClient("YOUR_ACCESS_TOKEN");

Fetching a file

GetFileAsync returns the full document tree, fully typed - document is a polymorphic Node (check .Type, or pattern-match on the concrete subclass: FrameNode, TextNode, BooleanOperationNode, InstanceNode, etc.):

GetFileResponse file = await client.GetFileAsync("FILE_KEY", new GetFileQueryParams { Depth = 1 });

if (file.Document.Children[0] is CanvasNode canvas)
{
    foreach (Node node in canvas.Children)
    {
        Console.WriteLine($"{node.Type}: {node.Name}");
    }
}

GetFileNodesAsync returns the same node model for a specific set of node ids:

GetFileNodesResponse nodes = await client.GetFileNodesAsync("FILE_KEY", new GetFileNodesQueryParams
{
    Ids = new[] { "1:2" }
});

Rendering images

GetImagesAsync renders one or more nodes through Figma's own rendering pipeline and returns a URL per node (valid for 30 days):

GetImagesResponse images = await client.GetImagesAsync("FILE_KEY", new GetImagesQueryParams
{
    Ids = new[] { "1:2" },
    Format = ImageFormats.Png,
    Scale = 2
});

Beyond files

Every other documented Figma REST endpoint follows the same pattern - a query-params or request-body object in, a typed response out: comments, projects/folders, components/styles, webhooks, variables, dev resources, library analytics, and the org-admin endpoints (activity logs, developer logs, AI usage, payments).

Incoming webhook payloads (what Figma POSTs to your own endpoint) can be deserialized directly into the polymorphic WebhookPayload hierarchy (WebhookFileUpdatePayload, WebhookFileCommentPayload, etc.) via JsonConvert.DeserializeObject<WebhookPayload>(body).

Errors

Non-success responses throw Universal.Common.Net.Http.HttpException, carrying the status code and response body.