Create Rune Mint Order

Use this endpoint to create a Rune Mint order.

You can use the Estimate Mint Order endpoint to estimate the cost of a Rune mint order before creating it.

Quick Start

post

Create a batch mint order.

Authorizations

apiKey

x-api-keystringRequired

Body

application/json

runeNamestringRequired

repeatsnumber · min: 1Required

destinationAddressstringRequired

refundAddressstringOptional

feeRatenumber · min: 1Required

appServiceFeenumberOptional

appServiceFeeAddressstringOptional

Responses

200

Default Response

application/json

post

/v1/runes-managed/mint/orders

HTTPcURLJavaScriptPython

POST /v1/runes-managed/mint/orders HTTP/1.1
Host: api.secretkeylabs.io
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 142

{
  "runeName": "text",
  "repeats": 1,
  "destinationAddress": "text",
  "refundAddress": "text",
  "feeRate": 1,
  "appServiceFee": 1,
  "appServiceFeeAddress": "text"
}

200

Default Response

{
  "orderId": "text",
  "fundAddress": "text",
  "fundAmount": 1
}

🆓 Rune Mint Orders are free for Xverse API customers. For free trial users, Xverse API charges a 2,000 sats fee for every mint transaction, with a cap of 36,000 sats (equivalent to 18 mint transactions) per mint order.

Create Rune Mint Order - Request

You can specify the characteristics of the Rune Mint order you wish to execute, by passing a request body, with the below properties:

Create Mint Order - Request Body	Description
runeName	a string representing the name of the Rune to mint
repeats	a number representing the number of mint transactions to create. Every mint transaction creates a fixed amount of new units of a rune. You can use repeats to mint a multiple of that amount. ℹ️ Note that there is a 4000 repeat limit per order
refundAddress	The Bitcoin address to which the amount of the funding transaction should be returned, should the mint order fail. ⚠️ If minting Runes for your user, we recommend managing refunds on their Bitcoin payment address.
destinationAddress	The Bitcoin address to which the minted runes should be allocated. ⚠️ If minting Runes for your users, we recommend managing runes holdings on their taproot/ordinal address.
feeRate	a number representing the desired fee rate to set for the Rune mint transaction(s), in sats per vbytes
appServiceFee (ℹ️ optional)	a number representing the sats value of the fee to charge your user for your service.
appServiceFeeAddress (ℹ️ optional)	a string representing the Bitcoin address which will receive the appServiceFee, if a fee is specified
network (ℹ️ optional)	a string representing the Bitcoin network to use for the transaction: 'Mainnet' or 'Testnet'

Create Rune Mint Order - Response

A successful Create Mint Order request will:

1. Create a Runes Mint order for the Xverse API to process, identified by an orderId

2. Return a the below response object to your app:

Create Mint Order - Response Object	Description
orderId	the ID of the Rune Mint order created by the Xverse API.
fundAddress	the BTC address which will collect the funds required to execute the mint order, and sign the required mint transactions to process the order.
fundAmount	the amount of sats to send to fundAddress the before you execute the mint order

Next Step -> Fund & Execute Rune Mint Order

Once you've funded your mint order and sent the required fundAmount to the fundAddress , you can call the Execute Mint Order endpoint.