# @metaplex-foundation/mpl-token-metadata

> JavaScript client for Token Metadata

Latest version **3.4.0** (published 2025-02-02) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @metaplex-foundation/mpl-token-metadata
pnpm add @metaplex-foundation/mpl-token-metadata
yarn add @metaplex-foundation/mpl-token-metadata
bun add @metaplex-foundation/mpl-token-metadata
```

## Health

**Score 35/100 (D)** — status: maintenance-mode.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.4.0 |
| Published | 2025-02-02 |
| First published | 2021-12-03 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 1.5 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 27 |
| Author | Metaplex Maintainers |
| Maintainers | nhanphan, brandontulsi, svc01-metaplex, danenbm, blockiosaurus |

## Links

- npm: https://www.npmjs.com/package/@metaplex-foundation/mpl-token-metadata
- Repository: https://github.com/metaplex-foundation/mpl-candy-guard
- Homepage: https://metaplex.com
- Issues: https://github.com/metaplex-foundation/mpl-candy-guard/issues
- npm.io page: https://npm.io/package/@metaplex-foundation/mpl-token-metadata

## Dependencies (1)

- [@metaplex-foundation/mpl-toolbox](https://npm.io/package/@metaplex-foundation/mpl-toolbox.md) ^0.10.0

## Recent versions

- 3.4.0 (latest) — 2025-02-02
- 3.2.0-alpha.0 (alpha) — 2023-12-29
- 2.7.0-beta.2 (beta) — 2023-01-24
- 1.2.1 (1.2.1) — 2022-02-02
- 3.3.0 — 2024-11-07
- 3.2.1 — 2024-03-05
- 3.2.0 — 2024-02-02
- 3.1.3 — 2024-02-01
- 3.1.2 — 2023-12-13
- 3.1.1 — 2023-11-18
- 3.1.0 — 2023-09-21
- 3.0.0 — 2023-09-03
- 3.0.0-alpha.27 — 2023-09-03
- 3.0.0-alpha.26 — 2023-08-29
- 3.0.0-alpha.25 — 2023-08-29
- … 68 more at https://npm.io/package/@metaplex-foundation/mpl-token-metadata/versions

## README

# JavaScript client for Mpl Token Metadata

A Umi-compatible JavaScript library for Token Metadata.

## Getting started

1. First, if you're not already using Umi, [follow these instructions to install the Umi framework](https://github.com/metaplex-foundation/umi/blob/main/docs/installation.md).
2. Next, install this library using the package manager of your choice.
   ```sh
   npm install @metaplex-foundation/mpl-token-metadata
   ```
2. Finally, register the library with your Umi instance like so.
   ```ts
   import { mplTokenMetadata } from '@metaplex-foundation/mpl-token-metadata';
   umi.use(mplTokenMetadata());
   ```

You can learn more about this library's API by reading its generated [TypeDoc documentation](https://mpl-token-metadata-js-docs.vercel.app).

## Contributing

Check out the [Contributing Guide](./CONTRIBUTING.md) the learn more about how to contribute to this library.

---
_Source: https://npm.io/package/@metaplex-foundation/mpl-token-metadata · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._