Skip to main content


Looking for something specific? This page aims to guide you in your search by listing all the references associated with Candy Machines in one place.

If you’re looking for more advanced documentation on program accounts and instructions, we recommend checking out the following program documentation.

The following table provides relevant links to all Candy Machine specific libraries.

GitHub RepositoryPackage ManagerAPI References
JavaScript — Umi Library (recommended)metaplex-foundation/mpl-candy-machine@metaplex-foundation/mpl-candy-machineTypedoc References
JavaScript — SDKmetaplex-foundation/js@metaplex-foundation/jsCandyMachineClient, CandyMachineBuildersClient
JavaScript — Solita Library: Candy Machine Coremetaplex-foundation/mpl-candy-machine@metaplex-foundation/mpl-candy-machine-coreTypedoc References
JavaScript — Solita Library: Candy Guardmetaplex-foundation/mpl-candy-machine@metaplex-foundation/mpl-candy-guardTypedoc References
Rust Crate: Candy Machine Coremetaplex-foundation/ References
Rust Crate: Candy Guardmetaplex-foundation/ References