Airdrop

The airdrop consists of two steps:

1. PSBT construction

2. Order creation & broadcast

1. PSBT Construction

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

Receives the airdrop data and returns the PSBT to be signed

Headers

Body

Name	Type	Description
runeName*	String	Rune name with spacers
perAddressAmount*	Number	Amount to distribute to each address
runeSenderAddress*	String	Bitcoin address containing the necessary rune amount
runeSenderPublicKey	String	Public key corresponding to the runeSenderAddress (needed for taproot)
btcSenderAddress*	String	Bitcoin address containing the necessary btc amount for network fees and postage
btcSenderPublicKey	String	Public key corresponding to the btcSenderAddress (needed for taproot)
receiverAddresses*	Array	Array of addresses to receive the airdrop (max 2000 addresses)
feeRate*	Number	Fee rate in sats/vB
excludeUTXOs	Array of outpoints ["txid:vout"]	Array containing UTXOs not to spend
simulateFee	Boolean	If true, only return fee estimation (Default = false)

Response

200: OK

{
    "psbt":"cHNidP8BAHECAAAAAfPQ0OTWpSxwRJK...",
    "chainFee": 1000,
    "serviceFee": 100
}

500: Internal Server Error

{
    "status": "error",
    "error": "error reason"
}

400: Bad Request

2. Order creation & broadcast

POST https://api.ordinalsbot.com/runes/airdrop-psbt

Receives the signed PSBTs, creates an order and broadcasts the transaction

Body

Name	Type	Description
psbt	String	Signed PSBTs in base64 to broadcast
runeName	String	Valid rune name corresponding to the airdrop

Response

200: OK

{
    "runeName": "RuneName",
    "psbts": [
        "cHNidP8BAHECAAAAAfPQ0OTWpSxwRJK..."
    ],
    "orderType": "rune-airdrop",
    "id": "76d1a25b-1e56-4476-8a98-d248f1ab5f95",
    "status": "ok",
    "state": "queued",
    "createdAt": {
        ".sv": "timestamp"
    }
}

500: Internal Server Error

{
    "status": "error",
    "error": "error reason"
}

400: Bad Request

{
  "error": "Invalid request"
}