Legacy V2 inscription API. GET /v2/inscribe/order/summary remains supported; all other V2 inscription endpoints are deprecated and new integrations must use the Inscribe API V5 endpoints under /inscribe-v5. See open-api/inscribe-v5-migration.md.
👉 View Swagger UI
| Route | Summary |
|---|---|
GET /v2/inscribe/order/summary |
Summarize inscription order counts |
GET /v2/inscribe/order/list |
List inscription orders with status details |
GET /v2/inscribe/order/(orderId) |
Get one inscription order state |
POST /v2/inscribe/order/create |
Create generic inscription payment order |
POST /v2/inscribe/order/create/brc20-deploy |
Create deprecated BRC-20 deploy inscription order |
POST /v2/inscribe/order/create/brc20-mint |
Create deprecated BRC-20 mint inscription order |
POST /v2/inscribe/order/create/brc20-transfer |
Create deprecated BRC-20 transfer inscription order |
POST /v2/inscribe/order/request-commit |
Prepare inscription commit PSBT |
POST /v2/inscribe/order/sign-commit |
Submit signed inscription commit PSBT |
POST /v2/inscribe/order/sign-reveal |
Submit signed inscription reveal PSBT |
POST /v2/inscribe/order/create/brc20-5byte-mint |
Create deprecated BRC-20 5-byte mint order |
POST /v2/inscribe/order/request-commit/brc20-5byte-mint |
Prepare deprecated 5-byte commit PSBT |
POST /v2/inscribe/order/sign-commit/brc20-5byte-mint |
Submit deprecated signed 5-byte commit |
POST /v2/inscribe/order/sign-reveal/brc20-5byte-mint |
Submit deprecated signed 5-byte reveal |
POST /v2/inscribe/order/create/runes-etch |
Create Runes etch inscription order |
POST /v2/inscribe/order/create/runes-mint |
Create Runes mint inscription order |
POST /v2/inscribe/order/(orderId)/refund |
Submit inscription order refund |
POST /v2/inscribe/order/(orderId)/refund-estimate |
Estimate inscription refund amount |
Method: GET
Path: /v2/inscribe/order/summary
Swagger Link: View in Swagger UI
Returns orderCount totals by status for the current API key, including pending, inscribing, minted, closed, and refunded buckets. Use it for dashboard totals and reconcile the counts before drilling into order lists; it never creates payment state or broadcasts transactions.
Successful operation
code (integer (int32)):msg (string): example: "OK"data (object):
orderCount (object):
total (integer):pendingCount (integer):inscribingCount (integer):mintedCount (integer):closedCount (integer):refundedCount (integer):Invalid API Key
Method: GET
Path: /v2/inscribe/order/list
Swagger Link: View in Swagger UI
Returns paginated inscription orders, including orderId, status, payment amounts, receiveAddress, fee fields, counts, and optional file details. Use it to monitor order progress or reconcile payments; check status, paidAmount, amount, and files before taking follow-up signing or refund actions.
cursor (query, integer) (required): Start offsetsize (query, integer) (required): Number of items returnedsort (query, string): Sort by (asc/desc); enum: asc, descstatus (query, string): Status of order; enum: pending, inscribing, minted, closed, refundedreceiveAddress (query, string): ReceiveAddress of orderclientId (query, string): ClientId of orderwithFiles (query, boolean): Whether to include filesSuccessful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
detail (array):
orderId (string): example: ""status (string): Order Status; enum: pending, inscribing, minted; example: "pending"payAddress (string): Pay to this address to start inscribing; example: ""receiveAddress (string): Bitcoin address to receive the inscriptions; example: ""amount (integer): The BTC amount (in satoshis) need to pay; example: 3000paidAmount (integer): The paid BTC amount (in satoshis)outputValue (integer): The outputValue of each inscriptionfeeRate (number): The feeRate of inscribing transactionsminerFee (number): The miner fee of this orderserviceFee (number): The service fee of this orderdevFee (number): The developer fee of this orderfiles (array):
filename (string): example: "10000.sats"inscriptionId (string): example: ""status (string): enum: pending, unconfirmed, confirmedcount (integer): The total inscriptions count; example: 1pendingCount (integer): The pending inscriptions count; example: 1unconfirmedCount (integer (int32)): The unconfirmed inscriptions count; example: 0confirmedCount (integer (int32)): The confirmed inscriptions count; example: 0createTime (integer): example: 1693439128100refundTxid (string): example: ""refundAmount (integer):refundFeeRate (number):start (integer):total (integer):Invalid API Key
Method: GET
Path: /v2/inscribe/order/{orderId}
Swagger Link: View in Swagger UI
Returns a single order with status, payAddress, receiveAddress, paidAmount, required amount, fee breakdown, inscription counts, file statuses, and refund fields. Poll it before payment, commit signing, reveal signing, or refund decisions; verify status and amount fields because this endpoint is read-only.
orderId (path, string) (required):Successful operation
code (integer (int32)):msg (string): example: "OK"data (object):
orderId (string): example: ""status (string): Order Status; enum: pending, inscribing, minted; example: "pending"payAddress (string): Pay to this address to start inscribing; example: ""receiveAddress (string): Bitcoin address to receive the inscriptions; example: ""amount (integer): The BTC amount (in satoshis) need to pay; example: 3000paidAmount (integer): The paid BTC amount (in satoshis)outputValue (integer): The outputValue of each inscriptionfeeRate (number): The feeRate of inscribing transactionsminerFee (number): The miner fee of this orderserviceFee (number): The service fee of this orderdevFee (number): The developer fee of this orderfiles (array):
filename (string): example: "10000.sats"inscriptionId (string): example: ""status (string): enum: pending, unconfirmed, confirmedcount (integer): The total inscriptions count; example: 1pendingCount (integer): The pending inscriptions count; example: 1unconfirmedCount (integer (int32)): The unconfirmed inscriptions count; example: 0confirmedCount (integer (int32)): The confirmed inscriptions count; example: 0createTime (integer): example: 1693439128100refundTxid (string): example: ""refundAmount (integer):refundFeeRate (number):Invalid API Key
enum OrderStatus {
// when create order
pending = "pending",
// pay not enough, need pay more
payment_notenough = "payment_notenough",
// pay over, need choose continue or refund
payment_overpay = "payment_overpay",
// there is an inscription in payment transaction, need refund
payment_withinscription = "payment_withinscription",
// in some case, payment transaction need be confirmed
payment_waitconfirmed = "payment_waitconfirmed",
// payment success
payment_success = "payment_success",
// ready to inscribe
ready = "ready",
inscribing = "inscribing",
minted = "minted",
closed = "closed",
refunded = "refunded",
cancel = "cancel",
}
enum InscriptionStatus {
pending = "pending",
unconfirmed = "unconfirmed",
confirmed = "confirmed",
}
Method: POST
Path: /v2/inscribe/order/create
Swagger Link: View in Swagger UI
Creates an inscription order for arbitrary files and returns orderId, payAddress, required amount, receiveAddress, fee breakdown, and order/file status. Confirm receiveAddress, file data, outputValue, feeRate, dev fee fields, and expected payment amount before calling because it starts payable order state.
Content-Type: application/json (required)
receiveAddress (string): Bitcoin address to receive the inscriptionsfeeRate (number (float)): The fee rate of transaction; example: 1outputValue (integer (int32)): The balance of inscription; example: 546files (array): example: [{"filename":"1000.sats","dataURL":"data:text/plain;charset=utf-8;base64,eyJwIjoic25zIiwib3AiOiJyZWciLCJuYW1lIjoiMTAwMDAuc2F0cyJ9"}]
filename (string):dataURL (string):devAddress (string): Developer address to receive extra feedevFee (integer (int32)): Extra fee to pay to developer’s addressSuccessful operation
code (integer (int32)):msg (string):data (object):
orderId (string): example: ""status (string): Order Status; enum: pending, inscribing, minted; example: "pending"payAddress (string): Pay to this address to start inscribing; example: ""receiveAddress (string): Bitcoin address to receive the inscriptions; example: ""amount (integer): The BTC amount (in satoshis) need to pay; example: 3000paidAmount (integer): The paid BTC amount (in satoshis)outputValue (integer): The outputValue of each inscriptionfeeRate (number): The feeRate of inscribing transactionsminerFee (number): The miner fee of this orderserviceFee (number): The service fee of this orderdevFee (number): The developer fee of this orderfiles (array):
filename (string): example: "10000.sats"inscriptionId (string): example: ""status (string): enum: pending, unconfirmed, confirmedcount (integer): The total inscriptions count; example: 1pendingCount (integer): The pending inscriptions count; example: 1unconfirmedCount (integer (int32)): The unconfirmed inscriptions count; example: 0confirmedCount (integer (int32)): The confirmed inscriptions count; example: 0createTime (integer): example: 1693439128100refundTxid (string): example: ""refundAmount (integer):refundFeeRate (number):Invalid API Key
Method: POST
Path: /v2/inscribe/order/create/brc20-deploy
Swagger Link: View in Swagger UI
Creates a payable inscription order for legacy BRC-20 deploy content and returns orderId, payAddress, amount, receiveAddress, fee fields, and status. Confirm ticker, max, limit, receiveAddress, feeRate, outputValue, and payment amount before use; prefer newer workflows when available.
Content-Type: application/json (required)
receiveAddress (string): Bitcoin address to receive the inscriptions; example: ""feeRate (number (float)): The fee rate of transaction; example: 1outputValue (integer (int32)): The balance of inscription; example: 546devAddress (string): Developer address to receive extra fee; example: ""devFee (integer (int32)): Extra fee to pay to developer’s addressbrc20Ticker (string): tick in brc20-deploy; example: ""brc20Max (string): max in brc20-deploy; example: ""brc20Limit (string): lim in brc20-deploy; example: ""Successful operation
code (integer (int32)):msg (string):data (object):
orderId (string): example: ""status (string): Order Status; enum: pending, inscribing, minted; example: "pending"payAddress (string): Pay to this address to start inscribing; example: ""receiveAddress (string): Bitcoin address to receive the inscriptions; example: ""amount (integer): The BTC amount (in satoshis) need to pay; example: 3000paidAmount (integer): The paid BTC amount (in satoshis)outputValue (integer): The outputValue of each inscriptionfeeRate (number): The feeRate of inscribing transactionsminerFee (number): The miner fee of this orderserviceFee (number): The service fee of this orderdevFee (number): The developer fee of this orderfiles (array):
filename (string): example: "10000.sats"inscriptionId (string): example: ""status (string): enum: pending, unconfirmed, confirmedcount (integer): The total inscriptions count; example: 1pendingCount (integer): The pending inscriptions count; example: 1unconfirmedCount (integer (int32)): The unconfirmed inscriptions count; example: 0confirmedCount (integer (int32)): The confirmed inscriptions count; example: 0createTime (integer): example: 1693439128100refundTxid (string): example: ""refundAmount (integer):refundFeeRate (number):Invalid API Key
Method: POST
Path: /v2/inscribe/order/create/brc20-mint
Swagger Link: View in Swagger UI
Creates a payable inscription order for legacy BRC-20 mint content and returns orderId, payAddress, amount, receiveAddress, fee fields, and status. Confirm ticker, mint amount, count, receiveAddress, feeRate, outputValue, and total payment before use; prefer newer workflows when available.
Content-Type: application/json (required)
receiveAddress (string): Bitcoin address to receive the inscriptions; example: ""feeRate (number (float)): The fee rate of transaction; example: 1outputValue (integer (int32)): The balance of inscription; example: 546devAddress (string): Developer address to receive extra fee; example: ""devFee (integer (int32)): Extra fee to pay to developer’s addressbrc20Ticker (string): tick in brc20-mint; example: ""brc20Amount (string): amt in brc20-mint; example: ""count (integer (int32)): Repetition count; example: 1Successful operation
code (integer (int32)):msg (string):data (object):
orderId (string): example: ""status (string): Order Status; enum: pending, inscribing, minted; example: "pending"payAddress (string): Pay to this address to start inscribing; example: ""receiveAddress (string): Bitcoin address to receive the inscriptions; example: ""amount (integer): The BTC amount (in satoshis) need to pay; example: 3000paidAmount (integer): The paid BTC amount (in satoshis)outputValue (integer): The outputValue of each inscriptionfeeRate (number): The feeRate of inscribing transactionsminerFee (number): The miner fee of this orderserviceFee (number): The service fee of this orderdevFee (number): The developer fee of this orderfiles (array):
filename (string): example: "10000.sats"inscriptionId (string): example: ""status (string): enum: pending, unconfirmed, confirmedcount (integer): The total inscriptions count; example: 1pendingCount (integer): The pending inscriptions count; example: 1unconfirmedCount (integer (int32)): The unconfirmed inscriptions count; example: 0confirmedCount (integer (int32)): The confirmed inscriptions count; example: 0createTime (integer): example: 1693439128100refundTxid (string): example: ""refundAmount (integer):refundFeeRate (number):Invalid API Key
Method: POST
Path: /v2/inscribe/order/create/brc20-transfer
Swagger Link: View in Swagger UI
Creates a payable inscription order for legacy BRC-20 transfer content and returns orderId, payAddress, amount, receiveAddress, fee fields, and status. Confirm ticker, transfer amount, receiveAddress, feeRate, outputValue, and payment amount before use; prefer newer workflows when available.
Content-Type: application/json (required)
receiveAddress (string): Bitcoin address to receive the inscriptions; example: ""feeRate (number (float)): The fee rate of transaction; example: 1outputValue (integer (int32)): The balance of inscription; example: 546devAddress (string): Developer address to receive extra fee; example: ""devFee (integer (int32)): Extra fee to pay to developer’s addressbrc20Ticker (string): tick in brc20-transfer; example: ""brc20Amount (string): amt in brc20-transfer; example: ""Successful operation
code (integer (int32)):msg (string):data (object):
orderId (string): example: ""status (string): Order Status; enum: pending, inscribing, minted; example: "pending"payAddress (string): Pay to this address to start inscribing; example: ""receiveAddress (string): Bitcoin address to receive the inscriptions; example: ""amount (integer): The BTC amount (in satoshis) need to pay; example: 3000paidAmount (integer): The paid BTC amount (in satoshis)outputValue (integer): The outputValue of each inscriptionfeeRate (number): The feeRate of inscribing transactionsminerFee (number): The miner fee of this orderserviceFee (number): The service fee of this orderdevFee (number): The developer fee of this orderfiles (array):
filename (string): example: "10000.sats"inscriptionId (string): example: ""status (string): enum: pending, unconfirmed, confirmedcount (integer): The total inscriptions count; example: 1pendingCount (integer): The pending inscriptions count; example: 1unconfirmedCount (integer (int32)): The unconfirmed inscriptions count; example: 0confirmedCount (integer (int32)): The confirmed inscriptions count; example: 0createTime (integer): example: 1693439128100refundTxid (string): example: ""refundAmount (integer):refundFeeRate (number):Invalid API Key
Method: POST
Path: /v2/inscribe/order/request-commit
Swagger Link: View in Swagger UI
Returns commit transaction PSBT hex and inputsToSign for a paid inscription order. Confirm orderId, payerAddress, payerPubkey, payment status, and signing indexes before signing; this prepares spend material but later sign endpoints advance the on-chain workflow.
Content-Type: application/json (required)
orderId (string): orderId; example: ""payerAddress (string): payer’s bitcoin address; example: ""payerPubkey (string): payer’s pubkey; example: ""Successful operation
code (integer (int32)):msg (string):data (object):
psbtHex (string): psbt hex string; example: ""inputsToSign (array):
address (string):signingIndexes (array):Invalid API Key
Method: POST
Path: /v2/inscribe/order/sign-commit
Swagger Link: View in Swagger UI
Submits the signed commit PSBT for an inscription order and returns next-step PSBT/signing material when accepted. Verify orderId, PSBT content, payer inputs, payment amount, and fee assumptions before calling because it advances the transaction workflow.
Content-Type: application/json (required)
orderId (string): orderId; example: ""psbt (string): psbt hex string; example: ""Successful operation
code (integer (int32)):msg (string):data (object):
psbtHex (string): psbt hex string; example: ""inputsToSign (array):
address (string):signingIndexes (array):Invalid API Key
Method: POST
Path: /v2/inscribe/order/sign-reveal
Swagger Link: View in Swagger UI
Submits the signed reveal PSBT and returns the resulting inscriptionId when the reveal is accepted. Verify orderId, PSBT content, receiveAddress, file payload, and fees before calling because this can finalize inscription creation on-chain.
Content-Type: application/json (required)
orderId (string): orderId; example: ""psbt (string): psbt hex string; example: ""Successful operation
code (integer (int32)):msg (string):data (object):
inscriptionId (string): inscriptionId; example: ""Invalid API Key
Method: POST
Path: /v2/inscribe/order/create/brc20-5byte-mint
Swagger Link: View in Swagger UI
Creates a payable inscription order for legacy BRC-20 5-byte mint content and returns orderId, payAddress, amount, receiveAddress, fee fields, and status. Confirm deployer address/pubkey, ticker, mint amount, receiveAddress, feeRate, outputValue, and payment amount before use; prefer newer workflows when available.
Content-Type: application/json (required)
deployerAddress (string): The deployer address that deployed the ticker; example: ""deployerPubkey (string): The deployer pubkey that deployed the ticker; example: ""receiveAddress (string): Bitcoin address to receive the inscriptions; example: ""feeRate (number (float)): The fee rate of transaction; example: 1outputValue (integer (int32)): The balance of inscription; example: 546devAddress (string): Developer address to receive extra fee; example: ""devFee (integer (int32)): Extra fee to pay to developer’s addressbrc20Ticker (string): tick in brc20-mint; example: ""brc20Amount (string): amt in brc20-mint; example: ""Successful operation
code (integer (int32)):msg (string):data (object):
orderId (string): example: ""status (string): Order Status; enum: pending, inscribing, minted; example: "pending"payAddress (string): Pay to this address to start inscribing; example: ""receiveAddress (string): Bitcoin address to receive the inscriptions; example: ""amount (integer): The BTC amount (in satoshis) need to pay; example: 3000paidAmount (integer): The paid BTC amount (in satoshis)outputValue (integer): The outputValue of each inscriptionfeeRate (number): The feeRate of inscribing transactionsminerFee (number): The miner fee of this orderserviceFee (number): The service fee of this orderdevFee (number): The developer fee of this orderfiles (array):
filename (string): example: "10000.sats"inscriptionId (string): example: ""status (string): enum: pending, unconfirmed, confirmedcount (integer): The total inscriptions count; example: 1pendingCount (integer): The pending inscriptions count; example: 1unconfirmedCount (integer (int32)): The unconfirmed inscriptions count; example: 0confirmedCount (integer (int32)): The confirmed inscriptions count; example: 0createTime (integer): example: 1693439128100refundTxid (string): example: ""refundAmount (integer):refundFeeRate (number):Invalid API Key
Method: POST
Path: /v2/inscribe/order/request-commit/brc20-5byte-mint
Swagger Link: View in Swagger UI
Returns commit PSBT hex and inputsToSign for a paid legacy BRC-20 5-byte mint order. Confirm orderId, payerAddress, payerPubkey, payment status, and signing indexes before signing; deprecated endpoint kept for compatibility.
Content-Type: application/json (required)
orderId (string): orderId; example: ""payerAddress (string): payer’s bitcoin address; example: ""payerPubkey (string): payer’s pubkey; example: ""Successful operation
code (integer (int32)):msg (string):data (object):
psbtHex (string): psbt hex string; example: ""inputsToSign (array):
address (string):signingIndexes (array):Invalid API Key
Method: POST
Path: /v2/inscribe/order/sign-commit/brc20-5byte-mint
Swagger Link: View in Swagger UI
Submits the signed commit PSBT for a legacy BRC-20 5-byte mint order and returns next-step PSBT/signing material when accepted. Verify orderId, PSBT content, payer inputs, payment amount, and fees before calling; deprecated endpoint kept for compatibility.
Content-Type: application/json (required)
orderId (string): orderId; example: ""psbt (string): psbt hex string; example: ""Successful operation
code (integer (int32)):msg (string):data (object):
psbtHex (string): psbt hex string; example: ""inputsToSign (array):
address (string):signingIndexes (array):Invalid API Key
Method: POST
Path: /v2/inscribe/order/sign-reveal/brc20-5byte-mint
Swagger Link: View in Swagger UI
Submits the signed reveal PSBT for a legacy BRC-20 5-byte mint order and returns inscriptionId when accepted. Verify orderId, PSBT content, receiveAddress, inscription payload, and fees before calling; deprecated endpoint kept for compatibility.
Content-Type: application/json (required)
orderId (string): orderId; example: ""psbt (string): psbt hex string; example: ""Successful operation
code (integer (int32)):msg (string):data (object):
inscriptionId (string): inscriptionId; example: ""Invalid API Key
Method: POST
Path: /v2/inscribe/order/create/runes-etch
Swagger Link: View in Swagger UI
Creates a payable inscription order for Runes etching and returns orderId, payAddress, amount, receiveAddress, fee fields, and status. Confirm rune name/symbol/divisibility, premine and terms, file payload, receiveAddress, feeRate, outputValue, and total payment before calling.
Content-Type: application/json (required)
receiveAddress (string): Bitcoin address to receive the inscriptions; example: ""feeRate (number (float)): The fee rate of transaction; example: 1outputValue (integer (int32)): The balance of inscription; example: 546files (array): example: [{"filename":"logo","dataURL":"data:text/plain;charset=utf-8;base64,eyJwIjoic25zIiwib3AiOiJyZWciLCJuYW1lIjoiMTAwMDAuc2F0cyJ9","runes_etch":{"etching":{"spacedRune":"AAAABBBBB","symbol":"G","divisibility":0,"premine":100,"terms":{"amount":1000,"cap":21000000,"height":[840000,880000],"offset":[0,10000]}}}}]
filename (string):dataURL (string):runes_etch (object):
etching (object):
spacedRune (string):symbol (string):divisibility (integer):premine (string):terms (object):
amount (string):cap (string):height (array):offset (array):devAddress (string): Developer address to receive extra feedevFee (integer (int32)): Extra fee to pay to developer’s addressSuccessful operation
code (integer (int32)):msg (string):data (object):
orderId (string): example: ""status (string): Order Status; enum: pending, inscribing, minted; example: "pending"payAddress (string): Pay to this address to start inscribing; example: ""receiveAddress (string): Bitcoin address to receive the inscriptions; example: ""amount (integer): The BTC amount (in satoshis) need to pay; example: 3000paidAmount (integer): The paid BTC amount (in satoshis)outputValue (integer): The outputValue of each inscriptionfeeRate (number): The feeRate of inscribing transactionsminerFee (number): The miner fee of this orderserviceFee (number): The service fee of this orderdevFee (number): The developer fee of this orderfiles (array):
filename (string): example: "10000.sats"inscriptionId (string): example: ""status (string): enum: pending, unconfirmed, confirmedcount (integer): The total inscriptions count; example: 1pendingCount (integer): The pending inscriptions count; example: 1unconfirmedCount (integer (int32)): The unconfirmed inscriptions count; example: 0confirmedCount (integer (int32)): The confirmed inscriptions count; example: 0createTime (integer): example: 1693439128100refundTxid (string): example: ""refundAmount (integer):refundFeeRate (number):Invalid API Key
Method: POST
Path: /v2/inscribe/order/create/runes-mint
Swagger Link: View in Swagger UI
Creates a payable inscription order for Runes minting and returns orderId, payAddress, amount, receiveAddress, fee fields, and status. Confirm runeid, count, receiveAddress, feeRate, outputValue, dev fee fields, and total payment before calling.
Content-Type: application/json (required)
receiveAddress (string): Bitcoin address to receive the inscriptions; example: ""feeRate (number (float)): The fee rate of transaction; example: 1outputValue (integer (int32)): The balance of inscription; example: 546runeid (string): example: "848484:10"count (integer): example: 2devAddress (string): Developer address to receive extra feedevFee (integer (int32)): Extra fee to pay to developer’s addressSuccessful operation
code (integer (int32)):msg (string):data (object):
orderId (string): example: ""status (string): Order Status; enum: pending, inscribing, minted; example: "pending"payAddress (string): Pay to this address to start inscribing; example: ""receiveAddress (string): Bitcoin address to receive the inscriptions; example: ""amount (integer): The BTC amount (in satoshis) need to pay; example: 3000paidAmount (integer): The paid BTC amount (in satoshis)outputValue (integer): The outputValue of each inscriptionfeeRate (number): The feeRate of inscribing transactionsminerFee (number): The miner fee of this orderserviceFee (number): The service fee of this orderdevFee (number): The developer fee of this orderfiles (array):
filename (string): example: "10000.sats"inscriptionId (string): example: ""status (string): enum: pending, unconfirmed, confirmedcount (integer): The total inscriptions count; example: 1pendingCount (integer): The pending inscriptions count; example: 1unconfirmedCount (integer (int32)): The unconfirmed inscriptions count; example: 0confirmedCount (integer (int32)): The confirmed inscriptions count; example: 0createTime (integer): example: 1693439128100refundTxid (string): example: ""refundAmount (integer):refundFeeRate (number):Invalid API Key
Method: POST
Path: /v2/inscribe/order/{orderId}/refund
Swagger Link: View in Swagger UI
Requests a refund transaction for a paid inscription order and returns the refund txid when accepted. Verify orderId, order status, paidAmount, safe refund amount, refundFeeRate, and destination assumptions before calling because it can move funds.
orderId (path, string) (required):Content-Type: application/json (required)
refundFeeRate (number (float)): example: 1Successful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
txid (string): txid of refunded transactionInvalid API Key
Method: POST
Path: /v2/inscribe/order/{orderId}/refund-estimate
Swagger Link: View in Swagger UI
Returns paidAmount, refundTxSize, and safeRefundAmount for an inscription order refund check. Use it before refund submission to compare fee impact and recoverable value; it never creates, signs, or broadcasts the refund transaction.
orderId (path, string) (required):Successful operation
code (integer (int32)): enum: 0, -1msg (string): example: "OK"data (object):
paidAmount (integer (int32)):refundTxSize (integer (int32)): The refund amount = size * refundFeeRatesafeRefundAmount (integer (int32)):Invalid API Key