LogoLogo
Back to AppHelp Center
  • Getting Started
    • Welcome
  • OrdinalsBot API
    • Overview
    • Libraries
    • Template-App
    • Signet
    • Testnet
    • Fractal
    • Getting Prices
      • Getting Prices (Legacy)
    • Create a Direct Inscription Order
    • Create a Managed Inscription Order
    • Get Order Status
    • Create a Collection
    • Create a Collection Order
    • Create Text Inscription Order
    • Search Inscriptions
    • Check Rare Sats Inventory
    • Referral Scheme
    • Transaction Accelerator
    • Burning Assets
    • Webhooks
    • Order States
    • Order Types
  • Runes
    • Etch
    • Mint
    • Direct Mint
      • 1. Generate Direct Mint PSBT
      • 2. Direct Rune Mint Process PSBT
    • Launchpad
      • Create
      • Mint
      • Get Launchpad
    • Airdrop
  • Token Pay
    • What is TokenPay?
    • API Docs
      • API reference
        • Order
        • Create payment psbt
        • Create burn rune psbt
        • Validate burn rune tx
        • Create burn inscription psbt
        • Utils
          • Checktx
          • Submittx
          • Finalize psbt
        • User
          • Withdrawal
          • Order
            • Rune
          • Account
            • Withdraw
            • Balance
      • Specification
  • Marketplace
    • User Guide: Pre-Inscribed Launchpad API
    • API Docs
    • Editions Launchpad
  • Launchpad API
    • Create Marketplace
    • Create a new Launchpad
    • Retrieve Launch PSBT
    • Confirm Launch
    • Check Allocation
    • Check for Padding Outputs
    • Setup Padding Outputs
    • Create buy offer
    • Confirm buy offer
    • Get Launch Info
  • Sat Scanner API
    • Find Special Ranges
    • Find Special Ranges UTXO
    • Supported Satributes
  • Sat Extractor
    • Extract
  • BRC20 / BRC2.0PROG
    • OPI API
    • Bitcoin Remix
  • SNS API
    • SNS API
  • Mempool API
    • Mempool API
  • TAP PROTOCOL
    • Tap Reader API
  • UTXO
    • Split
  • User Guide
    • Inscribe your first Ordinal
    • Receiving Payments
  • Knowledge Base
    • Ordinals
      • What is an Ordinal?
      • Satoshi Rarity
      • What are BRC-20 Tokens?
      • Image Optimisation
      • Pixel Art
    • Bitcoin
      • Unspent Transaction Output (UTXO)
  • Official Links
    • Twitter
    • Discord
Powered by GitBook
On this page
  • POST a new rune mint order
  • Mint Rune
  1. Runes

Mint

PreviousEtchNextDirect Mint

Last updated 25 days ago

Use this endpoint to mint an existing rune as defined in

  • Runes are available on testnet only until block height 840000.

  • We allow the execution of n mints per order, dictated by the field numberOfMints

  • n mints will create n transactions

  • Minting transaction ids will appear in the order in the field mintingTxs

  • For every mint transaction the counter executedMints will be incremented

POST a new rune mint order

Mint Rune

POST https://api.ordinalsbot.com/runes/mint

Request Body

Name
Type
Description

rune*

String

Rune name

receiveAddress*

String

A single Bitcoin address to receive the rune balance for the whole order

fee*

Number

Miner fee that will be paid while inscribing the ordinals in sats/byte.

numberOfMints

Number

Number of times provided rune should be minted to receive address. (default=1)

referral

String

Referral code to earn up to %15 of the order service fee.

additionalFee

Number

Amount of satoshis to charge extra for this order that will be added to "referral" account.

Needs to be used together with "referral" parameter.

postage

Number

Set custom postage for the order's asset: minimum 330 sats, maximum 10,000 sats.

(default=546)

{
    "charge": {
        "id": "0128d9cd-5821-4f2e-b042-9124f8027b0f",
        "description": "e3124086-4f86-4b73-be2b-f5bcceea7d0b",
        "desc_hash": false,
        "created_at": 1713286060,
        "status": "unpaid",
        "amount": 24200,
        "success_url": null,
        "hosted_checkout_url": "https://checkout.dev.opennode.com/0128d9cd-5821-4f2e-b042-9124f8027b0f",
        "order_id": null,
        "currency": "BTC",
        "source_fiat_value": 24200,
        "fiat_value": 15.03,
        "auto_settle": false,
        "notif_email": null,
        "address": "2NG1xF8STPUhwtaTJyKUdGMai8GXs5mK8sy",
        "metadata": {},
        "chain_invoice": {
            "address": "2NG1xF8STPUhwtaTJyKUdGMai8GXs5mK8sy"
        },
        "uri": "bitcoin:2NG1xF8STPUhwtaTJyKUdGMai8GXs5mK8sy?amount=0.000242&label=e3124086-4f86-4b73-be2b-f5bcceea7d0b&lightning=lntb242u1pnpa2avpp5jh0f855vgg2zakshfce6zua8q7jfj3dkejwak93d52073c7vjevqdp6v5enzv35xqurvtf5vcurvtf5vgmnxttzv5exyttxx43xxcm9v4snwepsvgcqzzsxqy8ayqsp5ug9pp67ed0tq3064vu8fjhghmwwvq7w3zwyjk5mnmqukgjxjayws9qyyssq8kgsw4d6drsy346kag3jsxlzmzlkqr0fnpp0gy6f27kj9nmss4wx40r9qrmafc64kexe8tat6lj94y39cezay8drg9qtw4qyx57mg9qq4nfknr",
        "ttl": 4320,
        "lightning_invoice": {
            "expires_at": 1713545260,
            "payreq": "lntb242u1pnpa2avpp5jh0f855vgg2zakshfce6zua8q7jfj3dkejwak93d52073c7vjevqdp6v5enzv35xqurvtf5vcurvtf5vgmnxttzv5exyttxx43xxcm9v4snwepsvgcqzzsxqy8ayqsp5ug9pp67ed0tq3064vu8fjhghmwwvq7w3zwyjk5mnmqukgjxjayws9qyyssq8kgsw4d6drsy346kag3jsxlzmzlkqr0fnpp0gy6f27kj9nmss4wx40r9qrmafc64kexe8tat6lj94y39cezay8drg9qtw4qyx57mg9qq4nfknr"
        }
    },
    "paylink": {
        "id": "66xxx16", // visit https://app.hel.io/pay/66xxx16 to pay
    },
    "rune": "BITCOIN•HAS•A•CAT",
    "receiveAddress": "tb1qwejhagpav9rkrwpk55ul6pes6f89glpkpds487",
    "fee": 10,
    "chainFee": 2000,
    "serviceFee": 22200,
    "baseFee": 12000,
    "rareSatsFee": 0,
    "postage": 546,
    "additionalFee": null,
    "numberOfMints": 1,
    "id": "e3124086-4f86-4b73-be2b-f5bcceea7d0b",
    "orderType": "rune-mint",
    "state": "waiting-payment",
    "createdAt": {
        ".sv": "timestamp"
    },
    "executedMints": 0,
    "mintingTxs": []
}
{
    status: 'error',
    error: 'error reason'
}

// Here's a sample payload you can POST to create a rune mint order
{
    "rune": "MEGA•MEME•COIN",
    "fee": 8,
    "receiveAddress": "tb1pqwh3dxhg3k4szt9zm5kt8p0m97nl7k7zlmplehmr6alc4ut8xd5qams63p",
    "numberOfMints": 2,
}

https://docs.ordinals.com/runes.html#minting