Unlist Listing

How to remove an NFT listing from the Wayup Marketplace

Introduction

This guide demonstrates how to remove (unlist) an existing NFT listing from the Wayup Marketplace using the API. This returns the NFT to the seller's wallet and removes it from sale on the marketplace.

Requirements

• The Policy ID of the NFT you've listed

• The txHashIndex of your existing listing

• UTXOs from your wallet to fund the transaction

• Your change address to receive the unlisted NFT and any change

API Request Structure

Configuration

// API endpoint for Wayup Marketplace
const BASE_URL = "https://prod.api.ada-anvil.app/marketplace/api";

// NFT listing to unlist
const POLICY_ID = "6fb0ce0d80bce539333b0b16f4a29a0d40c786249f86850d3a36fa01";
const TX_HASH_INDEX = "4baa167631a62343cc4f37f9313ee05d6149b1fda39fd563e12832c8dd49fac9#0"; // Format: txHash#outputIndex

// Wallet address to receive change and the unlisted NFT
const SELLER_ADDRESS = "addr1qx33ycd2ymg02dxh6vnnf8dsk54l8ranr9cfjk9qrlj3309c69jc4n8h3uvnczncaqu2sm03pl99h99n75uvtl3mhv0q3z8s8m";

// UTXOs from your wallet to fund the transaction
const SELLER_UTXOS = [
  "828258204baa167631a62343cc4f37f9313ee05d6149b1fda39fd563e12832c8dd49fac90182583901a31261aa26d0f534d7d327349db0b52bf38fb319709958a01fe518bcb8d1658accf78f193c0a78e838a86df10fca5b94b3f538c5fe3bbb1e821a001344eea1581c6fb0ce0d80bce539333b0b16f4a29a0d40c786249f86850d3a36fa01a24f4646506f776572436f72657336323901504646506f776572436f7265733132343801",
  "828258204baa167631a62343cc4f37f9313ee05d6149b1fda39fd563e12832c8dd49fac90282583901a31261aa26d0f534d7d327349db0b52bf38fb319709958a01fe518bcb8d1658accf78f193c0a78e838a86df10fca5b94b3f538c5fe3bbb1e1a005b1fe1",
  "82825820daac1d3b80dcab8817c2f02f2d43ab2b33a4e74419679939eb8aa5f70b03f35c0182583901a31261aa26d0f534d7d327349db0b52bf38fb319709958a01fe518bcb8d1658accf78f193c0a78e838a86df10fca5b94b3f538c5fe3bbb1e821a007a089da1581c6fb0ce0d80bce539333b0b16f4a29a0d40c786249f86850d3a36fa01a1504646506f776572436f7265733137323001"
];

Type Definitions

interface UnlistInput {
  policyId: string;
  txHashIndex: string; // Format: txHash#outputIndex
}

interface BuildTxPayload {
  changeAddress: string;
  utxos: string[];
  unlist: UnlistInput[];
}

Implementation

Step 1: Identify the NFT Listing to Unlist

First, identify the NFT listing you want to remove:

// Step 1: Identify the NFT listing to unlist
console.log(`Unlisting NFT: Policy ID ${POLICY_ID}, TX Hash Index ${TX_HASH_INDEX}`);

Step 2: Prepare the Unlist Payload

Next, prepare the payload with your listing information:

// Step 2: Prepare the payload for the build-tx endpoint
const payload = {
  changeAddress: SELLER_ADDRESS,
  utxos: SELLER_UTXOS,
  unlist: [
    {
      policyId: POLICY_ID,
      txHashIndex: TX_HASH_INDEX
    }
  ]
};

Step 3: Build the Transaction

Send the request to the build-tx endpoint:

// Step 3: Build the transaction
console.log("Building unlist transaction...");
const response = await fetch(`${BASE_URL}/build-tx`, {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify(payload),
});

Step 4: Process the Response

Process the response to get the transaction hex:

// Step 4: Process the response
const result = await response.json();
console.log("Transaction:", result.transactions);

// Next steps: Sign the transaction with your wallet and submit via /submit endpoint
console.log("\nNext steps:");
console.log("1. Sign the transaction with your wallet");
console.log("2. Submit the signed transaction using the /submit endpoint");
console.log("3. After transaction confirms, your NFT will be returned to your wallet");

Running the Example

deno run --allow-net unlist-listing.ts

Example Output

