docs.magiceden.io Open in urlscan Pro
2606:4700:4400::6812:2741  Public Scan

Form analysis
0 forms found in the DOM

Text Content

Jump to Content

HomeRecipesAPI ReferenceChangelogv1.0

--------------------------------------------------------------------------------

Bug Bounty ProgramGo to Magic Eden
API Reference
Bug Bounty ProgramGo to Magic Eden
Moon (Dark Mode)Sun (Light Mode)

v1.0
HomeRecipesAPI ReferenceChangelog
Search
CTRL-K
Magic Eden APISolana API OverviewSolana API KeyscollectionsGet activities of a
collectionGet stats of a collectionGet collectionsGet listings of a
collectionGet holder stats of a collectionlaunchpadGet launchpad
collectionsmarketplaceGet the top 50 popular collections for a time rangemmmMMM
Pool PricingGet AMM pools corresponding to an owner or collection symbol. At
least one of required collectionSymbol or owner is required!Get best offers for
an NFTGet instruction to create a poolGet instruction to withdraw sol payment
from a poolGet instruction to have a pool fulfill a buyGet instruction to have a
pool fulfill a selltokensGet listings for a tokenGet received offers for a
tokenGet activities for a tokenGet token metadata by mint addresswalletsGet
tokens owned by a wallet.Get info about the wallet owner.Get activities of a
wallet.Get offers made by a wallet.Get offers received by a wallet.Get escrow
balance for a wallet.instructionsGet instruction to buy (bid)Get instruction to
buy now and transfer nft to another ownerGet instruction to buy nowGet
instruction to cancel a buyGet instruction to change a buy priceGet instruction
to sell (list)Get instruction to change a sell priceGet instruction to sell now
(accept offer)Get instruction to cancel a sellGet instruction to deposit to
escrowGet instruction to withdraw from escrowFrequently Asked Questions
(FAQs)Magic Eden Ordinals APIOrdinals API OverviewOrdinals API
KeysCollectionsGet collectionGet collection statsGet popular collection
statsActivitiesGet activitiesTokensGet tokensBRC-20Get BRC20 ticker infoGet tick
balances by owner idToken transaction historyMagic Eden Polygon APIPolygon API
OverviewPolygon API KeysCollectionsCollectionsTop Selling CollectionsUser
collectionsTokensTokensUser TokensOrdersAsks (listings)Bids
(offers)ActivityUsers activityToken activityAttributesAll attributesCreate
Orders (list & bid)Check cross posting statusSubmit signed ordersCreate bids
(offers)Cancel ordersFill Orders (buy & sell)Buy tokens (fill listings)Sell
tokens (accept bids)
All
Recipes
Reference
Changelog

START TYPING TO SEARCH…

JUMP TOCTRL-/


MAGIC EDEN API

 * Solana API Overview
 * Solana API Keys
 * collections
   * Get activities of a collectionget
   * Get stats of a collectionget
   * Get collectionsget
   * Get listings of a collectionget
   * Get holder stats of a collectionget
 * launchpad
   * Get launchpad collectionsget
 * marketplace
   * Get the top 50 popular collections for a time rangeget
 * mmm
   * MMM Pool Pricing
   * Get AMM pools corresponding to an owner or collection symbol. At least one
     of required collectionSymbol or owner is required!get
   * Get best offers for an NFTget
   * Get instruction to create a poolget
   * Get instruction to withdraw sol payment from a poolget
   * Get instruction to have a pool fulfill a buyget
   * Get instruction to have a pool fulfill a sellget
 * tokens
   * Get listings for a tokenget
   * Get received offers for a tokenget
   * Get activities for a tokenget
   * Get token metadata by mint addressget
 * wallets
   * Get tokens owned by a wallet.get
   * Get info about the wallet owner.get
   * Get activities of a wallet.get
   * Get offers made by a wallet.get
   * Get offers received by a wallet.get
   * Get escrow balance for a wallet.get
 * instructions
   * Get instruction to buy (bid)get
   * Get instruction to buy now and transfer nft to another ownerget
   * Get instruction to buy nowget
   * Get instruction to cancel a buyget
   * Get instruction to change a buy priceget
   * Get instruction to sell (list)get
   * Get instruction to change a sell priceget
   * Get instruction to sell now (accept offer)get
   * Get instruction to cancel a sellget
   * Get instruction to deposit to escrowget
   * Get instruction to withdraw from escrowget
 * Frequently Asked Questions (FAQs)


