API Reference

API overview

The core API surface is defined by the Security Token Program instruction set.

Main instruction groups

GroupRepresentative instructions
Mint and metadataInitializeMint, UpdateMetadata
Verification configInitializeVerificationConfig, UpdateVerificationConfig, TrimVerificationConfig
Token lifecycleMint, Burn, Transfer, Pause, Resume, Freeze, Thaw
Corporate actionsCreateRateAccount, Split, Convert, CreateDistributionEscrow, ClaimDistribution
Proof and receiptsCreateProofAccount, UpdateProofAccount, receipt close instructions

Core account types

  • MintAuthority
  • VerificationConfig
  • Rate
  • Receipt
  • Proof

Virtual PDA authorities

  • distribution escrow authority
  • permanent delegate authority
  • pause authority
  • freeze authority
  • transfer-hook authority

Full reference

Use the full generated instruction reference page:

Previous
Issuer setup script