Create a Collection Order
Use this endpoint to create an inscription order that will inscribe a file from an existing collection.
The /collectionorder endpoint has a rate limit of maximum 2 requests every 10 seconds.
If pricing of the collection is in runes then
charge
will be null. Instead,tokenPayCharge
will be available. User needs to sendtokenPayCharge.feeCharge.amount
of BTC totokenPayCharge.feeCharge.address
andtokenPayCharge.tokenCharge.amount
of tokens totokenPayCharge.tokenCharge.address
Create Collection Order
POST
https://api.ordinalsbot.com/collectionorder
Headers
x-api-key*
String
API Key
Required if no turnstile token is present.
Request Body
collection*
Object
Object including
id: Collection slug to be inscribed
count: number of inscriptions being ordered.
receiveAddress
String
Bitcoin address to receive the inscriptions for the whole order
token*
String
Cloudflare turnstile token
Required if no x-api-key header is present.
rareSats
String
One of following options:
block9 | block78 | pizza | uncommon | black | vintage | random
Check /inventory
endpoint for all available options and their current availability.
fee*
Number
Mining fee to be paid for this collection inscription (sats/vB)
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.
Note: additionalFee is added PER FILE!
referral
String
Referral code to earn up to %15 of the order service fee.
timeout
Number
Order timeout in minutes. Must be a multiple of 10.
Generated payment invoice will be valid for this duration only. Payments that are sent after this will not be processed.
Refrain from using too short timeout values and instead use Create a Collection Order
(default=4320)
webhookUrl
String
webhook url to receive a POST payload for order updates
Refer to Webhooks for format of the webhook payload
{
status: 'ok',
..., // input parameters
charge: {
...
"id": "815xxx-xxx-xxx-xxx79",
"address": "3P...Vu",
"amount": 1218725,
"lightning_invoice": {
"expires_at": 1675786558,
"payreq": "lnbc1218...7qz9v"
},
"created_at": 1677176476,
},
paylink: {
"id": "66xxx16", // visit https://app.hel.io/pay/66xxx16 to pay
},
chainFee: 718725 // in satoshis
serviceFee: 100000, // in satoshis
orderType: 'bulk',
createdAt: 1675785959855, // timestamp in ms,
}
Last updated