MAGIC EDEN ORDINALS API

 * Ordinals API Overview
 * Ordinals API Keys
 * Collections
   * Get collectionget
   * Get collection statsget
   * Get popular collection statsget
 * Activities
   * Get activitiesget
 * Tokens
   * Get tokensget
 * BRC-20
   * Get BRC20 ticker infoget
   * Get tick balances by owner idget
   * Token transaction historyget


MAGIC EDEN POLYGON API

 * Polygon API Overview
 * Polygon API Keys
 * Collections
   * Collectionsget
   * Top Selling Collectionsget
   * User collectionsget
 * Tokens
   * Tokensget
   * User Tokensget
 * Orders
   * Asks (listings)get
   * Bids (offers)get
 * Activity
   * Users activityget
   * Token activityget
 * Attributes
   * All attributesget
 * Create Orders (list & bid)
   * Check cross posting statusget
   * Submit signed orderspost
   * Create bids (offers)post
   * Cancel orderspost
 * Fill Orders (buy & sell)
   * Buy tokens (fill listings)post
   * Sell tokens (accept bids)post

Powered by 
JUMP TOCTRL-/


MAGIC EDEN API

 * Solana API Overview
 * Solana API Keys
 * collections
   * Get activities of a collectionget
   * Get stats of a collectionget
   * Get collectionsget
   * Get listings of a collectionget
   * Get holder stats of a collectionget
 * launchpad
   * Get launchpad collectionsget
 * marketplace
   * Get the top 50 popular collections for a time rangeget
 * mmm
   * MMM Pool Pricing
   * Get AMM pools corresponding to an owner or collection symbol. At least one
     of required collectionSymbol or owner is required!get
   * Get best offers for an NFTget
   * Get instruction to create a poolget
   * Get instruction to withdraw sol payment from a poolget
   * Get instruction to have a pool fulfill a buyget
   * Get instruction to have a pool fulfill a sellget
 * tokens
   * Get listings for a tokenget
   * Get received offers for a tokenget
   * Get activities for a tokenget
   * Get token metadata by mint addressget
 * wallets
   * Get tokens owned by a wallet.get
   * Get info about the wallet owner.get
   * Get activities of a wallet.get
   * Get offers made by a wallet.get
   * Get offers received by a wallet.get
   * Get escrow balance for a wallet.get
 * instructions
   * Get instruction to buy (bid)get
   * Get instruction to buy now and transfer nft to another ownerget
   * Get instruction to buy nowget
   * Get instruction to cancel a buyget
   * Get instruction to change a buy priceget
   * Get instruction to sell (list)get
   * Get instruction to change a sell priceget
   * Get instruction to sell now (accept offer)get
   * Get instruction to cancel a sellget
   * Get instruction to deposit to escrowget
   * Get instruction to withdraw from escrowget
 * Frequently Asked Questions (FAQs)


MAGIC EDEN ORDINALS API

 * Ordinals API Overview
 * Ordinals API Keys
 * Collections
   * Get collectionget
   * Get collection statsget
   * Get popular collection statsget
 * Activities
   * Get activitiesget
 * Tokens
   * Get tokensget
 * BRC-20
   * Get BRC20 ticker infoget
   * Get tick balances by owner idget
   * Token transaction historyget


MAGIC EDEN POLYGON API

 * Polygon API Overview
 * Polygon API Keys
 * Collections
   * Collectionsget
   * Top Selling Collectionsget
   * User collectionsget
 * Tokens
   * Tokensget
   * User Tokensget
 * Orders
   * Asks (listings)get
   * Bids (offers)get
 * Activity
   * Users activityget
   * Token activityget
 * Attributes
   * All attributesget
 * Create Orders (list & bid)
   * Check cross posting statusget
   * Submit signed orderspost
   * Create bids (offers)post
   * Cancel orderspost
 * Fill Orders (buy & sell)
   * Buy tokens (fill listings)post
   * Sell tokens (accept bids)post

Powered by 


SOLANA API OVERVIEW

The Magic Eden Solana API is designed to empower developers in creating
innovative experiences using NFTs and our abundant marketplace data. We offer a
robust suite of endpoints that allows you to access NFT metadata along with
crucial components of our marketplace, including events, collections, listings,
bids, and more. With our API, you can not only access the data but also perform
various actions that you would on our user interface, such as listing NFTs,
buying NFTs, placing bids, and more.

