BRC20 Marketplace

Get tick k line.

post

/v3/market/brc20/auction/brc20_kline

Authorizations

Body

tickstringrequired

timeStartnumberrequired

Start time range

timeEndnumberrequired

End time range

timeStepnumberrequired

Time granularity, such as milliseconds for a 5-minute interval

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/brc20/auction/brc20_kline' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"tick":"text","timeStart":1,"timeEnd":1,"timeStep":1}'

200

200

{
  "code": 1,
  "msg": "text",
  "data": [
    {
      "price": 1,
      "timestamp": 1
    }
  ]
}

Default Response

Parameter Description

• tick: BRC-20 tick

• timeStart: The starting timestamp, measured in milliseconds.

• timeEnd: The ending timestamp, measured in milliseconds.

• timeStep: Represents the interval between each data point, measured in milliseconds.

Additionally, there are the following limitations on the requested parameters.

(timeEnd-timeStart)/timeStep <= 2016

Get statistical data, price, market capitalization, etc. for BRC20.

post

/v3/market/brc20/auction/brc20_types

Authorizations

Body

startnumber

limitnumber

timeTypestring · enum

Optional: day1, day7, day30

Options: day1, day7, day30

ticksstring[]

Specify a list of ticks

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/brc20/auction/brc20_types' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"timeType":"day1","ticks":[null]}'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "BTCPrice": 1,
    "list": [
      {
        "tick": "text",
        "curPrice": 1,
        "changePrice": 1,
        "btcVolume": 1,
        "amountVolume": 1,
        "cap": "text"
      }
    ],
    "deploy": [
      {
        "tick": "text",
        "curPrice": 1,
        "changePrice": 1,
        "btcVolume": 1,
        "amountVolume": 1,
        "cap": "text"
      }
    ],
    "cap": [
      {
        "tick": "text",
        "curPrice": 1,
        "changePrice": 1,
        "btcVolume": 1,
        "amountVolume": 1,
        "cap": "text"
      }
    ]
  }
}

Default Response

The optional values for timeType are day1, day7, day30.

ticks can be used to filter the "list," allowing it to return only the ticks that are needed.If the ticks field is not provided, all BRC20 data will be returned.

In the returned fields of this interface, only the "list" field needs attention. The "deploy" and "cap" fields are included solely for display purposes on certain pages of UniSat Marketplace. Filtering the fields will not affect "deploy" and "cap"; they will always be returned.

Use start and limit

Use ticks

Get statistical data, price, market capitalization, etc. for BRC20.

post

/v3/market/brc20/auction/brc20_types_specified

Authorizations

Body

tickstring

timeTypestring · enum

Options: day1, day7, day30

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/brc20/auction/brc20_types_specified' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"timeType":"day1"}'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "tick": "text",
    "curPrice": 1,
    "changePrice": 1,
    "btcVolume": 1,
    "amountVolume": 1
  }
}

Default Response

The optional values for timeType are day1, day7, day30

Bind btcAddress and nftAddress.

post

/v3/market/brc20/auction/bind

Authorizations

Body

btcAddressstringrequired

nftAddressstringrequired

signstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/brc20/auction/bind' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"btcAddress":"text","nftAddress":"text","sign":"text"}'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {}
}

Default Response

By default, a user's address A is used for both payment and receiving inscriptions. However, for some wallets, such as the xverse and hiro wallets, different addresses are used to store BTC and inscriptions. This method allows the wallet to use address A for payments and address B for receiving inscriptions.

import {signMessage} from "sats-connect"

const paymentAddress = "";
const ordinalsAddress = "";

const toSignStr = `Please confirm that\nPayment Address: ${paymentAddress}\nOrdinals Address: ${ordinalsAddress}`

// for xverse
signMessage({
    payload:{
        address: ordinalsAddress,
        message: toSignStr,
        network:{
            type: "Mainnet"
        }
    },
    onFinish:(signature)=>{
        axios.post('/v3/market/brc20/auction/bind', {
            btcAddress: paymentAddress,
            nftAddress: ordinalsAddress,
            sign:signature
        })

    }
}

Retrieve the list information of the market.

post

/v3/market/brc20/auction/list

Authorizations

Body

startnumberrequired

The data is looked up from start

limitnumber · max: 100required

Limit the amount of data

filterobjectrequired

sortobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/brc20/auction/list' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"start":1,"limit":1,"filter":{"nftType":"brc20"},"sort":{"unitPrice":1,"onSaleTime":1,"initPrice":1,"inscriptionNumber":1}}'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "total": 1,
    "timestamp": 1,
    "list": [
      {
        "auctionId": "text",
        "inscriptionId": "text",
        "inscriptionNumber": 1,
        "marketType": "text",
        "address": "text",
        "price": 1,
        "nftType": "text",
        "tick": "text",
        "limit": 1,
        "amount": 1,
        "unitPrice": 1
      }
    ]
  }
}

