Editions Launchpad

Create a new editions launchpad

post

Creates a new editions launchpad with the specified details.

Body

editionInscriptionIdstringRequired

The ID of the edition inscription.

Example: 38165c2a5a2b573196d079acbccccc3723534da4271f4be49f78e9d7ef4d5dd6i486

makerPaymentAddressstringRequired

The Bitcoin payment address of the maker.

Example: bc1pgnwmg7wplc09cm9fctgmgalu7l4synjh7khwzre9qlcvg5xy0k5qz9mwe3

numberOfEditionsinteger · min: 1Required

The number of editions to create.

Example: 3

priceintegerOptional

price per edition.

Example: 10000

slugstringRequired

The slug of the launchpad.

Example: satoshibles-the-ordinals

metaDataobjectOptional

Additional metadata for the launchpad.

signaturestringOptional

A signature in the format "{inscriptionId}:{currentUTCTimestamp}:{ordinalAddress}:{sign('{inscriptionId}:{currentUTCTimestamp}', ordinalAddress)}"; sign('{inscriptionId}:{currentUTCTimestamp}', ordinalAddress) must be in base64 format.

Responses

post

HTTPcURLJavaScriptPython

POST /marketplace/editions/create HTTP/1.1
Host: api.ordinalsbot.com
Content-Type: application/json
Accept: */*
Content-Length: 1215

{
  "editionInscriptionId": "38165c2a5a2b573196d079acbccccc3723534da4271f4be49f78e9d7ef4d5dd6i486",
  "makerPaymentAddress": "bc1pgnwmg7wplc09cm9fctgmgalu7l4synjh7khwzre9qlcvg5xy0k5qz9mwe3",
  "numberOfEditions": 3,
  "price": 10000,
  "slug": "satoshibles-the-ordinals",
  "metaData": {},
  "signature": "text",
  "meta": {
    "description": "Satoshi has come home to Bitcoin! The Ordinals collection by OG NFT project Satoshibles are a limited edition collection of 100 ordinals, featuring all new traits from the original artist Ayyoub Bouzerda. This collection is a tribute to Satoshi and the enduring legacy of Bitcoin. Don't miss your chance to own a piece of history!",
    "discord_link": "https://discord.com/invite/7Wm9Jg8MkW",
    "icon": "https://turbo.ordinalswallet.com/inscription/preview/3542f12dbe5fe3bd7fd622d1bb54994432e9a9184d24ff62ceb83234383b558ei0",
    "inscription_icon": "3542f12dbe5fe3bd7fd622d1bb54994432e9a9184d24ff62ceb83234383b558ei0",
    "name": "Satoshibles: The Ordinals",
    "slug": "satoshibles-the-ordinals",
    "twitter_link": "https://twitter.com/satoshibles",
    "website_link": "https://satoshibles.com",
    "telegram_link": "https://t.me/satoshibles",
    "instagram_link": "https://instagram.com/satoshibles",
    "banner_image": "https://example.com/banner.jpg"
  }
}

{
  "id": "26c82416-e450-4661-b192-ada4f700bc83"
}

Create a new order for editions minting

post

Creates a new order for editions minting with the specified details.

Body

launchpadIdintegerOptional

The ID of the launchpad.

Example: 1

numberOfEditionsintegerOptional

The number of editions to mint.

Example: 3

receiveAddressstringOptional

The Bitcoin address to receive the minted editions.

Example: bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh

feeRateinteger · min: 2Optional

The fee rate for the transaction.

Example: 5

Responses

post

HTTPcURLJavaScriptPython

POST /marketplace/editions/mint HTTP/1.1
Host: api.ordinalsbot.com
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "launchpadId": 1,
  "numberOfEditions": 3,
  "receiveAddress": "bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh",
  "feeRate": 5
}

{
  "id": "72ed4cde-ae61-4cbc-985f-1040d2656cd1",
  "charge": {
    "address": "bc1pmzsy06zwx5hc4shenex6ck90nnmlz5keps7c4frsype0j7n6fp4szv5w7k",
    "amount": 26678,
    "callback_url": ""
  },
  "receiveAddress": "bc1pgnwmg7wplc09cm9fctgmgalu7l4synjh7khwzre9qlcvg5xy0k5qz9mwe3",
  "pricingBreakdown": {
    "additionalFee": 2000,
    "additionalFeeCharged": 10000,
    "baseFee": 2000,
    "chainFee": 3948,
    "postage": 546,
    "serviceFee": 22730,
    "platformFee": 1000,
    "itemPrice": 1000,
    "amount": 26678
  }
}

Get all launchpads

post

Retrieves a list of all launchpads with optional filtering.

Header parameters

x-api-keystringRequired

API key required for authorization.

Body

pageinteger · min: 1Optional

The page number for pagination (optional)

Example: 1

itemsPerPageinteger · min: 1Optional

Number of items per page (optional)

Example: 10

sortstring · enumOptional

Sort listings by this field (optional)

Example: idPossible values:

Responses

post

HTTPcURLJavaScriptPython

POST /marketplace/launchpads HTTP/1.1
Host: api.ordinalsbot.com
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "filter": {
    "status": "active"
  },
  "page": 1,
  "itemsPerPage": 10,
  "sort": "id"
}

200

List of launchpads retrieved successfully.

{
  "data": [
    {
      "id": 1,
      "status": "text",
      "phases": []
    }
  ],
  "count": 1
}