We offer these endpoints in the spirit of fostering composability and openness
in the web3 space, extending the reach of this data to anyone desiring to build
upon it. In return, if you utilize our data, we ask that you adhere to our Terms
of Service.

Moreover, we make this API available free of charge and kindly request that you
attribute Magic Eden on your website or within your app. When you leverage our
API, please consider linking to the Magic Eden marketplace from the NFTs that
you showcase, where it's appropriate.

Please be aware that our API is rate-limited and some endpoints are gated by an
API key. For more info check out Solana API Keys.


CLUSTERS

More info about Solana clusters: https://docs.solana.com/clusters

 * Devnet: api-devnet.magiceden.dev/v2 - this uses a testing Solana cluster, the
   tokens are not real
 * Mainnet: api-mainnet.magiceden.dev/v2 - this uses the real Solana cluster,
   the tokens are real and this is consistent with the data seen on
   https://magiceden.io/


HIGHLIGHT PROJECTS

You can find a list of projects in analytics, trader tooling, and community
management from our NYC Hacker House Hackathon Gallery.


THE WINNERS IN EACH RESPECTIVE CATEGORY ARE:

 * Best Analytics Project: Seller Classification
 * Best Trader Tooling: Solset.io
 * Best Social Media Integration: Hawksight Bot Improvements via Magic Eden API


API METADATA

Some endpoints in this API are able to respond with some useful metadata if
requested. This is done by including the request header ME-Pub-API-Metadata and
the value of this request header is a JSON object with the following TypeScript
interface:

TypeScript
interface RequestMetadata {
  paging?: boolean
}


If an endpoint is requested with the header (and supports) ME-Pub-API-Metadata,
the endpoint will respond with a header of the same name (ME-Pub-API-Metadata).
The value of this response header is a JSON object with the following TypeScript
interface:

typescript
interface ResponseMetadata {
  paging?: PagingMetadata
}

interface PagingMetadata {
  total: number
  start: number
  end: number
}


The below is an example

Request headers:
ME-Pub-API-Metadata: {"paging":true}

Response headers:
ME-Pub-API-Metadata: {"paging":{"total":10, "start":0, "end":1}}

Updated 2 months ago

--------------------------------------------------------------------------------

Solana API Keys
Did this page help you?
Yes
No

Updated 2 months ago

--------------------------------------------------------------------------------

