unisat-dev-docs

Inscribe API

This is UniSat Wallet Open API. If you wish to use the OpenAPI, please feel free to send us an email, and we will provide you with an API KEY.

👉 View Swagger UI

📑 Table of Contents

Route	Summary
GET /v2/inscribe/order/summary	Get order summary of current apikey
GET /v2/inscribe/order/list	Get order list of current apikey
GET /v2/inscribe/order/{orderId}	Search an order by orderId
POST /v2/inscribe/order/create	Create an order
POST /v2/inscribe/order/create/brc20-deploy	Create an order to inscribe BRC-20 DEPLOY
POST /v2/inscribe/order/create/brc20-mint	Create an order to inscribe BRC-20 MINT
POST /v2/inscribe/order/create/brc20-transfer	Create an order to inscribe BRC-20 TRANSFER
POST /v2/inscribe/order/create/brc20-5byte-mint	Create an order to inscribe BRC-20 MINT
POST /v2/inscribe/order/request-commit/brc20-5byte-mint	Request commit txs of brc20-5byte-mint
POST /v2/inscribe/order/sign-commit/brc20-5byte-mint	Sign commit txs of brc20-5byte-mint
POST /v2/inscribe/order/sign-reveal/brc20-5byte-mint	Sign reveal txs of brc20-5byte-mint
POST /v2/inscribe/order/create/runes-etch	Create an order to etch Runes
POST /v2/inscribe/order/create/runes-mint	Create an order to mint Runes
POST /v2/inscribe/order/{orderId}/refund	Process a refund for an order.
POST /v2/inscribe/order/{orderId}/refund-estimate	Estimate the size of the refund transaction

Inscribe

Get order summary of current apikey

Method: GET
Path: /v2/inscribe/order/summary
Swagger Link: View in Swagger UI

Response (200)

Get order list of current apikey

Method: GET
Path: /v2/inscribe/order/list
Swagger Link: View in Swagger UI

Description

Get order list of current apikey

Parameters

cursor (query) (required): Start offset
size (query) (required): Number of items returned
sort (query) : Sort by (asc/desc)
status (query) : Status of order
receiveAddress (query) : ReceiveAddress of order
clientId (query) : ClientId of order
withFiles (query) : Whether to include files

Response (200)

Notes

status (Optional) : pending/inscribing/minted/closed/refunded
receiveAddress (Optional): Filter by receive address
clientId (Optional): The clientId passed when creating an order is useful for filtering a certain user’s orders.

Search an order by orderId

Method: GET
Path: /v2/inscribe/order/{orderId}
Swagger Link: View in Swagger UI

Description

It’s recommended to query the latest status every 10 seconds.

amount = outputValue*count + minerFee + serviceFee + devFee

Parameters

orderId (path) (required):

Response (200)

Notes

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",
}

Create an order

Method: POST
Path: /v2/inscribe/order/create
Swagger Link: View in Swagger UI

Description

Create an order to inscribe something

Response (200)

Create an order to inscribe BRC-20 DEPLOY

Method: POST
Path: /v2/inscribe/order/create/brc20-deploy
Swagger Link: View in Swagger UI

Response (200)

Create an order to inscribe BRC-20 MINT

Method: POST
Path: /v2/inscribe/order/create/brc20-mint
Swagger Link: View in Swagger UI

Response (200)

Create an order to inscribe BRC-20 TRANSFER

Method: POST
Path: /v2/inscribe/order/create/brc20-transfer
Swagger Link: View in Swagger UI

Response (200)

Create an order to inscribe BRC-20 MINT

Method: POST
Path: /v2/inscribe/order/create/brc20-5byte-mint
Swagger Link: View in Swagger UI

Response (200)

Request commit txs of brc20-5byte-mint

Method: POST
Path: /v2/inscribe/order/request-commit/brc20-5byte-mint
Swagger Link: View in Swagger UI

Response (200)

Sign commit txs of brc20-5byte-mint

Method: POST
Path: /v2/inscribe/order/sign-commit/brc20-5byte-mint
Swagger Link: View in Swagger UI

Response (200)

Sign reveal txs of brc20-5byte-mint

Method: POST
Path: /v2/inscribe/order/sign-reveal/brc20-5byte-mint
Swagger Link: View in Swagger UI

Response (200)

Create an order to etch Runes

Method: POST
Path: /v2/inscribe/order/create/runes-etch
Swagger Link: View in Swagger UI

Response (200)

Create an order to mint Runes

Method: POST
Path: /v2/inscribe/order/create/runes-mint
Swagger Link: View in Swagger UI

Response (200)

Process a refund for an order.

Method: POST
Path: /v2/inscribe/order/{orderId}/refund
Swagger Link: View in Swagger UI

Description

When the amount paid by the user includes inscriptions, inscribing cannot be performed. Refund can be requested through this method.

Parameters

orderId (path) (required):

Response (200)

Estimate the size of the refund transaction

Method: POST
Path: /v2/inscribe/order/{orderId}/refund-estimate
Swagger Link: View in Swagger UI

Description

RefundAmount = PaidAmount - RefundTxSize * RefundFeeRate. This value must be greater than SafeRefundAmount, otherwise there’s a risk of losing inscriptions used for payment due to errors.

Parameters

orderId (path) (required):