Unlisting NFT: Policy ID 6fb0ce0d80bce539333b0b16f4a29a0d40c786249f86850d3a36fa01, TX Hash Index 4baa167631a62343cc4f37f9313ee05d6149b1fda39fd563e12832c8dd49fac9#0
Building unlist transaction...
Transaction: [
  "84ab00d90102828258204baa167631a62343cc4f37f9313ee05d6149b1fda39fd563e12832c8dd49fac900825820daac1d3b80dcab8817c2f02f2d43ab2b33a4e74419679939eb8aa5f70b03f35c01018182583901a31261aa26d0f534d7d327349db0b52bf38fb319709958a01fe518bcb8d1658accf78f193c0a78e838a86df10fca5b94b3f538c5fe3bbb1e821a008931eaa1581c6fb0ce0d80bce539333b0b16f4a29a0d40c786249f86850d3a36fa01a24e4646506f776572436f726573343701504646506f776572436f7265733137323001021a0005182b031a0974500607582010d70a7bf1ff1ed57b4ac55c6ed323880724390905b3f69b92615166c3ac96990b5820ccc11c6ff4ed2cb25a6973e55baff16c1630418670c77cba16ac163e0f4698aa0dd90102818258204baa167631a62343cc4f37f9313ee05d6149b1fda39fd563e12832c8dd49fac9020ed9010281581ca31261aa26d0f534d7d327349db0b52bf38fb319709958a01fe518bc1082583901a31261aa26d0f534d7d327349db0b52bf38fb319709958a01fe518bcb8d1658accf78f193c0a78e838a86df10fca5b94b3f538c5fe3bbb1e1a00446df8111a0016b1e912d90102818258201693c508b6132e89b932754d657d28b24068ff5ff1715fec36c010d4d6470b3d00a204d901029fd8799f9fd8799fd8799fd8799f581c5288ee085dc108f6fdc262b9e0cdfa92663b302836830efc0c5b4fdfffd8799fd8799fd8799f581c41ff84ecc10aae4f3ba8526ba742c739de9d513ace95e17170b1f04cffffffff1a000f4240ffd8799fd8799fd8799f581ca31261aa26d0f534d7d327349db0b52bf38fb319709958a01fe518bcffd8799fd8799fd8799f581cb8d1658accf78f193c0a78e838a86df10fca5b94b3f538c5fe3bbb1effffffff1a002dc6c0ffff581ca31261aa26d0f534d7d327349db0b52bf38fb319709958a01fe518bcffff05a182000082d87a80821a000205a91a02367e62f5a11902a2a1636d7367715761797570205472616e73616374696f6e"
]

Next steps:
1. Sign the transaction with your wallet
2. Submit the signed transaction using the /submit endpoint
3. After transaction confirms, your NFT will be returned to your wallet

The Complete File

See our examples repository for the complete file: unlist-listing.ts

unlist-listing.ts

// API endpoint for Wayup Marketplace
const BASE_URL = "https://prod.api.ada-anvil.app/marketplace/api";

// NFT listing to unlist
const POLICY_ID = "POLICY_ID";
const TX_HASH_INDEX = "TX_HASH_INDEX"; // Format: txHash#outputIndex

// Wallet address to receive change and the unlisted NFT
const SELLER_ADDRESS = "SELLER_ADDRESS";

// UTXOs from your wallet to fund the transaction
const SELLER_UTXOS = [
  "SELLER_UTXOS"
];

// Step 1: Identify the NFT listing to unlist
console.log(`Unlisting NFT: Policy ID ${POLICY_ID}, TX Hash Index ${TX_HASH_INDEX}`);

// Step 2: Prepare the payload for the build-tx endpoint
const payload = {
  changeAddress: SELLER_ADDRESS,
  utxos: SELLER_UTXOS,
  unlist: [
    {
      policyId: POLICY_ID,
      txHashIndex: TX_HASH_INDEX
    }
  ]
};

// Step 3: Build the transaction
console.log("Building unlist transaction...");
const response = await fetch(`${BASE_URL}/build-tx`, {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify(payload),
});

// Step 4: Process the response
const result = await response.json();
console.log("Transaction:", result.transactions);

// Next steps: Sign the transaction with your wallet and submit via /submit endpoint
console.log("\nNext steps:");
console.log("1. Sign the transaction with your wallet");
console.log("2. Submit the signed transaction using the /submit endpoint");
console.log("3. After transaction confirms, your NFT will be returned to your wallet");

// Run this with: deno run --allow-net unlist-listing.ts

Best Practices

1. Verify Listing Ownership: Always ensure you are the owner of the listing you're unlisting.

2. Transaction Confirmation: After submitting the signed transaction, verify it was confirmed on the blockchain.

3. NFT Return Verification: Check your wallet to confirm the NFT has been returned after the transaction confirms.

4. Listing Status: Verify that the NFT no longer appears in your active listings using the get-profile-listings endpoint with the appropriate filters.

End-to-End Flow

1. Identify the NFT listing to unlist (Policy ID and txHashIndex)

2. Build an unlist transaction via /build-tx with the unlist property

3. Sign the transaction with your wallet. See Signing Transactions

4. Submit the transaction via /submit. See Submit Transactions

5. Wait for confirmation; your NFT will be returned to your wallet address

6. Verify the NFT is in your wallet and no longer listed on the marketplace