unisat-dev-docs

Inscribe API V5 Migration

GET /v2/inscribe/order/summary remains supported. All other /v2/inscribe/* endpoints are deprecated. New integrations must use /v5/inscribe/*; deprecated V2 endpoints are retained only for existing clients while they migrate.

V5 uses the same bearer API key. When OpenAPI mode is enabled, every V5 order is scoped to the calling API application, so an order ID cannot be queried or operated on by another application.

Core Endpoint Mapping

Deprecated V2 endpoint V5 replacement Migration note
GET /v2/inscribe/order/summary GET /v5/inscribe/fees-config and GET /v5/inscribe/order/list V5 has no status-count summary. Use the order list for order state and fees-config for fee and eligibility data.
GET /v2/inscribe/order/list GET /v5/inscribe/order/list Send cursor, size, and a JSON-encoded filter query parameter.
GET /v2/inscribe/order/{orderId} GET /v5/inscribe/order/{orderId} V5 adds availableActions, availablePaymentMethods, outputValueFee, and optional compactFiles.
POST /v2/inscribe/order/create POST /v5/inscribe/order/create Replace receiveAddress with receiver; supply clientId, refundAddress, userAddress, and userPubkey.
POST /v2/inscribe/order/request-commit POST /v5/inscribe/order/request-commit V5 requires payerAddress and payerPubkey.
POST /v2/inscribe/order/sign-commit POST /v5/inscribe/order/sign-commit The signed PSBT remains in psbt.
POST /v2/inscribe/order/sign-reveal POST /v5/inscribe/order/sign-reveal The signed PSBT remains in psbt.
POST /v2/inscribe/order/{orderId}/refund-estimate POST /v5/inscribe/refund/estimate Move orderId from the path into the JSON body.
POST /v2/inscribe/order/{orderId}/refund POST /v5/inscribe/refund Move orderId into the JSON body and rename refundFeeRate to feeRate.

Protocol Endpoint Mapping

Deprecated V2 endpoint V5 replacement
POST /v2/inscribe/order/create/brc20-deploy POST /v5/inscribe/order/create
POST /v2/inscribe/order/create/brc20-mint POST /v5/inscribe/order/create or POST /v5/inscribe/order/repeat for a supported prior mint order
POST /v2/inscribe/order/create/brc20-transfer POST /v5/inscribe/order/create
POST /v2/inscribe/order/create/brc20-5byte-mint POST /v5/inscribe/order/create/brc20-5byte-mint
POST /v2/inscribe/order/request-commit/brc20-5byte-mint No V5 replacement. This signing step is not publicly available.
POST /v2/inscribe/order/sign-commit/brc20-5byte-mint No V5 replacement. This signing step is not publicly available.
POST /v2/inscribe/order/sign-reveal/brc20-5byte-mint No V5 replacement. This signing step is not publicly available.
POST /v2/inscribe/order/create/runes-etch POST /v5/inscribe/order/create/runes-etch
POST /v2/inscribe/order/create/runes-mint POST /v5/inscribe/order/create/runes-mint

For ordinary BRC-20 deploy, mint, and transfer inscriptions in V5, use the generic create endpoint and provide the protocol JSON as a files[].dataURL inscription. Use the dedicated V5 endpoints for 5-byte minting, Runes, Alkanes, Clockin, and multi-protocol minting.

Request Model Changes

See the generated Inscribe API V5 reference for the complete request and response schemas.