V2 is deprecated. For new integrations, follow the Inscribe API V5 migration guide. This guide’s V2 examples are retained for existing integrations only.
BRC-20 (4-byte) is the most standard and commonly used BRC-20 token protocol, with a ticker consisting of 4 characters. It supports three operations: Deploy, Mint, and Transfer.
Features:
POST /v2/inscribe/order/create
Create a new BRC-20 token. Each token can only be deployed once, first come first served.
| Parameter | Type | Required | Description |
|---|---|---|---|
| receiveAddress | string | Yes | Bitcoin address to receive the inscription |
| feeRate | number | Yes | Transaction fee rate (sat/vB) |
| outputValue | integer | Yes | UTXO amount for inscription (recommended 546) |
| brc20_deploy | object | Yes | BRC-20 deployment parameter object |
| devAddress | string | No | Developer address |
| devFee | integer | No | Developer fee |
| Parameter | Type | Required | Description |
|---|---|---|---|
| ticker | string | Yes | BRC-20 token ticker (4 characters) |
| max | string | Yes | Maximum supply |
| limit | string | Yes | Mint limit per transaction |
| decimal | string | No | Decimal places (default “18”, range 0-18) |
| selfMint | boolean | No | Whether only deployer can mint (default false, public) |
curl -X POST "https://open-api.unisat.io/v2/inscribe/order/create" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"receiveAddress": "bc1p...",
"feeRate": 10,
"outputValue": 546,
"brc20_deploy": {
"ticker": "ordi",
"max": "21000000",
"limit": "1000",
"decimal": "18"
}
}'
{
"p": "brc-20",
"op": "deploy",
"tick": "ordi",
"max": "21000000",
"lim": "1000",
"dec": "18"
}
orderId, payAddress, and amountamount sats to payAddressinscribing statusmintedordi, sats)POST /v2/inscribe/order/create
Mint a deployed BRC-20 token. Multiple identical mint inscriptions can be batch minted.
| Parameter | Type | Required | Description |
|---|---|---|---|
| receiveAddress | string | Yes | Bitcoin address to receive the inscription |
| feeRate | number | Yes | Transaction fee rate (sat/vB) |
| outputValue | integer | Yes | UTXO amount for inscription (recommended 546) |
| brc20_mint | object | Yes | BRC-20 mint parameter object |
| count | integer | Yes | Repeat mint count (default 1, max 1000) |
| devAddress | string | No | Developer address |
| devFee | integer | No | Developer fee |
| Parameter | Type | Required | Description |
|---|---|---|---|
| ticker | string | Yes | BRC-20 token ticker to mint |
| amount | string | Yes | Amount to mint per transaction |
curl -X POST "https://open-api.unisat.io/v2/inscribe/order/create" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"receiveAddress": "bc1p...",
"feeRate": 10,
"outputValue": 546,
"brc20_mint": {
"ticker": "ordi",
"amount": "1000"
},
"count": 10
}'
{
"p": "brc-20",
"op": "mint",
"tick": "ordi",
"amt": "1000"
}
Same as Deploy:
amount to payAddressmintedUse the count parameter to mint multiple identical mint inscriptions at once:
{
"brc20_mint": {
"ticker": "ordi",
"amount": "1000"
},
"count": 100 // Mint 100 mint inscriptions
}
limit set during deploymentmax maximum supplycount parameter maximum is 1000POST /v2/inscribe/order/create
Create a BRC-20 transfer inscription. This is the first step of BRC-20 transfer (inscribe transfer inscription), the second step is to send the inscription to the target address.
| Parameter | Type | Required | Description |
|---|---|---|---|
| receiveAddress | string | Yes | Bitcoin address to receive the inscription |
| feeRate | number | Yes | Transaction fee rate (sat/vB) |
| outputValue | integer | Yes | UTXO amount for inscription (recommended 546) |
| brc20_transfer | object | Yes | BRC-20 transfer parameter object |
| devAddress | string | No | Developer address |
| devFee | integer | No | Developer fee |
| Parameter | Type | Required | Description |
|---|---|---|---|
| ticker | string | Yes | BRC-20 token ticker |
| amount | string | Yes | Transfer amount (amt) |
curl -X POST "https://open-api.unisat.io/v2/inscribe/order/create" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"receiveAddress": "bc1p...",
"feeRate": 10,
"outputValue": 546,
"brc20_transfer": {
"ticker": "ordi",
"amount": "500"
}
}'
{
"p": "brc-20",
"op": "transfer",
"tick": "ordi",
"amt": "500"
}
Use the above endpoint to create a transfer inscription.
Query order status and wait for it to become minted.
Send the inscription UTXO to the target address:
// Send inscription using UniSat wallet
await window.unisat.sendInscription(
targetAddress, // Target address
inscriptionId, // Transfer inscription ID
{ feeRate: 10 }
);
// 1. Deploy token
async function deployBRC20() {
const response = await fetch(
"https://open-api.unisat.io/v2/inscribe/order/create",
{
method: "POST",
headers: {
Authorization: `Bearer ${API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
receiveAddress: "bc1p...",
feeRate: 10,
outputValue: 546,
brc20_deploy: {
ticker: "test",
max: "21000000",
limit: "1000",
decimal: "18",
},
}),
}
);
const { data } = await response.json();
console.log("Order ID:", data.orderId);
console.log("Pay to:", data.payAddress);
console.log("Amount:", data.amount, "sats");
return data;
}
// 2. Mint token
async function mintBRC20() {
const response = await fetch(
"https://open-api.unisat.io/v2/inscribe/order/create",
{
method: "POST",
headers: {
Authorization: `Bearer ${API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
receiveAddress: "bc1p...",
feeRate: 10,
outputValue: 546,
brc20_mint: {
ticker: "test",
amount: "1000",
},
count: 10,
}),
}
);
const { data } = await response.json();
return data;
}
// 3. Create transfer inscription
async function createTransferBRC20() {
const response = await fetch(
"https://open-api.unisat.io/v2/inscribe/order/create",
{
method: "POST",
headers: {
Authorization: `Bearer ${API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
receiveAddress: "bc1p...",
feeRate: 10,
outputValue: 546,
brc20_transfer: {
ticker: "test",
amount: "500",
},
}),
}
);
const { data } = await response.json();
return data;
}
// 4. Check order status
async function checkOrderStatus(orderId) {
const response = await fetch(
`https://open-api.unisat.io/v2/inscribe/order/${orderId}`,
{
headers: {
Authorization: `Bearer ${API_KEY}`,
},
}
);
const { data } = await response.json();
console.log("Order Status:", data.status);
return data;
}
// 5. Complete flow
async function fullBRC20Flow() {
// Deploy
console.log("=== Deploying BRC-20 ===");
const deployOrder = await deployBRC20();
// Manually pay to deployOrder.payAddress
// Mint
console.log("=== Minting BRC-20 ===");
const mintOrder = await mintBRC20();
// Manually pay to mintOrder.payAddress
// Create transfer inscription
console.log("=== Creating Transfer Inscription ===");
const transferOrder = await createTransferBRC20();
// Manually pay to transferOrder.payAddress
// After inscription is complete, use wallet to send transfer inscription
}
A: Must be 4 characters, can include letters and numbers, case-insensitive. Examples:
ordi, sats, pepe, memeabc (less than 4 characters)abcde (more than 4 characters)A: Use UniSat’s BRC-20 Indexer API to query:
GET /v1/indexer/brc20/{ticker}/info
A:
A: No. Each transfer inscription can only be used once. It’s consumed after sending.
A: If inscription succeeds but token is already fully minted, the inscription is still valid but token balance won’t increase. It’s recommended to check remaining mintable amount before minting.
Return to Inscribe Service Guide