Creating a Marketplace

An API Key is required to interact with MarketPlace APIs. Please contact us to get an API Key and get started.

Use this endpoint to register a new Marketplace. Having a marketplace registered allows the marketplace to specify marketplace fees and launchpad fees for buying and selling ordinals. Marketplace fees are paid out when an ordinal is sold. Fees are transferred to the address specified in a trustless way as part of the purchase transaction. This endpoint can also be used to specify launchpad configuration to create a launchpad. marketplace fees and launchpad fees are separate

POST Create a new marketplace

Create Marketplace

POST https://api.ordinalsbot.com/marketplace/create-marketplace

API Key is required in the header:

headers: { 'x-api-key': '<YOUR_API_KEY>', ...otherHeaders } Example Request Body: { "name" : "Marketplace Name", "sellerFee" : 500, "buyerFee" : 500, "btcFeePayoutAddress" : "3En...38L", "url" : "https://www.marketplace.com", "launchpadBuyerFee": 100, "launchpadSellerFee": 500, "launchpadBtcFeePayoutAddress": "2Mx...Erx" "description" : "This is a test marketPlace" }

Request Body

Name	Type	Description
sellerFee	Number	Fees to be charged to the seller when listing an ordinal for sale on the marketplace. Fees should be specified in basis points for example 10% would be 1000
buyerFee	Number	Fees that will be charged to the buyer when an ordinal is sold on the marketplace. Fees should be specified in basis points for example 10% would be 1000
btcFeePayoutAddress	String	The address for paying out marketplace fees
name*	String	Name for the marketplace
url	String	URL for the marketplace
description	String	Short description for the marketplace
launchpadBuyerFee	Number	Fees that will be charged to the buyer when buying from launchpad. Fees should be specified in basis points for example 10% would be 1000
launchpadSellerFee	Number	Fees that will be charged to the seller when an inscription is listed on launchpad. Fees should be specified in basis points for example 10% would be 1000
launchpadBtcFeePayoutAddress	String	The address for paying out launchpad fees

200: OK

{
    "marketPlaceId": "123abce79a817d55d0e7123", // your new marketplace id
    "apiKey": "366e7416-9e95-459f-bee9-fe8abbf4591b" // the api key you provided
}

500: Internal Server Error

{
    status: 'error',
    error: 'error reason'
}