@magiceden/magiceden-sdk
Advanced tools
A TypeScript SDK for interacting with Magic Eden's API across multiple chains.
A TypeScript SDK for interacting with Magic Eden's API across multiple chains (Solana and EVM-compatible blockchains).
BETA NOTICE: This SDK is currently in beta. The endpoints and methods documented in this README have been tested, but still may contain bugs or other issues. API signatures and parameters may still change before the stable release.
npm install @magiceden/magiceden-sdk
The Magic Eden SDK provides a unified interface for interacting with NFTs across different blockchains. Here's how to get started:
import { MagicEdenSDK } from '@magiceden/magiceden-sdk';
import { MagicEdenSDK } from '@magiceden/magiceden-sdk';
import { Keypair } from '@solana/web3.js';
import { Blockchain } from '@magiceden/magiceden-sdk';
// Initialize with a keypair
const solanaKeypair = Keypair.generate(); // Or load your existing keypair
const solanaClient = MagicEdenSDK.v1.createSolanaKeypairClient(
'YOUR_API_KEY',
solanaKeypair,
{
rpcUrl: 'SOLANA_RPC_URL'
}
);
// List an NFT for sale
const listResult = await solanaClient.nft.list({
token: '7um9nU7CDhss1fepFMRpjHhB3qm7exfQf47cdbRSUGuS', // NFT mint address
price: '1000000000', // Price in lamports (1 SOL)
});
console.log('Listing created:', listResult);
// Cancel an existing listing
const cancelResult = await solanaClient.nft.cancelListing({
token: '7um9nU7CDhss1fepFMRpjHhB3qm7exfQf47cdbRSUGuS', // NFT mint address
price: '1000000000', // Price in lamports (1 SOL)
});
console.log('Listing canceled:', cancelResult);
// Make an offer on an NFT
const offerResult = await solanaClient.nft.makeItemOffer({
token: '7YCrxt8Ux9dym832BKLDQQWJYZ2uziXgbF6cYfZaChdP', // NFT mint address
price: '900000', // Price in lamports (0.0009 SOL)
});
console.log('Offer made:', offerResult);
// Cancel an existing offer
const cancelOfferResult = await solanaClient.nft.cancelItemOffer({
token: '7YCrxt8Ux9dym832BKLDQQWJYZ2uziXgbF6cYfZaChdP', // NFT mint address
price: '900000', // Price in lamports (0.0009 SOL)
});
console.log('Offer canceled:', cancelOfferResult);
// Accept an offer from a buyer
const takeOfferResult = await solanaClient.nft.takeItemOffer({
token: '7um9nU7CDhss1fepFMRpjHhB3qm7exfQf47cdbRSUGuS', // NFT mint address
buyer: '4H2bigFBsMoTAwkn7THDnThiRQuLCrFDGUWHf4YDpf14', // Buyer's wallet address
price: '1500000', // Original offer price in lamports (0.0015 SOL)
newPrice: '1000000', // Accepted price in lamports (0.001 SOL)
});
console.log('Offer accepted:', takeOfferResult);
// Buy an NFT at the listed price
const buyResult = await solanaClient.nft.buy({
token: '7um9nU7CDhss1fepFMRpjHhB3qm7exfQf47cdbRSUGuS', // NFT mint address
seller: '4H2bigFBsMoTAwkn7THDnThiRQuLCrFDGUWHf4YDpf14', // Seller's wallet address
price: '1500000', // Price in lamports (0.0015 SOL)
});
console.log('Purchase completed:', buyResult);
// Transfer an NFT to another wallet
const transferResult = await solanaClient.nft.transfer({
token: 'BxRLKzJVJzyNBRqE6bnhqthbHGMSvyv9GotKihwX6LqJ', // NFT mint address
to: '4H2bigFBsMoTAwkn7THDnThiRQuLCrFDGUWHf4YDpf14', // Recipient's wallet address
isCompressed: true, // Whether the NFT is compressed
});
console.log('Transfer completed:', transferResult);
Creating a launchpad on Solana is a two-step process. The steps are as follows:
createLaunchpad.publishLaunchpad.// Create a new NFT launchpad
const launchpadResult = await client.nft.createLaunchpad({
chain: Blockchain.SOLANA,
protocol: SolProtocolType.METAPLEX_CORE,
creator: walletAddress,
name: 'TestCollection',
symbol: 'TEST',
description: 'This is a test collection created with the Magic Eden self-serve API',
nftMetadataUrl: 'https://bafybeic3rs6wmnnhqachwxsiizlblignek6aitc5b3ooenhhtkez3onmwu.ipfs.w3s.link',
royaltyBps: 500, // 5%
royaltyRecipients: [{ address: walletAddress, share: 100 }],
payoutRecipient: walletAddress,
social: {
discordUrl: 'https://discord.gg/magiceden',
twitterUsername: 'magiceden',
externalUrl: 'https://magiceden.io',
},
mintStages: {
maxSupply: 10000,
stages: [
{
kind: MintStageKind.Allowlist,
price: {
currency: {
chain: Blockchain.SOLANA,
assetId: 'So11111111111111111111111111111111111111112',
},
raw: '1', // Price in lamports
},
startTime: '2025-03-20T00:00:00.000Z',
endTime: '2025-03-27T00:00:00.000Z',
walletLimit: 2,
allowlist: [
walletAddress,
"5FHwkrdxkrR7zKy1jHmqh5uWyKj1ZbM7PKhRgw7F8Z8K",
"8HXhDbwLVeS7neCC93dYeM9LCokRMSbSw2q9ofsPRgWi"
],
},
{
kind: MintStageKind.Public,
price: {
currency: {
chain: Blockchain.SOLANA,
assetId: 'So11111111111111111111111111111111111111112',
},
raw: '1', // Price in lamports
},
startTime: '2025-03-28T00:00:00.000Z',
endTime: '2030-03-30T00:00:00.000Z',
walletLimit: 10
},
],
},
isOpenEdition: false,
});
console.log('Launchpad created successfully:', launchpadResult);
// Gives you the following response, which contains all transactions that were created and sent in the process as well as some metadata about the launchpad:
/**
* [
{
"txId": "<TX_ID>",
"status": "confirmed",
"metadata": {
"operation": {
"payload": {
"chain": "solana",
"candyMachineId": "<CANDY_MACHINE_ID>",
"collectionId": "<COLLECTION_ID>",
"symbol": "<SYMBOL>",
"authorization": {
"signer": "<SIGNER>",
}
}
},
"receipt": {
"blockhash": "<BLOCK_HASH>",
"lastValidBlockHeight": <BLOCK_HEIGHT>
}
}
},
{
"txId": "<TX_ID>",
"status": "confirmed",
"metadata": {
"operation": {
"payload": {
"chain": "solana",
"candyMachineId": "<CANDY_MACHINE_ID>",
"collectionId": "<COLLECTION_ID>",
"symbol": "<SYMBOL>",
"authorization": {
"signer": "<SIGNER>",
}
}
},
"receipt": {
"blockhash": "<BLOCK_HASH>",
"lastValidBlockHeight": <BLOCK_HEIGHT>
}
}
},
{
"txId": "<TX_ID>",
"status": "confirmed",
"metadata": {
"operation": {
"payload": {
"chain": "solana",
"candyMachineId": "<CANDY_MACHINE_ID>",
"collectionId": "<COLLECTION_ID>",
"symbol": "<SYMBOL>",
"authorization": {
"signer": "<SIGNER>",
}
}
},
"receipt": {
"blockhash": "<BLOCK_HASH>",
"lastValidBlockHeight": <BLOCK_HEIGHT>
}
}
},
{
"txId": "<TX_ID>",
"status": "confirmed",
"metadata": {
"operation": {
"payload": {
"chain": "solana",
"candyMachineId": "<CANDY_MACHINE_ID>",
"collectionId": "<COLLECTION_ID>",
"symbol": "<SYMBOL>",
"authorization": {
"signer": "<SIGNER>",
}
}
},
"receipt": {
"blockhash": "<BLOCK_HASH>",
"lastValidBlockHeight": <BLOCK_HEIGHT>
}
}
}
]
*/
// Update an existing NFT launchpad
const updateResult = await client.nft.updateLaunchpad({
chain: Blockchain.SOLANA,
protocol: SolProtocolType.METAPLEX_CORE,
collectionId: '<COLLECTION_ID>',
owner: walletAddress,
payer: walletAddress,
symbol: 'TEST2',
newSymbol: 'TEST',
candyMachineId: '<CANDY_MACHINE_ID>',
name: 'TestCollection',
payoutRecipient: walletAddress,
royaltyRecipients: [{ address: walletAddress, share: 100 }],
});
console.log('Launchpad updated successfully!', updateResult);
// Mint NFTs from a launchpad
const mintResult = await client.nft.mint({
chain: Blockchain.SOLANA,
collectionId: '22zxgVwS7cXkTRfvFgERnN5KZpLgukQXAoauNkHtghX2',
nftAmount: 1,
kind: MintStageKind.Public,
candyMachineId: 'iQU3uT6WnnYkCXqXreXm2ysihoj8WGXk5GJtczcos6a',
symbol: 'TEST',
});
console.log('Mint completed successfully!', mintResult);
// Example testing file
import { MagicEdenSDK } from '@magiceden/magiceden-sdk';
import { Keypair } from '@solana/web3.js';
import { Blockchain, SolProtocolType, MintStageKind } from '@magiceden/magiceden-sdk';
import bs58 from 'bs58';
// Initialize with your keypair
const apiKey = 'YOUR_API_KEY';
const keypair = Keypair.fromSecretKey(
bs58.decode('YOUR_PRIVATE_KEY')
);
// Create a Solana client
const client = MagicEdenSDK.v1.createSolanaKeypairClient(apiKey, keypair, {
rpcUrl: 'https://mainnet.helius-rpc.com/?api-key=YOUR_HELIUS_API_KEY',
});
// Example function to list an NFT
async function listNFT() {
try {
await client.nft.list({
token: '7um9nU7CDhss1fepFMRpjHhB3qm7exfQf47cdbRSUGuS',
price: '1000000000', // 1 SOL
});
console.log('NFT listed successfully!');
} catch (error) {
console.error('Error listing NFT:', error);
}
}
// Run the example
listNFT();
import { MagicEdenSDK } from '@magiceden/magiceden-sdk';
import { Blockchain } from '@magiceden/magiceden-sdk';
// Initialize with a private key or wallet
const evmClient = MagicEdenSDK.v1.createViemEvmClient(
'YOUR_API_KEY',
'0xYOUR_PRIVATE_KEY',
Blockchain.BASE // or Blockchain.ETHEREUM, Blockchain.POLYGON, etc.
);
// List an NFT for sale on EVM chains
const listResult = await client.nft.list({
chain: Blockchain.BASE,
params: [{
token: '0x949de1b4d4cc4a8e63b7565b6dc525d8eb5dd15a:0',
price: '10000000012',
}]
});
console.log('List completed successfully!', listResult);
// Cancel an existing listing on EVM chains
const cancelResult = await client.nft.cancelListing({
chain: Blockchain.BASE,
orderIds: ['0xc34124b0276f92ca985c2b7e25e9a5c3164c5aa45a2fe1ff1ac6c33b4665649c'],
});
console.log('Listing canceled successfully!', cancelResult);
// Make an offer on an NFT
const makeItemOfferResponse = await client.nft.makeItemOffer({
chain: Blockchain.BASE,
params: [{
token: '0x1195cf65f83b3a5768f3c496d3a05ad6412c64b7:304163',
price: '9000',
}]
});
console.log('Offer made successfully!', makeItemOfferResponse);
// Cancel an existing offer
const cancelOfferResult = await client.nft.cancelItemOffer({
chain: Blockchain.BASE,
orderIds: ['0x18fc51e19bc96bc07b9bdd804eb055a691e46e3cd2c37a5d7e53daedebae70c4'],
});
console.log('Offer canceled successfully!', cancelOfferResult);
// Accept an offer on your NFT
const takeOfferResult = await client.nft.takeItemOffer({
chain: Blockchain.BASE,
items: [{
token: '0x949de1b4d4cc4a8e63b7565b6dc525d8eb5dd15a:0',
quantity: 1,
// Optional specific order id to take
orderId: '0x18fc51e19bc96bc07b9bdd804eb055a691e46e3cd2c37a5d7e53daedebae70c4',
}],
});
console.log('Offer accepted successfully!', takeOfferResult);
// Buy an NFT at the listed price
const buyResult = await client.nft.buy({
chain: Blockchain.BASE,
items: [{
token: '0x1c55ec22ec5083dd0937b9590df4f2629ee43fe9:3030',
quantity: 1,
}],
});
console.log('Buy completed successfully!', buyResult);
// Transfer an NFT to another wallet
const transferResult = await client.nft.transfer({
chain: Blockchain.BASE,
items: [{
token: '0x1c55ec22ec5083dd0937b9590df4f2629ee43fe9:3030',
quantity: 1,
}],
to: '0x1fDcfcdeE9e8fA32D95b9648a30E5Cb8C6C7197b',
});
console.log('Transfer completed successfully!', transferResult);
// Create a new NFT launchpad on EVM chains
const launchpadResult = await client.nft.createLaunchpad({
chain: Blockchain.BASE,
protocol: EvmProtocolType.ERC1155,
creator: walletAddress,
name: 'TestCollection',
symbol: 'TEST',
description: 'This is a test collection created with the Magic Eden self-serve API',
nftMetadataUrl: 'https://bafybeic3rs6wmnnhqachwxsiizlblignek6aitc5b3ooenhhtkez3onmwu.ipfs.w3s.link',
royaltyBps: 500, // 5%
royaltyRecipients: [{ address: walletAddress, share: 100 }],
payoutRecipient: walletAddress,
mintStages: {
tokenId: 0,
maxSupply: 10000,
walletLimit: 10,
stages: [
{
kind: MintStageKind.Allowlist,
price: {
currency: {
chain: Blockchain.BASE,
assetId: '0x0000000000000000000000000000000000000000',
},
raw: '1', // Price in wei
},
startTime: '2025-03-20T00:00:00.000Z',
endTime: '2025-03-27T00:00:00.000Z',
walletLimit: 2,
allowlist: [
walletAddress,
'0x1fDcfcdeE9e8fA32D95b9648a30E5Cb8C6C7197b',
'0x43B6BF3DD080D5a7055Ee6785a6f1d4Ba54fa09d',
],
},
{
kind: MintStageKind.Public,
price: {
currency: {
chain: Blockchain.BASE,
assetId: '0x0000000000000000000000000000000000000000',
},
raw: '1', // Price in wei
},
startTime: '2025-03-28T00:00:00.000Z',
endTime: '2030-03-30T00:00:00.000Z',
walletLimit: 10,
},
],
},
});
console.log('Launchpad created successfully!', launchpadResult);
// Update an existing NFT launchpad on EVM chains
const updateResult = await client.nft.updateLaunchpad({
chain: Blockchain.BASE,
protocol: EvmProtocolType.ERC1155,
tokenId: 0,
collectionId: '0x949de1b4d4cc4a8e63b7565b6dc525d8eb5dd15a',
owner: walletAddress,
name: 'TestCollection2',
payoutRecipient: walletAddress,
});
console.log('Launchpad updated successfully!', updateResult);
// Mint an NFT from a collection
const mintResult = await evmClient.nft.mint({
chain: Blockchain.BASE,
collectionId: '0x949de1b4d4cc4a8e63b7565b6dc525d8eb5dd15a', // Collection contract address
nftAmount: 1, // Number of NFTs to mint
tokenId: 0, // Token ID to mint
kind: MintStageKind.Public, // Mint stage type
protocol: EvmProtocolType.ERC1155, // NFT standard (ERC721 or ERC1155)
});
console.log('Mint completed:', mintResult);
// Example testing file for EVM
import { MagicEdenSDK } from '@magiceden/magiceden-sdk';
import { Blockchain, EvmProtocolType, MintStageKind } from '@magiceden/magiceden-sdk';
// Initialize with your private key
const apiKey = 'YOUR_API_KEY';
const privateKey = '0xYOUR_PRIVATE_KEY';
// Create an EVM client
const evmClient = MagicEdenSDK.v1.createViemEvmClient(
apiKey,
privateKey,
Blockchain.BASE
);
// Example function to mint an NFT
async function mintNFT() {
try {
const result = await evmClient.nft.mint({
chain: Blockchain.BASE,
collectionId: '0x949de1b4d4cc4a8e63b7565b6dc525d8eb5dd15a',
nftAmount: 1,
tokenId: 0,
kind: MintStageKind.Public,
protocol: EvmProtocolType.ERC1155,
});
console.log('NFT minted successfully!', result);
} catch (error) {
console.error('Error minting NFT:', error);
}
}
// Run the example
mintNFT();
FAQs
A TypeScript SDK for interacting with Magic Eden's API across multiple chains.
We found that @magiceden/magiceden-sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
/Research
Socket found a Rust typosquat (finch-rust) that loads sha-rust to steal credentials, using impersonation and an unpinned dependency to auto-deliver updates.
Research
/Security Fundamentals
A pair of typosquatted Go packages posing as Google’s UUID library quietly turn helper functions into encrypted exfiltration channels to a paste site, putting developer and CI data at risk.
Security News
November CVE publications fell 25% YoY even as 2025 totals rose, showing how a few major CNAs can swing “global” counts and skew perceived risk.