Default Response

Retrieve inscription information, including brc20, names, collection. It is necessary to first determine the inscription type before calling the relevant services.

post

/v3/market/brc20/auction/inscription_info

Authorizations

Body

inscriptionIdstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/brc20/auction/inscription_info' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"inscriptionId":"text"}'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "auctionId": "text",
    "inscriptionId": "text",
    "inscriptionNumber": 1,
    "marketType": "fixedPrice",
    "address": "text",
    "price": 1,
    "notSupport": true,
    "verification": true,
    "nftType": "text",
    "tick": "text",
    "limit": 1,
    "amount": 1,
    "unitPrice": 1,
    "collectionId": "text",
    "contentType": "text",
    "contentBody": "text",
    "collectionItemName": "text",
    "collectionHighResImgUrl": "text",
    "collectionName": "text",
    "notOnSale": true,
    "domain": "text",
    "domainHex": "text",
    "domainType": "sats",
    "utxo": {}
  }
}

Default Response

Get the basic listing information of the specified inscription list

post

/v3/market/brc20/auction/inscription_info_list

Authorizations

Body

addressstring

inscriptionIdsstring[]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/brc20/auction/inscription_info_list' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"inscriptionIds":[null]}'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "list": [
      {
        "auctionId": "text",
        "inscriptionId": "text",
        "inscriptionNumber": 1,
        "marketType": "text",
        "address": "text",
        "price": 1,
        "nftType": "text",
        "status": "text"
      }
    ]
  }
}

Default Response

Get information on listings, delistings, and sales.

post

/v3/market/brc20/auction/actions

Authorizations

Body

startnumberrequired

limitnumber · max: 100required

filterobjectrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/brc20/auction/actions' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"start":1,"limit":1,"filter":{"nftType":"brc20","event":"Cancel"}}'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "total": 1,
    "list": [
      {
        "auctionId": "text",
        "inscriptionId": "text",
        "inscriptionNumber": 1,
        "price": 1,
        "from": "text",
        "to": "text",
        "timestamp": 1,
        "nftConfirmNum": 1,
        "endMsg": "text",
        "newest": true,
        "name": "text",
        "unitPrice": 1,
        "amount": 1,
        "domain": "text",
        "collectionId": "text",
        "collectionItemName": "text",
        "contentType": "text",
        "contentBody": "text",
        "event": "Listed",
        "nftType": "brc20",
        "domainType": "sats",
        "domainCategorys": [
          "Keyboard"
        ],
        "attributes": [
          {
            "trait_type": "text",
            "value": "text"
          }
        ]
      }
    ]
  }
}

Default Response

Create listing order.

post

/v3/market/brc20/auction/create_put_on

Authorizations

Body

nftTypestring

inscriptionIdstringrequired

initPricestringrequired

Set the initial total price

unitPricestringrequired

Unit Price (for tick)

pubkeystringrequired

User public key

btcAddressstring

(Optional) Only for multi-address wallet, such as Xverse, hiro. Specifies the BTC receive address

marketTypestring · enumrequired

Example: fixedPrice

Options: auction, fixedPrice

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/brc20/auction/create_put_on' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"inscriptionId":"text","initPrice":"text","unitPrice":"text","pubkey":"text","marketType":"fixedPrice"}'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "auctionId": "text",
    "psbt": "text",
    "signIndexes": [
      1
    ]
  }
}

Default Response

• btcAddress: (Optional) Only for multi-address wallet, such as Xverse, hiro. To specifies the BTC receive address

Confirm listing order.

post

/v3/market/brc20/auction/confirm_put_on

Authorizations

Body

auctionIdstringrequired

psbtstringrequired

fromBase64boolean

Is Base64 format, the default is hex format

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/brc20/auction/confirm_put_on' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"auctionId":"text","psbt":"text"}'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {}
}

