Runes Marketplace

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

post
/v3/market/runes/auction/runes_types
Authorizations
Body
timeTypeundefined · enumOptional

Optional: day1, day7, day30

Possible values:
startnumberOptional
limitnumberOptional
Responses
200

Default Response

application/json
post
/v3/market/runes/auction/runes_types
POST /v3/market/runes/auction/runes_types HTTP/1.1
Host: open-api.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "timeType": "day1",
  "start": 1,
  "limit": 1
}
200

Default Response

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

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

post
/v3/market/runes/auction/runes_types_specified
Authorizations
Body
timeTypestring · enumOptionalPossible values:
tickstringOptional
Responses
200

Default Response

application/json
post
/v3/market/runes/auction/runes_types_specified
POST /v3/market/runes/auction/runes_types_specified HTTP/1.1
Host: open-api.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "timeType": "day1",
  "tick": "text"
}
200

Default Response

{
  "code": 1,
  "msg": "text",
  "data": {
    "tick": "text",
    "symbol": "text",
    "curPrice": 1,
    "changePrice": 1,
    "btcVolume": 1,
    "amountVolume": 1,
    "cap": "text",
    "capUSD": "text",
    "deployTime": 1,
    "holders": 1,
    "number": 1,
    "transactions": 1,
    "warning": true
  }
}

Retrieve the list information of the market.

post
/v3/market/runes/auction/list
Authorizations
Body
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/runes/auction/list
POST /v3/market/runes/auction/list HTTP/1.1
Host: open-api.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 223

{
  "filter": {
    "nftType": "brc20",
    "address": "text",
    "tick": "text",
    "minPrice": 1,
    "maxPrice": 1,
    "nftConfirm": true,
    "isEnd": true,
    "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,
        "nftType": "text",
        "tick": "text",
        "limit": 1,
        "amount": 1,
        "unitPrice": 1
      }
    ],
    "total": 1,
    "timestamp": 1
  }
}

Get information on listings, delistings, and sales.

post
/v3/market/runes/auction/actions
Authorizations
Body
startnumberRequired
limitnumber · max: 100Required
Responses
200

Default Response

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

{
  "filter": {
    "nftType": "brc20",
    "address": "text",
    "inscriptionId": "text",
    "event": "Cancel",
    "tick": "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
/v3/market/runes/auction/create_put_on
Authorizations
Body
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/runes/auction/create_put_on
POST /v3/market/runes/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
/v3/market/runes/auction/confirm_put_on
Authorizations
Body
auctionIdstringRequired
psbtstringRequired
fromBase64booleanOptional

Is Base64 format, the default is hex format

Responses
200

Default Response

application/json
post
/v3/market/runes/auction/confirm_put_on
POST /v3/market/runes/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
/v3/market/runes/auction/create_bid_prepare
Authorizations
Body
auctionIdstringRequired
bidPricenumberRequired
addressstringRequired

Bidder address

pubkeystringRequired

Bidder pubkey

Responses
200

Default Response

application/json
post
/v3/market/runes/auction/create_bid_prepare
POST /v3/market/runes/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
/v3/market/runes/auction/create_bid
Authorizations
Body
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/runes/auction/create_bid
POST /v3/market/runes/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
/v3/market/runes/auction/confirm_bid
Authorizations
Body
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/runes/auction/confirm_bid
POST /v3/market/runes/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
/v3/market/runes/auction/create_put_off
Authorizations
Body
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/runes/auction/create_put_off
POST /v3/market/runes/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
/v3/market/runes/auction/confirm_put_off
Authorizations
Body
auctionIdstringRequired
psbtstringRequired
fromBase64booleanOptional

Is Base64 format, the default is hex format

offChainbooleanOptional
Responses
200

Default Response

application/json
post
/v3/market/runes/auction/confirm_put_off
POST /v3/market/runes/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
/v3/market/runes/auction/create_modify_price
Authorizations
Body
auctionIdstringRequired
initPricestringRequired
unitPricestringRequired
Responses
200

Default Response

application/json
post
/v3/market/runes/auction/create_modify_price
POST /v3/market/runes/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
/v3/market/runes/auction/confirm_modify_price
Authorizations
Body
auctionIdstringRequired
psbtstringRequired
fromBase64booleanRequired
Responses
200

Default Response

application/json
post
/v3/market/runes/auction/confirm_modify_price
POST /v3/market/runes/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": {}
}

Create batch listing order.

post
/v3/market/runes/auction/create_batch_put_on
Authorizations
Body
unitPricestringRequired

Unit Price (for tick)

pubkeystringRequired

User public key

nftTypestringOptional
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/runes/auction/create_batch_put_on
POST /v3/market/runes/auction/create_batch_put_on HTTP/1.1
Host: open-api.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 109

{
  "unitPrice": "text",
  "pubkey": "text",
  "nftType": "text",
  "btcAddress": "text",
  "utxos": [
    {
      "txid": "text",
      "index": 1
    }
  ]
}
200

Default Response

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

Confirm batch listing order.

post
/v3/market/runes/auction/confirm_batch_put_on
Authorizations
Body
batchAuctionIdstringRequired
psbtstringRequired
fromBase64booleanOptional

Is Base64 format, the default is hex format

Responses
200

Default Response

application/json
post
/v3/market/runes/auction/confirm_batch_put_on
POST /v3/market/runes/auction/confirm_batch_put_on HTTP/1.1
Host: open-api.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "batchAuctionId": "text",
  "psbt": "text",
  "fromBase64": true
}
200

Default Response

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

Return params before creating purchase order.

post
/v3/market/runes/auction/create_batch_bid_prepare
Authorizations
Body
auctionIdsstring[]Required
addressstringRequired

Bidder address

pubkeystringRequired

Bidder pubkey

Responses
200

Default Response

application/json
post
/v3/market/runes/auction/create_batch_bid_prepare
POST /v3/market/runes/auction/create_batch_bid_prepare HTTP/1.1
Host: open-api.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "auctionIds": [
    "text"
  ],
  "address": "text",
  "pubkey": "text"
}
200

Default Response

{
  "code": 1,
  "msg": "text",
  "data": {
    "serverFee": 1,
    "serverReal": 1,
    "serverFeeRate": 1,
    "txSize": 1,
    "feeRate": 1,
    "availableBalance": 1,
    "validAuctionIds": [
      "text"
    ],
    "invalidAuctionIds": [
      "text"
    ]
  }
}

Create purchase order.

post
/v3/market/runes/auction/create_batch_bid
Authorizations
Body
auctionIdsstring[]Required
bidPricesnumber[]Required
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/runes/auction/create_batch_bid
POST /v3/market/runes/auction/create_batch_bid HTTP/1.1
Host: open-api.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 104

{
  "auctionIds": [
    "text"
  ],
  "bidPrices": [
    1
  ],
  "address": "text",
  "pubkey": "text",
  "feeRate": 1,
  "nftAddress": "text"
}
200

Default Response

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

Confirm purchase order.

post
/v3/market/runes/auction/confirm_batch_bid
Authorizations
Body
bidIdstringRequired
psbtBidstringRequired
fromBase64booleanOptional

Is Base64 format, the default is hex format

Responses
200

Default Response

application/json
post
/v3/market/runes/auction/confirm_batch_bid
POST /v3/market/runes/auction/confirm_batch_bid HTTP/1.1
Host: open-api.unisat.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "bidId": "text",
  "psbtBid": "text",
  "fromBase64": true
}
200

Default Response

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

Last updated