Solana API Keys
Did this page help you?
Yes
No
 * Table of Contents
 * * Clusters
   * Highlight Projects
   * API Metadata



 1.  Magic Eden API
 2.  Solana API Overview
 3.  Solana API Keys
 4.  collections
 5.  Get activities of a collectionget
 6.  Get stats of a collectionget
 7.  Get collectionsget
 8.  Get listings of a collectionget
 9.  Get holder stats of a collectionget
 10. launchpad
 11. Get launchpad collectionsget
 12. marketplace
 13. Get the top 50 popular collections for a time rangeget
 14. mmm
 15. MMM Pool Pricing
 16. Get AMM pools corresponding to an owner or collection symbol. At least one
     of required collectionSymbol or owner is required!get
 17. Get best offers for an NFTget
 18. Get instruction to create a poolget
 19. Get instruction to withdraw sol payment from a poolget
 20. Get instruction to have a pool fulfill a buyget
 21. Get instruction to have a pool fulfill a sellget
 22. tokens
 23. Get listings for a tokenget
 24. Get received offers for a tokenget
 25. Get activities for a tokenget
 26. Get token metadata by mint addressget
 27. wallets
 28. Get tokens owned by a wallet.get
 29. Get info about the wallet owner.get
 30. Get activities of a wallet.get
 31. Get offers made by a wallet.get
 32. Get offers received by a wallet.get
 33. Get escrow balance for a wallet.get
 34. instructions
 35. Get instruction to buy (bid)get
 36. Get instruction to buy now and transfer nft to another ownerget
 37. Get instruction to buy nowget
 38. Get instruction to cancel a buyget
 39. Get instruction to change a buy priceget
 40. Get instruction to sell (list)get
 41. Get instruction to change a sell priceget
 42. Get instruction to sell now (accept offer)get
 43. Get instruction to cancel a sellget
 44. Get instruction to deposit to escrowget
 45. Get instruction to withdraw from escrowget
 46. Frequently Asked Questions (FAQs)

 1.  Magic Eden Ordinals API
 2.  Ordinals API Overview
 3.  Ordinals API Keys
 4.  Collections
 5.  Get collectionget
 6.  Get collection statsget
 7.  Get popular collection statsget
 8.  Activities
 9.  Get activitiesget
 10. Tokens
 11. Get tokensget
 12. BRC-20
 13. Get BRC20 ticker infoget
 14. Get tick balances by owner idget
 15. Token transaction historyget

 1.  Magic Eden Polygon API
 2.  Polygon API Overview
 3.  Polygon API Keys
 4.  Collections
 5.  Collectionsget
 6.  Top Selling Collectionsget
 7.  User collectionsget
 8.  Tokens
 9.  Tokensget
 10. User Tokensget
 11. Orders
 12. Asks (listings)get
 13. Bids (offers)get
 14. Activity
 15. Users activityget
 16. Token activityget
 17. Attributes
 18. All attributesget
 19. Create Orders (list & bid)
 20. Check cross posting statusget
 21. Submit signed orderspost
 22. Create bids (offers)post
 23. Cancel orderspost
 24. Fill Orders (buy & sell)
 25. Buy tokens (fill listings)post
 26. Sell tokens (accept bids)post


 1.  Magic Eden API
 2.  Solana API Overview
 3.  Solana API Keys
 4.  collections
 5.  Get activities of a collectionget
 6.  Get stats of a collectionget
 7.  Get collectionsget
 8.  Get listings of a collectionget
 9.  Get holder stats of a collectionget
 10. launchpad
 11. Get launchpad collectionsget
 12. marketplace
 13. Get the top 50 popular collections for a time rangeget
 14. mmm
 15. MMM Pool Pricing
 16. Get AMM pools corresponding to an owner or collection symbol. At least one
     of required collectionSymbol or owner is required!get
 17. Get best offers for an NFTget
 18. Get instruction to create a poolget
 19. Get instruction to withdraw sol payment from a poolget
 20. Get instruction to have a pool fulfill a buyget
 21. Get instruction to have a pool fulfill a sellget
 22. tokens
 23. Get listings for a tokenget
 24. Get received offers for a tokenget
 25. Get activities for a tokenget
 26. Get token metadata by mint addressget
 27. wallets
 28. Get tokens owned by a wallet.get
 29. Get info about the wallet owner.get
 30. Get activities of a wallet.get
 31. Get offers made by a wallet.get
 32. Get offers received by a wallet.get
 33. Get escrow balance for a wallet.get
 34. instructions
 35. Get instruction to buy (bid)get
 36. Get instruction to buy now and transfer nft to another ownerget
 37. Get instruction to buy nowget
 38. Get instruction to cancel a buyget
 39. Get instruction to change a buy priceget
 40. Get instruction to sell (list)get
 41. Get instruction to change a sell priceget
 42. Get instruction to sell now (accept offer)get
 43. Get instruction to cancel a sellget
 44. Get instruction to deposit to escrowget
 45. Get instruction to withdraw from escrowget
 46. Frequently Asked Questions (FAQs)

 1.  Magic Eden Ordinals API
 2.  Ordinals API Overview
 3.  Ordinals API Keys
 4.  Collections
 5.  Get collectionget
 6.  Get collection statsget
 7.  Get popular collection statsget
 8.  Activities
 9.  Get activitiesget
 10. Tokens
 11. Get tokensget
 12. BRC-20
 13. Get BRC20 ticker infoget
 14. Get tick balances by owner idget
 15. Token transaction historyget

 1.  Magic Eden Polygon API
 2.  Polygon API Overview
 3.  Polygon API Keys
 4.  Collections
 5.  Collectionsget
 6.  Top Selling Collectionsget
 7.  User collectionsget
 8.  Tokens
 9.  Tokensget
 10. User Tokensget
 11. Orders
 12. Asks (listings)get
 13. Bids (offers)get
 14. Activity
 15. Users activityget
 16. Token activityget
 17. Attributes
 18. All attributesget
 19. Create Orders (list & bid)
 20. Check cross posting statusget
 21. Submit signed orderspost
 22. Create bids (offers)post
 23. Cancel orderspost
 24. Fill Orders (buy & sell)
 25. Buy tokens (fill listings)post
 26. Sell tokens (accept bids)post