Domain Marketplace

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

POSThttps://open-api.unisat.io/v3/market/domain/auction/domain_types

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/domain/auction/domain_types', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "code": 0,
  "msg": "text",
  "data": {
    "list": [
      {
        "btcVolume": 0,
        "btcVolumePercent": 0,
        "amountVolume": 0,
        "domainType": "text"
      }
    ]
  }
}

Return a summary of domain.

POSThttps://open-api.unisat.io/v3/market/domain/auction/domain_statistic

Body

application/json

domainType*string

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

Response

{
  "code": 0,
  "msg": "text",
  "data": {
    "list": [
      {
        "demo": "text",
        "domainCategory": "text"
      }
    ]
  }
}

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

POSThttps://open-api.unisat.io/v3/market/domain/auction/inscription_info

Body

application/json

inscriptionId*string

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

Response

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

Get the basic listing information of the specified inscription list

POSThttps://open-api.unisat.io/v3/market/domain/auction/inscription_info_list

Body

application/json

addressstring

inscriptionIdsarray of string

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

Response

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

Retrieve the list information of the market.

POSThttps://open-api.unisat.io/v3/market/domain/auction/list

Body

application/json

filter*object

sort*object

start*number

The data is looked up from start

limit*number

Limit the amount of data

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/domain/auction/list', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "filter": {
        "nftType": "brc20"
      },
      "sort": {},
      "start": 0,
      "limit": 0
    }),
});
const data = await response.json();

Response

{
  "code": 0,
  "msg": "text",
  "data": {
    "list": [
      {
        "auctionId": "text",
        "inscriptionId": "text",
        "inscriptionNumber": 0,
        "marketType": "text",
        "address": "text",
        "price": 0,
        "notSupport": false,
        "verification": false,
        "nftType": "text",
        "tick": "text",
        "limit": 0,
        "amount": 0,
        "unitPrice": 0,
        "collectionId": "text",
        "contentType": "text",
        "contentBody": "text",
        "collectionItemName": "text",
        "collectionHighResImgUrl": "text",
        "collectionName": "text",
        "notOnSale": false,
        "domain": "text",
        "domainHex": "text",
        "domainType": "sats"
      }
    ],
    "total": 0,
    "timestamp": 0
  }
}

Get information on listings, delistings, and sales.

POSThttps://open-api.unisat.io/v3/market/domain/auction/actions

Body

application/json

filter*object

start*number

limit*number

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/domain/auction/actions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "filter": {},
      "start": 0,
      "limit": 0
    }),
});
const data = await response.json();

Response

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

Create listing order.

POSThttps://open-api.unisat.io/v3/market/domain/auction/create_put_on

Body

application/json

nftTypestring

inscriptionId*string

initPrice*string

Set the initial total price

unitPrice*string

Unit Price (for tick)

pubkey*string

User public key

marketType*enum

Example: "fixedPrice"

auctionfixedPrice

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/domain/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
    ]
  }
}

Confirm listing order.

POSThttps://open-api.unisat.io/v3/market/domain/auction/confirm_put_on

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/domain/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": {}
}

Return params before creating purchase order.

POSThttps://open-api.unisat.io/v3/market/domain/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/domain/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
  }
}

Create purchase order.

POSThttps://open-api.unisat.io/v3/market/domain/auction/create_bid

Body

application/json

auctionId*string

bidPrice*number

address*string

Bidder address

pubkey*string

Bidder pubkey

feeRatenumber

The user sets the rate

nftAddressstring

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

utxosarray of object

Custom utxo

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/domain/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
    ]
  }
}

Confirm purchase order.

POSThttps://open-api.unisat.io/v3/market/domain/auction/confirm_bid

Body

application/json

auctionId*string

bidId*string

psbtBid*string

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

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

Response

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

Create delisting order.

POSThttps://open-api.unisat.io/v3/market/domain/auction/create_put_off

Body

application/json

auctionId*string

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.

utxosarray of object

Custom utxo

rbfboolean

offChainboolean

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

Response

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

Confirm delisting order.

POSThttps://open-api.unisat.io/v3/market/domain/auction/confirm_put_off

Body

application/json

auctionId*string

psbt*string

fromBase64boolean

Is Base64 format, the default is hex format

offChainboolean

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/domain/auction/confirm_put_off', {
    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": {
    "txid": "text"
  }
}

Create the order for price adjustment.

POSThttps://open-api.unisat.io/v3/market/domain/auction/create_modify_price

Body

application/json

auctionId*string

initPrice*string

unitPrice*string

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

Response

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

Confirm the order for price adjustment.

POSThttps://open-api.unisat.io/v3/market/domain/auction/confirm_modify_price

Body

application/json

auctionId*string

psbt*string

fromBase64*boolean

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

Response

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