Api.getFile(fileKey, opts?: { version?, geometry? })

Require file data with specified version.
Set geometry='paths' to export vector data.

Returns:

{
    name: string,
    lastModified: string,
    thumbnailURL: string,
    version: string,
    document: Node<'DOCUMENT'>,
    components: { [nodeId: string]: Component },
    schemaVersion: 0,
    styles: { [styleName: string]: Style }
}

Api.getFileNodes(fileKey, ids, opts?: { version?, geometry? })

Require file nodes data with specified version.
Set geometry='paths' to export vector data.

Returns:

{
    name: string,
    lastModified: string,
    thumbnailURL: string,
    err: string,
    nodes: {
        id: {
            document: Node<'DOCUMENT'>,
            components: { [nodeId: string]: Component },
            schemaVersion: 0,
            styles: { [styleName: string]: Style }
        }
    }
}

Api.getImage(fileKey, opts?: {
    /** A comma separated list of node IDs to render */
    ids: string,
    /** A number between 0.01 and 4, the image scaling factor */
    scale: number,
    /** Image output format */
    format: 'jpg'|'png'|'svg',
    /** Whether to include id attributes for all SVG elements. `Default: false` */
    svg_include_id?: boolean,
    /** Whether to simplify inside/outside strokes and use stroke attribute if possible instead of <mask>. `Default: true` */
    svg_simplify_stroke?: boolean,
    /** A specific version ID to get. Omitting this will get the current version of the file */
    version?: string,
})

Renders images from a file.

Returns:

{
    err: string,
    images: { [nodeId: string]: string|null },
    status: number
}

Api.getImageFills(fileKey)

Returns download links for all images present in image fills in a document.

Returns:

{
    images?: {
        [imageRef: string]: imageUrl,
    },
}

Api.getComments(fileKey)

List of comments left on the file.

Returns:

{
    comments: Comment[],
}

Api.postComment(fileKey: string, message: string, client_meta: Vector|FrameOffset)

Posts a new comment on the file with specified location.

Returns:

Comment

Api.getMe()

You can use the Users Endpoint to access information regarding the currently authenticated User. When using OAuth 2, the User in question must be authenticated through the Figma API to access their information.

Returns:

User

Api.getVersions(fileKey)

A list of the version history of a file. The version history consists of versions, manually-saved additions to the version history of a file.
If the account is not on a paid team, version history is limited to the past 30 days. Note that version history will not include autosaved versions.

Returns:

{
    versions: Version[]
}

Api.getTeamProjects(team_id)

Lists the projects for a specified team. Note that this will only return projects visible to the authenticated user or owner of the developer token.

Returns:

{
    projects: { id: number, name: string }[],
}

Api.getProjectFiles(project_id)

List the files in a given project.

Returns:

{
    files: {
        key: string,
        name: string,
        thumbnail_url: string,
        last_modified: string,
    }[],
}

Api.getTeamComponents(team_id, opts?: { page_size?, cursor? })

Get a paginated list of published components within a team library.

Returns:

{
    components: [
        /* ComponentMetadata */ {
            key: string,
            file_key: string,
            node_id: string,
            thumbnail_url: string,
            name: string,
            description: string,
            updated_at: string,
            created_at: string,
            user: User, 
            containing_frame: FrameInfo, 
        },
    ],
    cursor: { 
        before: number,
        after: number,
    },
}

Api.getComponent(componentKey)

Get metadata on a component by key.

Returns:

/* ComponentMetadata */ {
    key: string,
    file_key: string,
    node_id: string,
    thumbnail_url: string,
    name: string,
    description: string,
    updated_at: string,
    created_at: string,
    user: User, 
    containing_frame: FrameInfo, 
},

Api.getTeamStyles(team_id, opts?: { page_size?, cursor? })

Get a paginated list of published styles within a team library.

Returns:

{
    styles: [
        {
            key: string,
            file_key: string,
            node_id: string,
            style_type: StyleType,
            thumbnail_url: string,
            name: string,
            description: string,
            updated_at: string,
            created_at: string,
            sort_position: string,
            user: User, 
        },
    ],
        cursor: { 
        before: number,
        after: number,
    }, 
}

Api.getStyle(styleKey)

Get metadata on a style by key.

Returns:

{
    key: string,
    file_key: string,
    node_id: string,
    style_type: StyleType,
    thumbnail_url: string,
    name: string,
    description: string,
    updated_at: string,
    created_at: string,
    sort_position: string,
    user: User, 
}

Api.appendHeaders(headers: {}): void
Populate headers with auth.

Api.request<T>(url, opts): Promise<T>
Make request with auth headers.

isEffectShadow(effect: Effect): effect is EffectShadow;

Check if effect is one of shadow effects.

isEffectBlur(effect: Effect): effect is EffectBlur;

Check if effect is one of blur effects.

isPaintSolid(paint: Paint): paint is PaintSolid;
isPaintGradient(paint: Paint): paint is PaintGradient;
isPaintImage(paint: Paint): paint is PaintImage;

Check if paint is one of pain types.

isNodeType<NodeType>(node: Node): node is type of NodeType;

Check if node is type of specified node.