Domain Marketplace

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

post

https://open-api.unisat.iohttps://open-api-s1.unisat.iohttps://open-api-testnet.unisat.io

/v3/market/domain/auction/domain_types

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Default Response

application/json

post

/v3/market/domain/auction/domain_types

HTTPcURLJavaScriptPython

POST /v3/market/domain/auction/domain_types HTTP/1.1
Host: open-api.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Default Response

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

Return a summary of domain.

post

https://open-api.unisat.iohttps://open-api-s1.unisat.iohttps://open-api-testnet.unisat.io

/v3/market/domain/auction/domain_statistic

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

domainTypestringRequired

Responses

200

Default Response

application/json

post

/v3/market/domain/auction/domain_statistic

HTTPcURLJavaScriptPython

POST /v3/market/domain/auction/domain_statistic HTTP/1.1
Host: open-api.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "domainType": "text"
}

200

Default Response

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

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

post

https://open-api.unisat.iohttps://open-api-s1.unisat.iohttps://open-api-testnet.unisat.io

/v3/market/domain/auction/inscription_info

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

inscriptionIdstringRequired

Responses

200

Default Response

application/json

post

/v3/market/domain/auction/inscription_info

HTTPcURLJavaScriptPython

POST /v3/market/domain/auction/inscription_info HTTP/1.1
Host: open-api.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 24

{
  "inscriptionId": "text"
}

200

Default Response

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

Get the basic listing information of the specified inscription list

post

https://open-api.unisat.iohttps://open-api-s1.unisat.iohttps://open-api-testnet.unisat.io

/v3/market/domain/auction/inscription_info_list

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

addressstringOptional

inscriptionIdsstring[]Optional

Responses

200

Default Response

application/json

post

/v3/market/domain/auction/inscription_info_list

HTTPcURLJavaScriptPython

POST /v3/market/domain/auction/inscription_info_list HTTP/1.1
Host: open-api.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "address": "text",
  "inscriptionIds": [
    "text"
  ]
}

200

Default Response

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

Retrieve the list information of the market.

post

https://open-api.unisat.iohttps://open-api-s1.unisat.iohttps://open-api-testnet.unisat.io

/v3/market/domain/auction/list

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

startnumberRequired

The data is looked up from start

limitnumber · max: 100Required

Limit the amount of data

Responses

200

Default Response

application/json

post

/v3/market/domain/auction/list

HTTPcURLJavaScriptPython

POST /v3/market/domain/auction/list HTTP/1.1
Host: open-api.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 375

{
  "filter": {
    "nftType": "brc20",
    "address": "text",
    "tick": "text",
    "minPrice": 1,
    "maxPrice": 1,
    "nftConfirm": true,
    "isEnd": true,
    "domainType": "sats",
    "domainMinLength": 1,
    "domainMaxLength": 1,
    "domainCategory": "text",
    "domainFuzzy": "text",
    "collectionId": "text",
    "collectionFuzzy": "text",
    "all": true
  },
  "sort": {
    "unitPrice": 1,
    "onSaleTime": 1,
    "initPrice": 1,
    "inscriptionNumber": 1
  },
  "start": 1,
  "limit": 1
}

200

Default Response

{
  "code": 1,
  "msg": "text",
  "data": {
    "list": [
      {
        "auctionId": "text",
        "inscriptionId": "text",
        "inscriptionNumber": 1,
        "marketType": "text",
        "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"
      }
    ],
    "total": 1,
    "timestamp": 1
  }
}

Get information on listings, delistings, and sales.

post

https://open-api.unisat.iohttps://open-api-s1.unisat.iohttps://open-api-testnet.unisat.io

/v3/market/domain/auction/actions

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

startnumberRequired

limitnumber · max: 100Required

Responses

200

Default Response

application/json

post

/v3/market/domain/auction/actions

HTTPcURLJavaScriptPython

POST /v3/market/domain/auction/actions HTTP/1.1
Host: open-api.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 163

{
  "filter": {
    "nftType": "brc20",
    "address": "text",
    "inscriptionId": "text",
    "event": "Cancel",
    "tick": "text",
    "domainType": "text",
    "collectionId": "text"
  },
  "start": 1,
  "limit": 1
}

200

Default Response

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

Create listing order.

post

https://open-api.unisat.iohttps://open-api-s1.unisat.iohttps://open-api-testnet.unisat.io

/v3/market/domain/auction/create_put_on

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

nftTypestringOptional

inscriptionIdstringRequired

initPricestringRequired

Set the initial total price

unitPricestringRequired

Unit Price (for tick)

pubkeystringRequired

User public key

marketTypestring · enumRequiredExample: fixedPricePossible values:

btcAddressstringOptional

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

Responses

200

Default Response

application/json

post

/v3/market/domain/auction/create_put_on

HTTPcURLJavaScriptPython

POST /v3/market/domain/auction/create_put_on HTTP/1.1
Host: open-api.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 141

{
  "nftType": "text",
  "inscriptionId": "text",
  "initPrice": "text",
  "unitPrice": "text",
  "pubkey": "text",
  "marketType": "fixedPrice",
  "btcAddress": "text"
}

200

Default Response

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

Confirm listing order.

post

https://open-api.unisat.iohttps://open-api-s1.unisat.iohttps://open-api-testnet.unisat.io

/v3/market/domain/auction/confirm_put_on

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

auctionIdstringRequired

psbtstringRequired

fromBase64booleanOptional

Is Base64 format, the default is hex format

Responses

200

Default Response

application/json