Default Response

Return params before creating purchase order.

post

/v3/market/brc20/auction/create_bid_prepare

Authorizations

Body

auctionIdstringrequired

bidPricenumberrequired

addressstringrequired

Bidder address

pubkeystringrequired

Bidder pubkey

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/brc20/auction/create_bid_prepare' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"auctionId":"text","bidPrice":1,"address":"text","pubkey":"text"}'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "serverFee": 1,
    "serverReal": 1,
    "serverFeeRate": 1,
    "txSize": 1,
    "nftValue": 1,
    "feeRate": 1,
    "availableBalance": 1,
    "allBalance": 1
  }
}

Default Response

• serverFee: Service Fee

• serverReal: The service fee after deducting various discounts.

• serverFeeRate: Service fee rate

• txSzie: The virtual size of this transaction.

• nftValue: Satoshis in the inscription

• feeRate: The current accepted minimum network fee rate.

• availableBalance：BTC balance available for constructing transactions."

Create purchase order.

post

/v3/market/brc20/auction/create_bid

Authorizations

Body

auctionIdstringrequired

bidPricenumberrequired

addressstringrequired

Bidder address

pubkeystringrequired

Bidder pubkey

feeRatenumber

The user sets the rate

nftAddressstring

(Optional) Only for multi-address wallet, such as Xverse, hiro. Inscription receiving address

utxosobject[]

Custom utxo

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/brc20/auction/create_bid' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"auctionId":"text","bidPrice":1,"address":"text","pubkey":"text","utxos":[{}]}'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "bidId": "text",
    "psbtBid": "text",
    "psbtBid2": "text",
    "psbtSettle": "text",
    "serverFee": 1,
    "networkFee": 1,
    "feeRate": 1,
    "nftValue": 1,
    "bidSignIndexes": [
      1
    ]
  }
}

Default Response

Confirm purchase order.

post

/v3/market/brc20/auction/confirm_bid

Authorizations

Body

auctionIdstringrequired

bidIdstringrequired

psbtBidstringrequired

psbtBid2string

Auction mode is used, and the current empty string can be passed

psbtSettlestring

Auction mode is used, and the current empty string can be passed

fromBase64boolean

Is Base64 format, the default is hex format

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/brc20/auction/confirm_bid' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"auctionId":"text","bidId":"text","psbtBid":"text"}'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "txid": "text"
  }
}

Default Response

Create delisting order.

post

/v3/market/brc20/auction/create_put_off

Authorizations

Body

auctionIdstringrequired

nftAddressstring

(Optional) Only for multi-address wallet, such as Xverse, hiro. Inscription receiving address.

btcPubkeystring

(Optional) Only for multi-address wallet, such as Xverse, hiro. The public key used in the inscription of the order.

rbfboolean

offChainboolean

utxosobject[]

Custom utxo

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/brc20/auction/create_put_off' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"auctionId":"text","utxos":[{}]}'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "psbt": "text",
    "txSize": 1,
    "btcSignIndexes": [
      1
    ],
    "nftSignIndexes": [
      1
    ]
  }
}

Default Response

Confirm delisting order.

post

/v3/market/brc20/auction/confirm_put_off

Authorizations

Body

auctionIdstringrequired

psbtstringrequired

fromBase64boolean

Is Base64 format, the default is hex format

offChainboolean

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/brc20/auction/confirm_put_off' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"auctionId":"text","psbt":"text"}'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "txid": "text"
  }
}

Default Response

Create the order for price adjustment.

post

/v3/market/brc20/auction/create_modify_price

Authorizations

Body

auctionIdstringrequired

initPricestringrequired

unitPricestringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/brc20/auction/create_modify_price' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"auctionId":"text","initPrice":"text","unitPrice":"text"}'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {
    "psbt": "text",
    "signIndexes": [
      1
    ]
  }
}

Default Response

Confirm the order for price adjustment.

post

/v3/market/brc20/auction/confirm_modify_price

Authorizations

Body

auctionIdstringrequired

psbtstringrequired

fromBase64booleanrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://open-api.unisat.io/v3/market/brc20/auction/confirm_modify_price' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{"auctionId":"text","psbt":"text","fromBase64":true}'

200

200

{
  "code": 1,
  "msg": "text",
  "data": {}
}

Default Response