Buy

Please note that access to this API requires the API key to have market permissions enabled.

Return params before creating purchase order.

POSThttps://open-api.unisat.io/v3/market/{type}/auction/create_bid_prepare

Body

application/json

auctionId*string

bidPrice*number

address*string

Bidder address

pubkey*string

Bidder pubkey

Response

200

Default Response

Body

application/json

code*number

msg*string

data*object

Request

JavaScriptCurl

const response = await fetch('https://open-api.unisat.io/v3/market/{type}/auction/create_bid_prepare', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "auctionId": "text",
      "bidPrice": 0,
      "address": "text",
      "pubkey": "text"
    }),
});
const data = await response.json();

Response

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

• 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."

• allBalance: Total BTC balance

Create purchase order.

POSThttps://open-api.unisat.io/v3/market/{type}/auction/create_bid

Path parameters

type*enum

brc20collectiondomain

Body

application/json

auctionId*string

bidPrice*number

address*string

Bidder address

pubkey*string

Bidder pubkey

feeRatenumber

The user sets the rate

nftAddressstring

Inscription receiving address

Response

200

Default Response

Body

application/json

code*number

msg*string

data*object

Request

JavaScriptCurl

const response = await fetch('https://open-api.unisat.io/v3/market/{type}/auction/create_bid', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "auctionId": "text",
      "bidPrice": 0,
      "address": "text",
      "pubkey": "text"
    }),
});
const data = await response.json();

Response

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

• nftAddress: (Optional) Only for multi-address wallet, such as Xverse, hiro. To specify inscription receiving address

Confirm purchase order.

POSThttps://open-api.unisat.io/v3/market/{type}/auction/confirm_bid

Path parameters

type*enum

brc20collectiondomain

Body

application/json

auctionId*string

bidId*string

psbtBid*string

psbtBid2*string

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

psbtSettle*string

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

fromBase64boolean

Is Base64 format, the default is hex format

Response

200

Default Response

Body

application/json

code*number

msg*string

data*object

Request

JavaScriptCurl

const response = await fetch('https://open-api.unisat.io/v3/market/{type}/auction/confirm_bid', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "auctionId": "text",
      "bidId": "text",
      "psbtBid": "text",
      "psbtBid2": "text",
      "psbtSettle": "text"
    }),
});
const data = await response.json();

Response

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