Create A Listing

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

Create listing order.

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

Path parameters

type*enum

brc20collectiondomain

Body

application/json

inscriptionId*string

initPrice*string

Set the initial total price

unitPrice*string

Unit Price (for tick)

pubkey*string

User public key

marketType*enum

auctionfixedPrice

auctionTimenumber

Auction mode optional, setting time of the order

maxPricestring

Auction mode optional, setting max price of the order

btcAddressstring

(Optional) Only for multi-address wallet, such as Xverse, hiro. Specifies the BTC receive 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_put_on', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "inscriptionId": "text",
      "initPrice": "text",
      "unitPrice": "text",
      "pubkey": "text",
      "marketType": "fixedPrice"
    }),
});
const data = await response.json();

Response

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

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

Confirm listing order.

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

Path parameters

type*enum

brc20collectiondomain

Body

application/json

auctionId*string

psbt*string

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_put_on', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "auctionId": "text",
      "psbt": "text"
    }),
});
const data = await response.json();

Response

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