Monitor Rune Etch Order

The Xverse API Runes Etching service monitors the confirmation of the confirmation of the minting transaction(s)

You can use this endpoint to track the status of your order and the related mint transactions, using the orderId obtained when you created your mint order

Quick Start

get

Get order details by ID.

Authorizations

apiKey

x-api-keystringRequired

Path parameters

orderIdstring · uuidRequired

Responses

200

Default Response

application/json

idstringRequired

orderTypestringRequired

statestringRequired

reasonstringRequired

createdAtstringRequired

fundingAddressstringOptional

orderDetailsobjectOptional

get

/v1/runes-managed/orders/{orderId}

HTTPcURLJavaScriptPython

GET /v1/runes-managed/orders/{orderId} HTTP/1.1
Host: api.secretkeylabs.io
x-api-key: YOUR_API_KEY
Accept: */*

200

Default Response

{
  "id": "text",
  "orderType": "text",
  "state": "text",
  "reason": "text",
  "createdAt": "text",
  "fundingAddress": "text",
  "orderDetails": {},
  "transactions": [
    {
      "txid": "text",
      "state": "text",
      "transactionType": "text",
      "broadcastSequence": 1,
      "batchNumber": 1
    }
  ]
}

Monitor Order - Response

Monitor Order - Response Object	Description
orderId	a string representing the id of your mint or etch order.
orderType	a string representing the nature of the order. The possible values are: runes_mint for a mint order runes_etch for an etch order
state	A string representing the current status of your order ℹ️See Execute Rune Mint Order & Execute Rune Etch Orderfor details on the rune order workflows The possible values are: new when the order has only just been created, and you have not broadcast a funding transaction yet pending when the order awaits the confirmation of the funding transaction before being processed executing when the order is being processed and the required runes mint/etch transactions are being broadcast. complete when the order has been processed and all runes mint/etch transactions have been confirmed. failed when the order has failed. See the reason property for the nature of the order failure. refunded when the funding transaction for a failed order has been refunded to your user's specified refund address stale when the order status hasn't progressed from the new state for an extended period of time
reason (ℹ️ optional)	If the order is in a failed state, a string representing the reason for the failure
createdAt	the creation date for the order (this is the date when the Create Rune Mint Order or Create Rune Etch Order endpoint was first called)
fundingAddress	a string representing the BTC address which will collect the funds required to process the order, and sign the required mint/etch transactions to process the order.