Metaplex Auction IDL

Metaplex Auction is the on-chain auction program for NFTs and digital assets on Solana. Manages English and open edition auctions with bid placement, cancellation, settlement, and prize claiming.

  • metaplex
  • v0.0.0
  • NFT / Digital Assets

Program address

auctxRXPeJoc4817jDhf4HbjnhEcr1cCXenosMhK5R8
A quiet stack of pagesAn abstract drawing of light on the page's dark ground. A neat stack of thin, solid pages, the top one lit, with faint streams of light drifting toward it from the left.A quiet stack of pagesAn abstract drawing of light on the page's dark ground. A neat stack of thin, solid pages, the top one lit, with faint streams of light drifting toward it from the left.
Instructions
8
Accounts
5
Events
0
Types
13

What the program exposes

Instructions 8

  • CancelBid
  • CreateAuction
  • ClaimBid
  • EndAuction
  • StartAuction
  • SetAuthority
  • PlaceBid
  • CreateAuctionV2

Accounts 5

  • PriceFloor
  • BidState
  • AuctionData
  • BidderMetadata
  • BidderPot

Use it in your code

Load the Metaplex Auction IDL with Anchor in TypeScript, Rust or Python.

import { Connection, PublicKey } from "@solana/web3.js";
import { Program, AnchorProvider, Idl } from "@coral-xyz/anchor";

// Load the Metaplex Auction IDL
import idl from "./metaplex auction.json";

const PROGRAM_ID = new PublicKey("auctxRXPeJoc4817jDhf4HbjnhEcr1cCXenosMhK5R8");

// Set up the provider and program
const connection = new Connection("https://api.mainnet-beta.solana.com");
const provider = new AnchorProvider(connection, wallet, {
  commitment: "confirmed",
});
const program = new Program(idl as Idl, provider);

// Fetch and decode an account
const accountData = await program.account.metaplex_Auction
  .fetch(accountPublicKey);
console.log("Account data:", accountData);

// Build and send an instruction
const tx = await program.methods
  .initialize(/* ...args */)
  .accounts({
    /* ...required accounts */
  })
  .rpc();
console.log("Transaction signature:", tx);

The JSON

The first 30 lines of metaplex auction.json.

metaplex auction.json
{
  "version": "0.0.0",
  "name": "auction",
  "docs": [],
  "ref": "https://github.com/metaplex-foundation/metaplex-program-library/blob/821e5aac0780fe45525dae72b9ad6f8dc2ba8e5b/auction/program/src/instruction.rs",
  "instructions": [
    {
      "name": "CancelBid",
      "docs": [
        "Cancel a bid on a running auction."
      ],
      "accounts": [
        {
          "name": "biddersPrimaryAccount",
          "isMut": false,
          "isSigner": true,
          "docs": [
            "The bidders primary account, for PDA calculation/transit auth."
          ]
        },
        {
          "name": "biddersTokenAccount",
          "isMut": true,
          "isSigner": false,
          "docs": [
            "The bidders token account they'll receive refund with"
          ]
        },
        {
          "name": "pot",
...

Frequently asked questions

What is the Metaplex Auction IDL?

The Metaplex Auction IDL (Interface Definition Language) is a JSON schema that describes the on-chain program interface for the Metaplex Auction smart contract on Solana. It defines all available instructions, account structures, events, and types needed to interact with the program. This one has 8 instructions, 5 account types, 0 events and 13 type definitions.

How do I use the Metaplex Auction IDL in my project?

You can use the Metaplex Auction IDL with Anchor framework clients in TypeScript (@coral-xyz/anchor), Rust (anchor-client), or Python (anchorpy). Download the JSON file, import it in your project, and use it to create a Program instance that can call instructions and decode accounts.

What is the Metaplex Auction program address on Solana?

The Metaplex Auction program is deployed at address auctxRXPeJoc4817jDhf4HbjnhEcr1cCXenosMhK5R8 on Solana mainnet.

What version of the Metaplex Auction IDL is this?

This is version 0.0.0 of the Metaplex Auction IDL. IDL versions follow program deployments and change as the protocol evolves, so check it against the program on-chain before you integrate.

Build on Metaplex Auction with AllenHark

Stream the program's accounts and transactions with Yellowstone gRPC, read its state over Solana RPC, or see its transactions before the block is built with ShredStream. To trade against it, try the trading bots or the PumpFun sniper.

Browse all Solana IDLs