API References for Core Candy Machine
Last updated March 10, 2026
Summary
The Core Candy Machine API references provide auto-generated documentation for the JavaScript SDK (via TypeDoc) and the Rust crates (via docs.rs).
- JavaScript SDK documentation covers all instructions, accounts, and types
- Rust documentation is split across the Candy Machine Core crate and the Candy Guard crate
- Source code is available on GitHub for direct inspection
Quick Reference
| Resource | Link |
|---|---|
| JS SDK TypeDoc | mpl-core-candy-machine.typedoc.metaplex.com |
| Rust Candy Machine Core | docs.rs/mpl-core-candy-machine-core |
| Rust Candy Guard | docs.rs/mpl-core-candy-guard |
| Source Code | GitHub |
JavaScript SDK Reference
The TypeDoc documentation covers all exported functions, types, and accounts in the @metaplex-foundation/mpl-core-candy-machine package.
Rust Crate References
The Rust API documentation is split between two crates:
- mpl-core-candy-machine-core -- covers Candy Machine creation, configuration, and asset management
- mpl-core-candy-guard -- covers guard creation, configuration, and minting condition enforcement