post

/v3/market/domain/auction/confirm_put_on

HTTPcURLJavaScriptPython

POST /v3/market/domain/auction/confirm_put_on HTTP/1.1
Host: open-api.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "auctionId": "text",
  "psbt": "text",
  "fromBase64": true
}

200

Default Response

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

Return params before creating purchase order.

post

https://open-api.unisat.iohttps://open-api-s1.unisat.iohttps://open-api-testnet.unisat.io

/v3/market/domain/auction/create_bid_prepare

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

auctionIdstringRequired

bidPricenumberRequired

addressstringRequired

Bidder address

pubkeystringRequired

Bidder pubkey

Responses

200

Default Response

application/json

post

/v3/market/domain/auction/create_bid_prepare

HTTPcURLJavaScriptPython

POST /v3/market/domain/auction/create_bid_prepare HTTP/1.1
Host: open-api.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "auctionId": "text",
  "bidPrice": 1,
  "address": "text",
  "pubkey": "text"
}

200

Default Response

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

Create purchase order.

post

https://open-api.unisat.iohttps://open-api-s1.unisat.iohttps://open-api-testnet.unisat.io

/v3/market/domain/auction/create_bid

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

auctionIdstringRequired

bidPricenumberRequired

addressstringRequired

Bidder address

pubkeystringRequired

Bidder pubkey

feeRatenumberOptional

The user sets the rate

nftAddressstringOptional

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

Responses

200

Default Response

application/json

post

/v3/market/domain/auction/create_bid

HTTPcURLJavaScriptPython

POST /v3/market/domain/auction/create_bid HTTP/1.1
Host: open-api.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 134

{
  "auctionId": "text",
  "bidPrice": 1,
  "address": "text",
  "pubkey": "text",
  "feeRate": 1,
  "nftAddress": "text",
  "utxos": [
    {
      "txid": "text",
      "index": 1
    }
  ]
}

200

Default Response

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

Confirm purchase order.

post

https://open-api.unisat.iohttps://open-api-s1.unisat.iohttps://open-api-testnet.unisat.io

/v3/market/domain/auction/confirm_bid

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

auctionIdstringRequired

bidIdstringRequired

psbtBidstringRequired

psbtBid2stringOptional

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

psbtSettlestringOptional

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

fromBase64booleanOptional

Is Base64 format, the default is hex format

Responses

200

Default Response

application/json

post

/v3/market/domain/auction/confirm_bid

HTTPcURLJavaScriptPython

POST /v3/market/domain/auction/confirm_bid HTTP/1.1
Host: open-api.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 108

{
  "auctionId": "text",
  "bidId": "text",
  "psbtBid": "text",
  "psbtBid2": "text",
  "psbtSettle": "text",
  "fromBase64": true
}

200

Default Response

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

Create delisting order.

post

https://open-api.unisat.iohttps://open-api-s1.unisat.iohttps://open-api-testnet.unisat.io

/v3/market/domain/auction/create_put_off

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

auctionIdstringRequired

nftAddressstringOptional

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

btcPubkeystringOptional

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

rbfbooleanOptional

offChainbooleanOptional

Responses

200

Default Response

application/json

post

/v3/market/domain/auction/create_put_off

HTTPcURLJavaScriptPython

POST /v3/market/domain/auction/create_put_off HTTP/1.1
Host: open-api.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 122

{
  "auctionId": "text",
  "nftAddress": "text",
  "btcPubkey": "text",
  "utxos": [
    {
      "txid": "text",
      "index": 1
    }
  ],
  "rbf": true,
  "offChain": true
}

200

Default Response

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

Confirm delisting order.

post

https://open-api.unisat.iohttps://open-api-s1.unisat.iohttps://open-api-testnet.unisat.io

/v3/market/domain/auction/confirm_put_off

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

auctionIdstringRequired

psbtstringRequired

fromBase64booleanOptional

Is Base64 format, the default is hex format

offChainbooleanOptional

Responses

200

Default Response

application/json

post

/v3/market/domain/auction/confirm_put_off

HTTPcURLJavaScriptPython

POST /v3/market/domain/auction/confirm_put_off HTTP/1.1
Host: open-api.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "auctionId": "text",
  "psbt": "text",
  "fromBase64": true,
  "offChain": true
}

200

Default Response

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

Create the order for price adjustment.

post

https://open-api.unisat.iohttps://open-api-s1.unisat.iohttps://open-api-testnet.unisat.io

/v3/market/domain/auction/create_modify_price

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

auctionIdstringRequired

initPricestringRequired

unitPricestringRequired

Responses

200

Default Response

application/json

post

/v3/market/domain/auction/create_modify_price

HTTPcURLJavaScriptPython

POST /v3/market/domain/auction/create_modify_price HTTP/1.1
Host: open-api.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "auctionId": "text",
  "initPrice": "text",
  "unitPrice": "text"
}

200

Default Response

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

Confirm the order for price adjustment.

post

https://open-api.unisat.iohttps://open-api-s1.unisat.iohttps://open-api-testnet.unisat.io

/v3/market/domain/auction/confirm_modify_price

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

auctionIdstringRequired

psbtstringRequired

fromBase64booleanRequired

Responses

200

Default Response

application/json

post

/v3/market/domain/auction/confirm_modify_price

HTTPcURLJavaScriptPython

POST /v3/market/domain/auction/confirm_modify_price HTTP/1.1
Host: open-api.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "auctionId": "text",
  "psbt": "text",
  "fromBase64": true
}

200

Default Response

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