Estimate Rune Mint Order

Use this endpoint to estimate the cost of a Rune Mint order, before executing it.

Quick Start

post

Estimate total cost for a batch mint order.

Authorizations
x-api-keystringRequired
Body
runeNamestringRequired
repeatsnumber · min: 1Required
destinationAddressstringRequired
refundAddressstringOptional
feeRatenumber · min: 1Required
appServiceFeenumberOptional
appServiceFeeAddressstringOptional
Responses
200

Default Response

application/json
post
/v1/runes-managed/mint/estimate
POST /v1/runes-managed/mint/estimate 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

{
  "totalSize": 1,
  "totalCost": 1,
  "costBreakdown": {
    "postage": 1,
    "networkFee": 1,
    "serviceFee": 1,
    "appServiceFee": 1
  }
}

Estimate Rune Mint Order - Request

You can specify the characteristics of the Runes <int order you wish to estimate, by passing a request body, with the below properties:

Estimate Mint - 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

destinationAddress

The Bitcoin address to which the minted runes should be allocated. ℹ️ If minting Runes for your app user, make sure to use their taproot/ordinal addresses for runes holdings.

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 mint runes transactions: 'Mainnet' or 'Testnet'

Estimate Rune Mint Order - Response

The response object is intended for you and your user to anticipate the costs of your specified Rune Mint order, with a clear breakdown:

Estimate Mint - Response Object
Description

totalSize

a number representing the total size of the mint transaction(s), in vbytes

totalCost

a number representing the total cost of the mint transaction(s) in sats

costBreakdown

An object representing the cost breakdown of the mint transaction(s), with the below properties:

  • postage a number representing the total size of the Rune UTXOs minted, in sats

  • networkFee a number representing the total network fee for the mint transaction(s), in sats

  • serviceFee a number representing the total Sats Connect fee for processing the mint order, in sats

  • appServiceFee a number representing the optional service fee your app charges the user for the mint order

Next Step -> Create Rune Mint Order

Use the Create Mint Order endpoint if you wish to proceed with a Runes Mint order after estimating its cost.

Last updated